/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-20 00:35:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820003541-zxymabnc6yfj8y7t
* mandos-keygen.xml (SEE ALSO): Remove "and".

* mandos.conf.xml (SEE ALSO): New section.

* mandos.xml (SEE ALSO): Changed man page references to a comma-
                         separated list, as per man-pages(7).  Added
                         reference to sh(1).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
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-09-04">
 
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>
35
34
      <holder>Teddy Hogeborn</holder>
36
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
39
60
  </refentryinfo>
40
61
 
41
62
  <refmeta>
51
72
  </refnamediv>
52
73
 
53
74
  <refsynopsisdiv>
54
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
55
78
  </refsynopsisdiv>
56
79
 
57
80
  <refsect1 id="description">
60
83
      The file &CONFPATH; is a simple configuration file for
61
84
      <citerefentry><refentrytitle>mandos</refentrytitle>
62
85
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
63
 
      startup.  The configuration file starts with <quote><literal
64
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
65
 
      any number of <quote><varname><replaceable>option</replaceable
66
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
67
 
      with continuations in the style of RFC 822.  <quote><varname
68
 
      ><replaceable>option</replaceable></varname>: <replaceable
69
 
      >value</replaceable></quote> is also accepted.  Note that
70
 
      leading whitespace is removed from values.  Lines beginning with
71
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
72
 
      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.
73
96
    </para>
74
97
 
75
98
  </refsect1>
78
101
    
79
102
    <variablelist>
80
103
      <varlistentry>
81
 
        <term><option>interface<literal> = </literal><replaceable
82
 
        >NAME</replaceable></option></term>
 
104
        <term><varname>interface</varname></term>
83
105
        <listitem>
 
106
          <synopsis><literal>interface = </literal><replaceable
 
107
          >IF</replaceable>
 
108
          </synopsis>
84
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
110
        </listitem>
86
111
      </varlistentry>
87
112
 
88
113
      <varlistentry>
89
 
        <term><option>address<literal> = </literal><replaceable
90
 
          >ADDRESS</replaceable></option></term>
 
114
        <term><varname>address</varname></term>
91
115
        <listitem>
 
116
          <synopsis><literal>address = </literal><replaceable
 
117
          >ADDRESS</replaceable>
 
118
          </synopsis>
92
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
120
        </listitem>
94
121
      </varlistentry>
95
122
 
96
123
      <varlistentry>
97
 
        <term><option>port<literal> = </literal><replaceable
98
 
        >NUMBER</replaceable></option></term>
 
124
        <term><varname>port</varname></term>
99
125
        <listitem>
 
126
          <synopsis><literal>port = </literal><replaceable
 
127
          >PORT</replaceable>
 
128
          </synopsis>
100
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
130
        </listitem>
102
131
      </varlistentry>
103
132
 
104
133
      <varlistentry>
105
 
        <term><option>debug<literal> = </literal>{ <literal
 
134
        <term><varname>debug</varname></term>
 
135
        <listitem>
 
136
          <synopsis><literal>debug = </literal>{ <literal
106
137
          >1</literal> | <literal>yes</literal> | <literal
107
138
          >true</literal> | <literal>on</literal> | <literal
108
139
          >0</literal> | <literal>no</literal> | <literal
109
 
          >false</literal> | <literal>off</literal> }</option></term>
110
 
        <listitem>
 
140
          >false</literal> | <literal>off</literal> }
 
141
          </synopsis>
111
142
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
143
        </listitem>
113
144
      </varlistentry>
114
145
 
115
146
      <varlistentry>
116
 
        <term><option>priority<literal> = </literal><replaceable
117
 
        >STRING</replaceable></option></term>
 
147
        <term><varname>priority</varname></term>
118
148
        <listitem>
 
149
          <synopsis><literal>priority = </literal><replaceable
 
150
          >PRIORITY</replaceable>
 
151
          </synopsis>
119
152
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
153
        </listitem>
121
154
      </varlistentry>
122
155
 
123
156
      <varlistentry>
124
 
        <term><option>servicename<literal> = </literal
125
 
        ><replaceable>NAME</replaceable></option></term>
 
157
        <term><varname>servicename</varname></term>
126
158
        <listitem>
 
159
          <synopsis><literal>servicename = </literal><replaceable
 
160
          >NAME</replaceable>
 
161
          </synopsis>
127
162
          <xi:include href="mandos-options.xml"
128
163
                      xpointer="servicename"/>
129
164
        </listitem>
144
179
    <para>
145
180
      The <literal>[DEFAULT]</literal> is necessary because the Python
146
181
      built-in module <systemitem class="library">ConfigParser</systemitem>
147
 
      requires it.
 
182
      requres it.
148
183
    </para>
149
184
  </refsect1>
150
185
  
178
213
  <refsect1 id="see_also">
179
214
    <title>SEE ALSO</title>
180
215
    <para>
181
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
182
 
      ><manvolnum>3</manvolnum></citerefentry>,
183
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
184
 
      <manvolnum>8</manvolnum></citerefentry>,
185
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
 
      <manvolnum>5</manvolnum></citerefentry>
 
216
      <citerefentry>
 
217
        <refentrytitle>mandos</refentrytitle>
 
218
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
219
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
220
        <manvolnum>5</manvolnum></citerefentry>
187
221
    </para>
188
 
 
189
 
    <variablelist>
190
 
      <varlistentry>
191
 
        <term>
192
 
          RFC 4291: <citetitle>IP Version 6 Addressing
193
 
          Architecture</citetitle>
194
 
        </term>
195
 
        <listitem>
196
 
          <variablelist>
197
 
            <varlistentry>
198
 
              <term>Section 2.2: <citetitle>Text Representation of
199
 
              Addresses</citetitle></term>
200
 
              <listitem><para/></listitem>
201
 
            </varlistentry>
202
 
            <varlistentry>
203
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
204
 
              Address</citetitle></term>
205
 
              <listitem><para/></listitem>
206
 
            </varlistentry>
207
 
            <varlistentry>
208
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
209
 
            Addresses</citetitle></term>
210
 
            <listitem>
211
 
              <para>
212
 
                The clients use IPv6 link-local addresses, which are
213
 
                immediately usable since a link-local addresses is
214
 
                automatically assigned to a network interfaces when it
215
 
                is brought up.
216
 
              </para>
217
 
            </listitem>
218
 
            </varlistentry>
219
 
          </variablelist>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      <varlistentry>
223
 
        <term>
224
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
225
 
        </term>
226
 
        <listitem>
227
 
          <para>
228
 
            Zeroconf is the network protocol standard used by clients
229
 
            for finding the Mandos server on the local network.
230
 
          </para>
231
 
        </listitem>
232
 
      </varlistentry>
233
 
    </variablelist>
234
222
  </refsect1>
235
223
</refentry>
236
 
<!-- Local Variables: -->
237
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
238
 
<!-- time-stamp-end: "[\"']>" -->
239
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
240
 
<!-- End: -->