/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
2
2
<?xml-stylesheet type="text/xsl"
3
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
6
<!ENTITY VERSION "1.0">
7
7
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-31">
9
8
]>
10
9
 
11
10
<refentry>
12
11
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
14
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
16
    <authorgroup>
19
17
      <author>
20
18
        <firstname>Björn</firstname>
33
31
    </authorgroup>
34
32
    <copyright>
35
33
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn</holder>
37
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
38
35
    </copyright>
39
36
    <legalnotice>
40
37
      <para>
69
66
  <refnamediv>
70
67
    <refname><command>&COMMANDNAME;</command></refname>
71
68
    <refpurpose>
72
 
      Run Mandos plugins.  Pass data from first succesful one.
 
69
      get password for encrypted rootdisk
73
70
    </refpurpose>
74
71
  </refnamediv>
75
72
 
76
73
  <refsynopsisdiv>
77
74
    <cmdsynopsis>
78
75
      <command>&COMMANDNAME;</command>
79
 
      <group rep="repeat">
80
 
        <arg choice="plain"><option>--global-envs=<replaceable
81
 
        >VAR</replaceable><literal>=</literal><replaceable
82
 
        >value</replaceable></option></arg>
83
 
        <arg choice="plain"><option>-e
84
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
85
 
        >value</replaceable> </option></arg>
86
 
      </group>
87
 
      <sbr/>
88
 
      <group rep="repeat">
89
 
        <arg choice="plain"><option>--envs-for=<replaceable
90
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
91
 
        >ENV</replaceable><literal>=</literal><replaceable
92
 
        >value</replaceable></option></arg>
93
 
        <arg choice="plain"><option>-f<replaceable>
94
 
        PLUGIN</replaceable><literal>:</literal><replaceable
95
 
        >ENV</replaceable><literal>=</literal><replaceable
96
 
        >value</replaceable> </option></arg>
97
 
      </group>
98
 
      <sbr/>
99
 
      <group rep="repeat">
100
 
        <arg choice="plain"><option>--global-options=<replaceable
101
 
        >OPTIONS</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-g<replaceable>
103
 
        OPTIONS</replaceable> </option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group rep="repeat">
107
 
        <arg choice="plain"><option>--options-for=<replaceable
108
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
109
 
        >OPTIONS</replaceable></option></arg>
110
 
        <arg choice="plain"><option>-f<replaceable>
111
 
        PLUGIN</replaceable><literal>:</literal><replaceable
112
 
        >OPTIONS</replaceable> </option></arg>
113
 
      </group>
114
 
      <sbr/>
115
 
      <group rep="repeat">
116
 
        <arg choice="plain"><option>--disable=<replaceable
117
 
        >PLUGIN</replaceable></option></arg>
118
 
        <arg choice="plain"><option>-d
119
 
        <replaceable>PLUGIN</replaceable> </option></arg>
120
 
      </group>
121
 
      <sbr/>
122
 
      <arg><option>--groupid=<replaceable
123
 
      >ID</replaceable></option></arg>
124
 
      <sbr/>
125
 
      <arg><option>--userid=<replaceable
126
 
      >ID</replaceable></option></arg>
127
 
      <sbr/>
128
 
      <arg><option>--plugin-dir=<replaceable
129
 
      >DIRECTORY</replaceable></option></arg>
130
 
      <sbr/>
131
 
      <arg><option>--debug</option></arg>
132
 
    </cmdsynopsis>
133
 
    <cmdsynopsis>
134
 
      <command>&COMMANDNAME;</command>
135
 
      <group choice="req">
136
 
        <arg choice="plain"><option>--help</option></arg>
137
 
        <arg choice="plain"><option>-?</option></arg>
138
 
      </group>
139
 
    </cmdsynopsis>
140
 
    <cmdsynopsis>
141
 
      <command>&COMMANDNAME;</command>
142
 
      <arg choice="plain"><option>--usage</option></arg>
143
 
    </cmdsynopsis>
144
 
    <cmdsynopsis>
145
 
      <command>&COMMANDNAME;</command>
146
 
      <group choice="req">
147
 
        <arg choice="plain"><option>--version</option></arg>
148
 
        <arg choice="plain"><option>-V</option></arg>
149
 
      </group>
150
 
    </cmdsynopsis>
 
76
      <arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
 
77
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
 
78
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
 
79
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
 
80
      <arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
 
81
      <arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
 
82
      <arg choice='opt'>--debug</arg>
 
83
    </cmdsynopsis>
 
84
    <cmdsynopsis>
 
85
      <command>&COMMANDNAME;</command>
 
86
      <arg choice='plain'>--help</arg>
 
87
    </cmdsynopsis>
 
88
    <cmdsynopsis>
 
89
      <command>&COMMANDNAME;</command>
 
90
      <arg choice='plain'>--usage</arg>
 
91
    </cmdsynopsis>
 
92
    <cmdsynopsis>
 
93
      <command>&COMMANDNAME;</command>
 
94
      <arg choice='plain'>--version</arg>
 
95
    </cmdsynopsis>    
151
96
  </refsynopsisdiv>
152
97
 
153
98
  <refsect1 id="description">
161
106
      and subsequlently started in the initrd environment. See
162
107
      <citerefentry><refentrytitle>crypttab</refentrytitle>
163
108
      <manvolnum>5</manvolnum></citerefentry> for more information on
164
 
      keyscripts.
 
109
      keyscripts.    
165
110
    </para>
166
111
 
167
112
    <para>
173
118
    <title>OPTIONS</title>
174
119
    <variablelist>
175
120
      <varlistentry>
176
 
        <term><option>--global-options
177
 
        <replaceable>OPTIONS</replaceable></option></term>
178
 
        <term><option>-g
179
 
        <replaceable>OPTIONS</replaceable></option></term>
 
121
        <term><literal>-g</literal>,<literal>--global-options
 
122
        <replaceable>OPTIONS</replaceable></literal></term>
180
123
        <listitem>
181
124
          <para>
182
125
            Global options given to all plugins as additional start
183
126
            arguments.  Options are specified with a -o flag followed
184
127
            by a comma separated string of options.
185
 
          </para>       
 
128
          </para>         
186
129
        </listitem>
187
130
      </varlistentry>
188
131
 
189
132
      <varlistentry>
190
 
        <term><option>--options-for
191
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
192
 
        ><replaceable>OPTION</replaceable></option></term>
193
 
        <term><option>-o
194
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
195
 
        ><replaceable>OPTION</replaceable></option></term>
 
133
        <term><literal>-o</literal>,<literal> --options-for
 
134
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
135
        </literal></term>
196
136
        <listitem>
197
137
          <para>
198
138
            Plugin specific options given to the plugin as additional
199
139
            start arguments.  Options are specified with a -o flag
200
140
            followed by a comma separated string of options.
201
 
          </para>       
 
141
          </para>         
202
142
        </listitem>
203
 
      </varlistentry>
 
143
      </varlistentry>      
204
144
 
205
145
      <varlistentry>
206
 
        <term><option> --disable
207
 
        <replaceable>PLUGIN</replaceable></option></term>
208
 
        <term><option>-d
209
 
        <replaceable>PLUGIN</replaceable></option></term>
 
146
        <term><literal>-d</literal>,<literal> --disable
 
147
        <replaceable>PLUGIN</replaceable>
 
148
        </literal></term>
210
149
        <listitem>
211
150
          <para>
212
151
            Disable a specific plugin
213
 
          </para>       
 
152
          </para>         
214
153
        </listitem>
215
154
      </varlistentry>
216
155
 
217
156
      <varlistentry>
218
 
        <term><option>--groupid
219
 
        <replaceable>ID</replaceable></option></term>
 
157
        <term><literal>--groupid <replaceable>ID</replaceable>
 
158
        </literal></term>
220
159
        <listitem>
221
160
          <para>
222
161
            Group ID the plugins will run as
223
162
          </para>
224
163
        </listitem>
225
 
      </varlistentry>
 
164
      </varlistentry>      
226
165
 
227
166
      <varlistentry>
228
 
        <term><option>--userid
229
 
        <replaceable>ID</replaceable></option></term>
 
167
        <term><literal>--userid <replaceable>ID</replaceable>
 
168
        </literal></term>
230
169
        <listitem>
231
170
          <para>
232
171
            User ID the plugins will run as
233
172
          </para>
234
173
        </listitem>
235
 
      </varlistentry>
 
174
      </varlistentry>      
236
175
 
237
176
      <varlistentry>
238
 
        <term><option>--plugin-dir
239
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
177
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
178
        </literal></term>
240
179
        <listitem>
241
180
          <para>
242
181
            Specify a different plugin directory
243
182
          </para>
244
183
        </listitem>
245
 
      </varlistentry>
 
184
      </varlistentry>       
246
185
      
247
186
      <varlistentry>
248
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
249
188
        <listitem>
250
189
          <para>
251
190
            Debug mode
254
193
      </varlistentry>
255
194
      
256
195
      <varlistentry>
257
 
        <term><option>--help</option></term>
258
 
        <term><option>-?</option></term>
 
196
        <term><literal>-?</literal>, <literal>--help</literal></term>
259
197
        <listitem>
260
198
          <para>
261
199
            Gives a help message
264
202
      </varlistentry>
265
203
      
266
204
      <varlistentry>
267
 
        <term><option>--usage</option></term>
 
205
        <term><literal>--usage</literal></term>
268
206
        <listitem>
269
207
          <para>
270
208
            Gives a short usage message
273
211
      </varlistentry>
274
212
 
275
213
      <varlistentry>
276
 
        <term><option>--version</option></term>
277
 
        <term><option>-V</option></term>
 
214
        <term><literal>-V</literal>, <literal>--version</literal></term>
278
215
        <listitem>
279
216
          <para>
280
217
            Prints the program version
281
218
          </para>
282
219
        </listitem>
283
 
      </varlistentry>
 
220
      </varlistentry>            
284
221
    </variablelist>
285
222
  </refsect1>
286
223
 
294
231
    <title>FILES</title>
295
232
    <para>
296
233
    </para>
297
 
  </refsect1>
 
234
  </refsect1>  
298
235
 
299
236
  <refsect1 id="notes">
300
237
    <title>NOTES</title>
306
243
    <title>BUGS</title>
307
244
    <para>
308
245
    </para>
309
 
  </refsect1>
 
246
  </refsect1>  
310
247
 
311
248
  <refsect1 id="examples">
312
 
    <title>EXAMPLE</title>
 
249
    <title>EXAMPLES</title>
313
250
    <para>
314
251
    </para>
315
252
  </refsect1>
323
260
  <refsect1 id="see_also">
324
261
    <title>SEE ALSO</title>
325
262
    <para>
 
263
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
264
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
265
      <refentrytitle>password-request</refentrytitle>
 
266
      <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
267
      <refentrytitle>password-prompt</refentrytitle>
 
268
      <manvolnum>8mandos</manvolnum></citerefentry>, and
326
269
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
327
 
      <manvolnum>8</manvolnum></citerefentry>,
328
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
329
 
      <manvolnum>8</manvolnum></citerefentry>,
330
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
331
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
332
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
333
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
270
      <manvolnum>8</manvolnum></citerefentry>
334
271
    </para>
335
272
  </refsect1>
336
273
 
337
274
</refentry>
338
 
<!-- Local Variables: -->
339
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
340
 
<!-- time-stamp-end: "[\"']>" -->
341
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
342
 
<!-- End: -->