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