/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-31 15:06:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831150639-tqdkyea3b9p3rou7
* Makefile: Make all DocBook rules include legalnotice.xml as a
            dependency.

* legalnotice.xml: New file with just the <legalnotice> tag in it.

* mandos-clients.conf.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".
* mandos-keygen.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos-conf.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos.xml (/refentry/refentryinfo/legalnotice): - '' -

* overview.xml: Changed root node tag name in DOCTYPE declaration.

* plugin-runner.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-prompt.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-request.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

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 OVERVIEW SYSTEM "overview.xml">
 
7
<!ENTITY TIMESTAMP "2008-08-31">
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>
34
35
      <holder>Teddy Hogeborn</holder>
35
36
      <holder>Björn Påhlsson</holder>
36
37
    </copyright>
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>
 
38
    <xi:include href="legalnotice.xml"/>
60
39
  </refentryinfo>
61
40
 
62
41
  <refmeta>
72
51
  </refnamediv>
73
52
 
74
53
  <refsynopsisdiv>
75
 
    <synopsis>
76
 
      &CONFPATH;
77
 
    </synopsis>
 
54
    <synopsis>&CONFPATH;</synopsis>
78
55
  </refsynopsisdiv>
79
56
 
80
57
  <refsect1 id="description">
83
60
      The file &CONFPATH; is a simple configuration file for
84
61
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
62
      <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.
 
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.
96
73
    </para>
97
74
 
98
75
  </refsect1>
101
78
    
102
79
    <variablelist>
103
80
      <varlistentry>
104
 
        <term><varname>interface</varname></term>
 
81
        <term><option>interface<literal> = </literal><replaceable
 
82
        >NAME</replaceable></option></term>
105
83
        <listitem>
106
 
          <synopsis><literal>interface = </literal><replaceable
107
 
          >IF</replaceable>
108
 
          </synopsis>
109
84
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
85
        </listitem>
111
86
      </varlistentry>
112
87
 
113
88
      <varlistentry>
114
 
        <term><varname>address</varname></term>
 
89
        <term><option>address<literal> = </literal><replaceable
 
90
          >ADDRESS</replaceable></option></term>
115
91
        <listitem>
116
 
          <synopsis><literal>address = </literal><replaceable
117
 
          >ADDRESS</replaceable>
118
 
          </synopsis>
119
92
          <xi:include href="mandos-options.xml" xpointer="address"/>
120
93
        </listitem>
121
94
      </varlistentry>
122
95
 
123
96
      <varlistentry>
124
 
        <term><varname>port</varname></term>
 
97
        <term><option>port<literal> = </literal><replaceable
 
98
        >NUMBER</replaceable></option></term>
125
99
        <listitem>
126
 
          <synopsis><literal>port = </literal><replaceable
127
 
          >PORT</replaceable>
128
 
          </synopsis>
129
100
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
101
        </listitem>
131
102
      </varlistentry>
132
103
 
133
104
      <varlistentry>
134
 
        <term><varname>debug</varname></term>
135
 
        <listitem>
136
 
          <synopsis><literal>debug = </literal>{ <literal
 
105
        <term><option>debug<literal> = </literal>{ <literal
137
106
          >1</literal> | <literal>yes</literal> | <literal
138
107
          >true</literal> | <literal>on</literal> | <literal
139
108
          >0</literal> | <literal>no</literal> | <literal
140
 
          >false</literal> | <literal>off</literal> }
141
 
          </synopsis>
 
109
          >false</literal> | <literal>off</literal> }</option></term>
 
110
        <listitem>
142
111
          <xi:include href="mandos-options.xml" xpointer="debug"/>
143
112
        </listitem>
144
113
      </varlistentry>
145
114
 
146
115
      <varlistentry>
147
 
        <term><varname>priority</varname></term>
 
116
        <term><option>priority<literal> = </literal><replaceable
 
117
        >STRING</replaceable></option></term>
148
118
        <listitem>
149
 
          <synopsis><literal>priority = </literal><replaceable
150
 
          >PRIORITY</replaceable>
151
 
          </synopsis>
152
119
          <xi:include href="mandos-options.xml" xpointer="priority"/>
153
120
        </listitem>
154
121
      </varlistentry>
155
122
 
156
123
      <varlistentry>
157
 
        <term><varname>servicename</varname></term>
 
124
        <term><option>servicename<literal> = </literal
 
125
        ><replaceable>NAME</replaceable></option></term>
158
126
        <listitem>
159
 
          <synopsis><literal>servicename = </literal><replaceable
160
 
          >NAME</replaceable>
161
 
          </synopsis>
162
127
          <xi:include href="mandos-options.xml"
163
128
                      xpointer="servicename"/>
164
129
        </listitem>
213
178
  <refsect1 id="see_also">
214
179
    <title>SEE ALSO</title>
215
180
    <para>
216
 
      <citerefentry>
217
 
        <refentrytitle>mandos</refentrytitle>
218
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
219
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
220
 
        <manvolnum>5</manvolnum></citerefentry>
 
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>
221
187
    </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>
222
234
  </refsect1>
223
235
</refentry>
 
236
<!-- Local Variables: -->
 
237
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
238
<!-- time-stamp-end: "[\"']>" -->
 
239
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
240
<!-- End: -->