/mandos/trunk

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

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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-30">
8
9
]>
9
10
 
10
11
<refentry>
11
12
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
 
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
15
    <productname>Mandos</productname>
15
16
    <productnumber>&VERSION;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
16
18
    <authorgroup>
17
19
      <author>
18
20
        <firstname>Björn</firstname>
92
94
    <cmdsynopsis>
93
95
      <command>&COMMANDNAME;</command>
94
96
      <arg choice='plain'>--version</arg>
95
 
    </cmdsynopsis>    
 
97
    </cmdsynopsis>
96
98
  </refsynopsisdiv>
97
99
 
98
100
  <refsect1 id="description">
106
108
      and subsequlently started in the initrd environment. See
107
109
      <citerefentry><refentrytitle>crypttab</refentrytitle>
108
110
      <manvolnum>5</manvolnum></citerefentry> for more information on
109
 
      keyscripts.    
 
111
      keyscripts.
110
112
    </para>
111
113
 
112
114
    <para>
125
127
            Global options given to all plugins as additional start
126
128
            arguments.  Options are specified with a -o flag followed
127
129
            by a comma separated string of options.
128
 
          </para>         
 
130
          </para>       
129
131
        </listitem>
130
132
      </varlistentry>
131
133
 
138
140
            Plugin specific options given to the plugin as additional
139
141
            start arguments.  Options are specified with a -o flag
140
142
            followed by a comma separated string of options.
141
 
          </para>         
 
143
          </para>       
142
144
        </listitem>
143
 
      </varlistentry>      
 
145
      </varlistentry>
144
146
 
145
147
      <varlistentry>
146
148
        <term><literal>-d</literal>,<literal> --disable
149
151
        <listitem>
150
152
          <para>
151
153
            Disable a specific plugin
152
 
          </para>         
 
154
          </para>       
153
155
        </listitem>
154
156
      </varlistentry>
155
157
 
161
163
            Group ID the plugins will run as
162
164
          </para>
163
165
        </listitem>
164
 
      </varlistentry>      
 
166
      </varlistentry>
165
167
 
166
168
      <varlistentry>
167
169
        <term><literal>--userid <replaceable>ID</replaceable>
171
173
            User ID the plugins will run as
172
174
          </para>
173
175
        </listitem>
174
 
      </varlistentry>      
 
176
      </varlistentry>
175
177
 
176
178
      <varlistentry>
177
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
181
183
            Specify a different plugin directory
182
184
          </para>
183
185
        </listitem>
184
 
      </varlistentry>       
 
186
      </varlistentry>
185
187
      
186
188
      <varlistentry>
187
189
        <term><literal>--debug</literal></term>
217
219
            Prints the program version
218
220
          </para>
219
221
        </listitem>
220
 
      </varlistentry>            
 
222
      </varlistentry>
221
223
    </variablelist>
222
224
  </refsect1>
223
225
 
231
233
    <title>FILES</title>
232
234
    <para>
233
235
    </para>
234
 
  </refsect1>  
 
236
  </refsect1>
235
237
 
236
238
  <refsect1 id="notes">
237
239
    <title>NOTES</title>
243
245
    <title>BUGS</title>
244
246
    <para>
245
247
    </para>
246
 
  </refsect1>  
 
248
  </refsect1>
247
249
 
248
250
  <refsect1 id="examples">
249
 
    <title>EXAMPLES</title>
 
251
    <title>EXAMPLE</title>
250
252
    <para>
251
253
    </para>
252
254
  </refsect1>
260
262
  <refsect1 id="see_also">
261
263
    <title>SEE ALSO</title>
262
264
    <para>
 
265
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
266
      <manvolnum>8</manvolnum></citerefentry>,
263
267
      <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
269
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
270
 
      <manvolnum>8</manvolnum></citerefentry>
 
268
      <manvolnum>8</manvolnum></citerefentry>,
 
269
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
270
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
271
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
272
      <manvolnum>8mandos</manvolnum></citerefentry>
271
273
    </para>
272
274
  </refsect1>
273
275
 
274
276
</refentry>
 
277
<!-- Local Variables: -->
 
278
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
279
<!-- time-stamp-end: "[\"']>" -->
 
280
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
281
<!-- End: -->