/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 mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  Moved long options
                               before short.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
74
74
  <refsynopsisdiv>
75
75
    <cmdsynopsis>
76
76
      <command>&COMMANDNAME;</command>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
78
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
82
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
83
 
      <arg>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
88
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
92
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
93
 
      <arg>--debug</arg>
 
77
      <group>
 
78
        <arg choice="plain"><option>--interface
 
79
        <replaceable>NAME</replaceable></option></arg>
 
80
        <arg choice="plain"><option>-i
 
81
        <replaceable>NAME</replaceable></option></arg>
 
82
      </group>
 
83
      <sbr/>
 
84
      <group>
 
85
        <arg choice="plain"><option>--address
 
86
        <replaceable>ADDRESS</replaceable></option></arg>
 
87
        <arg choice="plain"><option>-a
 
88
        <replaceable>ADDRESS</replaceable></option></arg>
 
89
      </group>
 
90
      <sbr/>
 
91
      <group>
 
92
        <arg choice="plain"><option>--port
 
93
        <replaceable>PORT</replaceable></option></arg>
 
94
        <arg choice="plain"><option>-p
 
95
        <replaceable>PORT</replaceable></option></arg>
 
96
      </group>
 
97
      <sbr/>
 
98
      <arg><option>--priority
 
99
      <replaceable>PRIORITY</replaceable></option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--servicename
 
102
      <replaceable>NAME</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--configdir
 
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--debug</option></arg>
94
108
    </cmdsynopsis>
95
109
    <cmdsynopsis>
96
110
      <command>&COMMANDNAME;</command>
97
111
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
112
        <arg choice="plain"><option>--help</option></arg>
 
113
        <arg choice="plain"><option>-h</option></arg>
100
114
      </group>
101
115
    </cmdsynopsis>
102
116
    <cmdsynopsis>
103
117
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
118
      <arg choice="plain"><option>--version</option></arg>
105
119
    </cmdsynopsis>
106
120
    <cmdsynopsis>
107
121
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
122
      <arg choice="plain"><option>--check</option></arg>
109
123
    </cmdsynopsis>
110
124
  </refsynopsisdiv>
111
125
 
135
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
150
      linkend="overview"/> for details.
137
151
    </para>
138
 
 
 
152
    
139
153
  </refsect1>
140
154
  
141
155
  <refsect1 id="options">
142
156
    <title>OPTIONS</title>
143
 
 
 
157
    
144
158
    <variablelist>
145
159
      <varlistentry>
 
160
        <term><option>--help</option></term>
146
161
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
162
        <listitem>
149
163
          <para>
150
164
            Show a help message and exit
151
165
          </para>
152
166
        </listitem>
153
167
      </varlistentry>
154
 
 
 
168
      
155
169
      <varlistentry>
 
170
        <term><option>--interface</option>
 
171
        <replaceable>NAME</replaceable></term>
156
172
        <term><option>-i</option>
157
173
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
174
        <listitem>
161
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
176
        </listitem>
163
177
      </varlistentry>
164
 
 
 
178
      
165
179
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
180
        <term><option>--address
 
181
        <replaceable>ADDRESS</replaceable></option></term>
 
182
        <term><option>-a
 
183
        <replaceable>ADDRESS</replaceable></option></term>
168
184
        <listitem>
169
185
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
186
        </listitem>
171
187
      </varlistentry>
172
 
 
 
188
      
173
189
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
190
        <term><option>--port
 
191
        <replaceable>PORT</replaceable></option></term>
 
192
        <term><option>-p
 
193
        <replaceable>PORT</replaceable></option></term>
176
194
        <listitem>
177
195
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
196
        </listitem>
179
197
      </varlistentry>
180
 
 
 
198
      
181
199
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
200
        <term><option>--check</option></term>
183
201
        <listitem>
184
202
          <para>
185
203
            Run the server’s self-tests.  This includes any unit
187
205
          </para>
188
206
        </listitem>
189
207
      </varlistentry>
190
 
 
 
208
      
191
209
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
210
        <term><option>--debug</option></term>
193
211
        <listitem>
194
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
213
        </listitem>
196
214
      </varlistentry>
197
215
 
198
216
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        PRIORITY</replaceable></literal></term>
 
217
        <term><option>--priority <replaceable>
 
218
        PRIORITY</replaceable></option></term>
201
219
        <listitem>
202
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
221
        </listitem>
204
222
      </varlistentry>
205
223
 
206
224
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
225
        <term><option>--servicename
 
226
        <replaceable>NAME</replaceable></option></term>
209
227
        <listitem>
210
228
          <xi:include href="mandos-options.xml"
211
229
                      xpointer="servicename"/>
213
231
      </varlistentry>
214
232
 
215
233
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
234
        <term><option>--configdir
 
235
        <replaceable>DIRECTORY</replaceable></option></term>
218
236
        <listitem>
219
237
          <para>
220
238
            Directory to search for configuration files.  Default is
228
246
      </varlistentry>
229
247
 
230
248
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
249
        <term><option>--version</option></term>
232
250
        <listitem>
233
251
          <para>
234
252
            Prints the program version and exit.