/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-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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
<!ENTITY TIMESTAMP "2008-08-29">
8
8
]>
9
9
 
10
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
11
  <refentryinfo>
12
 
    <title>&CONFNAME;</title>
 
12
    <title>Mandos Manual</title>
13
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>&CONFNAME;</productname>
 
14
    <productname>Mandos</productname>
15
15
    <productnumber>&VERSION;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
83
84
      The file &CONFPATH; is a simple configuration file for
84
85
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
86
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
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.
 
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.
96
97
    </para>
97
98
 
98
99
  </refsect1>
104
105
        <term><varname>interface</varname></term>
105
106
        <listitem>
106
107
          <synopsis><literal>interface = </literal><replaceable
107
 
          >IF</replaceable>
 
108
          >NAME</replaceable>
108
109
          </synopsis>
109
110
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
111
        </listitem>
124
125
        <term><varname>port</varname></term>
125
126
        <listitem>
126
127
          <synopsis><literal>port = </literal><replaceable
127
 
          >PORT</replaceable>
 
128
          >NUMBER</replaceable>
128
129
          </synopsis>
129
130
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
131
        </listitem>
147
148
        <term><varname>priority</varname></term>
148
149
        <listitem>
149
150
          <synopsis><literal>priority = </literal><replaceable
150
 
          >PRIORITY</replaceable>
 
151
          >STRING</replaceable>
151
152
          </synopsis>
152
153
          <xi:include href="mandos-options.xml" xpointer="priority"/>
153
154
        </listitem>
209
210
      </programlisting>
210
211
    </informalexample>
211
212
  </refsect1>
 
213
  
 
214
  <refsect1 id="see_also">
 
215
    <title>SEE ALSO</title>
 
216
    <para>
 
217
      <citerefentry>
 
218
        <refentrytitle>mandos</refentrytitle>
 
219
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
220
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
221
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
222
        <refentrytitle>gnutls_priority_init</refentrytitle>
 
223
        <manvolnum>3</manvolnum></citerefentry>
 
224
    </para>
 
225
 
 
226
    <variablelist>
 
227
      <varlistentry>
 
228
        <term>
 
229
          RFC 4291: <citetitle>IP Version 6 Addressing
 
230
          Architecture</citetitle>
 
231
        </term>
 
232
        <listitem>
 
233
          <variablelist>
 
234
            <varlistentry>
 
235
              <term>Section 2.2: <citetitle>Text Representation of
 
236
              Addresses</citetitle></term>
 
237
              <listitem><para/></listitem>
 
238
            </varlistentry>
 
239
            <varlistentry>
 
240
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
241
              Address</citetitle></term>
 
242
              <listitem><para/></listitem>
 
243
            </varlistentry>
 
244
            <varlistentry>
 
245
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
246
            Addresses</citetitle></term>
 
247
            <listitem>
 
248
              <para>
 
249
                The clients use IPv6 link-local addresses, which are
 
250
                immediately usable since a link-local addresses is
 
251
                automatically assigned to a network interfaces when it
 
252
                is brought up.
 
253
              </para>
 
254
            </listitem>
 
255
            </varlistentry>
 
256
          </variablelist>
 
257
        </listitem>
 
258
      </varlistentry>
 
259
      <varlistentry>
 
260
        <term>
 
261
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
262
        </term>
 
263
        <listitem>
 
264
          <para>
 
265
            Zeroconf is the network protocol standard used by clients
 
266
            for finding the Mandos server on the local network.
 
267
          </para>
 
268
        </listitem>
 
269
      </varlistentry>
 
270
    </variablelist>
 
271
  </refsect1>
212
272
</refentry>
 
273
<!-- Local Variables: -->
 
274
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
275
<!-- time-stamp-end: "[\"']>" -->
 
276
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
277
<!-- End: -->