/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-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

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