/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/plymouth.xml

• browse files at revision 513
• compare with another revision
• download diff
• download tarball
• view history from revision 513

• reverse the comparison (513 to 1249)
• stop comparing with revision 1249

Show diffs side-by-side

added

removed

plugins.d/plymouth.xml

2

2

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

3

3

        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

4

4

<!ENTITY COMMANDNAME "plymouth">

5

 

<!ENTITY TIMESTAMP "2019-07-27">

 

5

<!ENTITY TIMESTAMP "2011-10-03">

6

6

<!ENTITY % common SYSTEM "../common.ent">

7

7

%common;

8

8

]>

33

33

    <copyright>

34

34

      <year>2010</year>

35

35

      <year>2011</year>

36

 

      <year>2012</year>

37

 

      <year>2013</year>

38

 

      <year>2014</year>

39

 

      <year>2015</year>

40

 

      <year>2016</year>

41

 

      <year>2017</year>

42

 

      <year>2018</year>

43

 

      <year>2019</year>

44

36

      <holder>Teddy Hogeborn</holder>

45

37

      <holder>Björn Påhlsson</holder>

46

38

    </copyright>

61

53

  <refsynopsisdiv>

62

54

    <cmdsynopsis>

63

55

      <command>&COMMANDNAME;</command>

64

 

      <arg choice="opt">

65

 

        <option>--prompt <replaceable>PROMPT</replaceable></option>

66

 

      </arg>

67

 

      <arg><option>--debug</option></arg>

68

 

    </cmdsynopsis>

69

 

    <cmdsynopsis>

70

 

      <command>&COMMANDNAME;</command>

71

 

      <group choice="req">

72

 

        <arg choice="plain"><option>--help</option></arg>

73

 

        <arg choice="plain"><option>-?</option></arg>

74

 

      </group>

75

 

    </cmdsynopsis>

76

 

    <cmdsynopsis>

77

 

      <command>&COMMANDNAME;</command>

78

 

      <arg choice="plain"><option>--usage</option></arg>

79

 

    </cmdsynopsis>

80

 

    <cmdsynopsis>

81

 

      <command>&COMMANDNAME;</command>

82

 

      <group choice="req">

83

 

        <arg choice="plain"><option>--version</option></arg>

84

 

        <arg choice="plain"><option>-V</option></arg>

85

 

      </group>

86

56

    </cmdsynopsis>

87

57

  </refsynopsisdiv>

88

58

  

124

94

  <refsect1 id="options">

125

95

    <title>OPTIONS</title>

126

96

    <para>

127

 

      This program is commonly not invoked from the command line; it

128

 

      is normally started by the <application>Mandos</application>

129

 

      plugin runner, see <citerefentry><refentrytitle

130

 

      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>

131

 

      </citerefentry>.  Any command line options this program accepts

132

 

      are therefore normally provided by the plugin runner, and not

133

 

      directly.

 

97

      This program takes no options.

134

98

    </para>

135

 

    

136

 

    <variablelist>

137

 

      <varlistentry>

138

 

        <term><option>--prompt=<replaceable

139

 

        >PROMPT</replaceable></option></term>

140

 

        <listitem>

141

 

          <para>

142

 

            The password prompt.  Note that using this option will

143

 

            make this program ignore the <envar>cryptsource</envar>

144

 

            and <envar>crypttarget</envar> environment variables.

145

 

          </para>

146

 

        </listitem>

147

 

      </varlistentry>

148

 

      

149

 

      <varlistentry>

150

 

        <term><option>--debug</option></term>

151

 

        <listitem>

152

 

          <para>

153

 

            Enable debug mode.  This will enable a lot of output to

154

 

            standard error about what the program is doing.  The

155

 

            program will still perform all other functions normally.

156

 

          </para>

157

 

        </listitem>

158

 

      </varlistentry>

159

 

      

160

 

      <varlistentry>

161

 

        <term><option>--help</option></term>

162

 

        <term><option>-?</option></term>

163

 

        <listitem>

164

 

          <para>

165

 

            Gives a help message about options and their meanings.

166

 

          </para>

167

 

        </listitem>

168

 

      </varlistentry>

169

 

      

170

 

      <varlistentry>

171

 

        <term><option>--usage</option></term>

172

 

        <listitem>

173

 

          <para>

174

 

            Gives a short usage message.

175

 

          </para>

176

 

        </listitem>

177

 

      </varlistentry>

178

 

      

179

 

      <varlistentry>

180

 

        <term><option>--version</option></term>

181

 

        <term><option>-V</option></term>

182

 

        <listitem>

183

 

          <para>

184

 

            Prints the program version.

185

 

          </para>

186

 

        </listitem>

187

 

      </varlistentry>

188

 

    </variablelist>

189

99

  </refsect1>

190

100

  

191

101

  <refsect1 id="exit_status">

207

117

        <term><envar>crypttarget</envar></term>

208

118

        <listitem>

209

119

          <para>

210

 

            If set, and if the <option>--prompt</option> option is not

211

 

            used, these environment variables will be assumed to

 

120

            If set, these environment variables will be assumed to

212

121

            contain the source device name and the target device

213

122

            mapper name, respectively, and will be shown as part of

214

123

            the prompt.

216

125

        <para>

217

126

          These variables will normally be inherited from

218

127

          <citerefentry><refentrytitle>plugin-runner</refentrytitle>

219

 

          <manvolnum>8mandos</manvolnum></citerefentry>, which might

220

 

          have in turn inherited them from its calling process.

 

128

          <manvolnum>8mandos</manvolnum></citerefentry>, which will

 

129

          normally have inherited them from

 

130

          <filename>/scripts/local-top/cryptroot</filename> in the

 

131

          initial <acronym>RAM</acronym> disk environment, which will

 

132

          have set them from parsing kernel arguments and

 

133

          <filename>/conf/conf.d/cryptroot</filename> (also in the

 

134

          initial RAM disk environment), which in turn will have been

 

135

          created when the initial RAM disk image was created by

 

136

          <filename

 

137

          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by

 

138

          extracting the information of the root file system from

 

139

          <filename >/etc/crypttab</filename>.

221

140

        </para>

222

141

        <para>

223

142

          This behavior is meant to exactly mirror the behavior of

224

 

          <command>askpass</command>, the default password prompter

225

 

          from initramfs-tools.

 

143

          <command>askpass</command>, the default password prompter.

226

144

        </para>

227

145

        </listitem>

228

146

      </varlistentry>

243

161

        </listitem>

244

162

      </varlistentry>

245

163

      <varlistentry>

246

 

        <term><filename class="directory">/proc</filename></term>

 

164

        <term><filename>/proc</filename></term>

247

165

        <listitem>

248

166

          <para>

249

167

            To find the running <citerefentry><refentrytitle

282

200

      daemon and starting a new one is ugly, but necessary as long as

283

201

      it does not support aborting a password request.

284

202

    </para>

285

 

    <xi:include href="../bugs.xml"/>

286

203

  </refsect1>

287

204

  

288

205

  <refsect1 id="example">

295

212

    </para>

296

213

    <informalexample>

297

214

      <para>

298

 

        Normal invocation needs no options:

 

215

        This program takes no options.

299

216

      </para>

300

217

      <para>

301

218

        <userinput>&COMMANDNAME;</userinput>

302

219

      </para>

303

220

    </informalexample>

304

 

    <informalexample>

305

 

      <para>

306

 

        Show a different prompt.

307

 

      </para>

308

 

      <para>

309

 

        <userinput>&COMMANDNAME; --prompt=Password</userinput>

310

 

      </para>

311

 

    </informalexample>

312

221

  </refsect1>

313

222

  

314

223

  <refsect1 id="security">

354

263

    <para>

355

264

      <citerefentry><refentrytitle>intro</refentrytitle>

356

265

      <manvolnum>8mandos</manvolnum></citerefentry>,

 

266

      <citerefentry><refentrytitle>crypttab</refentrytitle>

 

267

      <manvolnum>5</manvolnum></citerefentry>,

357

268

      <citerefentry><refentrytitle>plugin-runner</refentrytitle>

358

269

      <manvolnum>8mandos</manvolnum></citerefentry>,

359

270

      <citerefentry><refentrytitle>proc</refentrytitle>

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0