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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY CONFNAME "mandos.conf">
6
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
 
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
82
83
      The file &CONFPATH; is a simple configuration file for
83
84
      <citerefentry><refentrytitle>mandos</refentrytitle>
84
85
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
85
 
      startup.  The configuration file starts with <quote><literal
86
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
87
 
      any number of <quote><varname><replaceable>option</replaceable
88
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
89
 
      with continuations in the style of RFC 822.  <quote><varname
90
 
      ><replaceable>option</replaceable></varname>: <replaceable
91
 
      >value</replaceable></quote> is also accepted.  Note that
92
 
      leading whitespace is removed from values.  Lines beginning with
93
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
94
 
      to provide comments.
 
86
      startup.  The configuration file starts with
 
87
      <quote><literal>[DEFAULT]</literal></quote> on a line by itself,
 
88
      followed by any number of
 
89
      <quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
 
90
      entries, with continuations in the style of RFC 822.
 
91
      <quote><varname><replaceable>option</replaceable></varname>:
 
92
      <replaceable>value</replaceable></quote> is also accepted.  Note
 
93
      that leading whitespace is removed from values.  Lines beginning
 
94
      with <quote>#</quote> or <quote>;</quote> are ignored and may be
 
95
      used to provide comments.
95
96
    </para>
96
97
 
97
98
  </refsect1>
102
103
      <varlistentry>
103
104
        <term><varname>interface</varname></term>
104
105
        <listitem>
105
 
          <synopsis><literal>interface = </literal><replaceable
106
 
          >NAME</replaceable>
 
106
          <synopsis><literal>interface = </literal><arg
 
107
          choice="plain"><replaceable>IF</replaceable></arg>
107
108
          </synopsis>
108
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
109
110
        </listitem>
112
113
      <varlistentry>
113
114
        <term><varname>address</varname></term>
114
115
        <listitem>
115
 
          <synopsis><literal>address = </literal><replaceable
116
 
          >ADDRESS</replaceable>
 
116
          <synopsis><literal>address = </literal><arg
 
117
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
117
118
          </synopsis>
118
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
119
120
        </listitem>
122
123
      <varlistentry>
123
124
        <term><varname>port</varname></term>
124
125
        <listitem>
125
 
          <synopsis><literal>port = </literal><replaceable
126
 
          >NUMBER</replaceable>
 
126
          <synopsis><literal>port = </literal><arg
 
127
          choice="plain"><replaceable>PORT</replaceable></arg>
127
128
          </synopsis>
128
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
129
130
        </listitem>
132
133
      <varlistentry>
133
134
        <term><varname>debug</varname></term>
134
135
        <listitem>
135
 
          <synopsis><literal>debug = </literal>{ <literal
136
 
          >1</literal> | <literal>yes</literal> | <literal
137
 
          >true</literal> | <literal>on</literal> | <literal
138
 
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }
 
136
          <synopsis><literal>debug =</literal><group choice="req">
 
137
            <arg choice="plain">1</arg>
 
138
            <arg choice="plain">yes</arg>
 
139
            <arg choice="plain">true</arg>
 
140
            <arg choice="plain">on</arg>
 
141
            <arg choice="plain">0</arg>
 
142
            <arg choice="plain">no</arg>
 
143
            <arg choice="plain">false</arg>
 
144
            <arg choice="plain">off</arg>
 
145
          </group>
140
146
          </synopsis>
141
147
          <xi:include href="mandos-options.xml" xpointer="debug"/>
142
148
        </listitem>
145
151
      <varlistentry>
146
152
        <term><varname>priority</varname></term>
147
153
        <listitem>
148
 
          <synopsis><literal>priority = </literal><replaceable
149
 
          >STRING</replaceable>
 
154
          <synopsis><literal>priority = </literal><arg
 
155
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
150
156
          </synopsis>
151
157
          <xi:include href="mandos-options.xml" xpointer="priority"/>
152
158
        </listitem>
154
160
 
155
161
      <varlistentry>
156
162
        <term><varname>servicename</varname></term>
 
163
          <synopsis><literal>servicename = </literal><arg
 
164
          choice="plain"><replaceable>NAME</replaceable></arg>
 
165
          </synopsis>
157
166
        <listitem>
158
 
          <synopsis><literal>servicename = </literal><replaceable
159
 
          >NAME</replaceable>
160
 
          </synopsis>
161
167
          <xi:include href="mandos-options.xml"
162
168
                      xpointer="servicename"/>
163
169
        </listitem>
177
183
    <title>BUGS</title>
178
184
    <para>
179
185
      The <literal>[DEFAULT]</literal> is necessary because the Python
180
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
186
      module <systemitem class="library">ConfigParser</systemitem>
181
187
      requres it.
182
188
    </para>
183
189
  </refsect1>
185
191
  <refsect1 id="example">
186
192
    <title>EXAMPLE</title>
187
193
    <informalexample>
188
 
      <para>
189
 
        No options are actually required:
190
 
      </para>
191
 
      <programlisting>
192
 
[DEFAULT]
193
 
      </programlisting>
194
 
    </informalexample>
195
 
    <informalexample>
196
 
      <para>
197
 
        An example using all the options:
198
 
      </para>
199
194
      <programlisting>
200
195
[DEFAULT]
201
196
# A configuration example
204
199
port = 1025
205
200
debug = true
206
201
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
207
 
servicename = Daena
 
202
servicename = Mandos
208
203
      </programlisting>
209
204
    </informalexample>
210
205
  </refsect1>
211
 
  
212
 
  <refsect1 id="see_also">
213
 
    <title>SEE ALSO</title>
214
 
    <para>
215
 
      <citerefentry>
216
 
        <refentrytitle>mandos</refentrytitle>
217
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
218
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
219
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
220
 
        <refentrytitle>gnutls_priority_init</refentrytitle>
221
 
        <manvolnum>3</manvolnum></citerefentry>
222
 
    </para>
223
 
 
224
 
    <variablelist>
225
 
      <varlistentry>
226
 
        <term>
227
 
          RFC 4291: <citetitle>IP Version 6 Addressing
228
 
          Architecture</citetitle>
229
 
        </term>
230
 
        <listitem>
231
 
          <variablelist>
232
 
            <varlistentry>
233
 
              <term>Section 2.2: <citetitle>Text Representation of
234
 
              Addresses</citetitle></term>
235
 
              <listitem><para/></listitem>
236
 
            </varlistentry>
237
 
            <varlistentry>
238
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
239
 
              Address</citetitle></term>
240
 
              <listitem><para/></listitem>
241
 
            </varlistentry>
242
 
            <varlistentry>
243
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
244
 
            Addresses</citetitle></term>
245
 
            <listitem>
246
 
              <para>
247
 
                The clients use IPv6 link-local addresses, which are
248
 
                immediately usable since a link-local addresses is
249
 
                automatically assigned to a network interfaces when it
250
 
                is brought up.
251
 
              </para>
252
 
            </listitem>
253
 
            </varlistentry>
254
 
          </variablelist>
255
 
        </listitem>
256
 
      </varlistentry>
257
 
      <varlistentry>
258
 
        <term>
259
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
260
 
        </term>
261
 
        <listitem>
262
 
          <para>
263
 
            Zeroconf is the network protocol standard used by clients
264
 
            for finding the Mandos server on the local network.
265
 
          </para>
266
 
        </listitem>
267
 
      </varlistentry>
268
 
    </variablelist>
269
 
  </refsect1>
270
206
</refentry>