/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 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

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-30">
 
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>
73
72
  </refnamediv>
74
73
 
75
74
  <refsynopsisdiv>
76
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
77
78
  </refsynopsisdiv>
78
79
 
79
80
  <refsect1 id="description">
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>
100
101
    
101
102
    <variablelist>
102
103
      <varlistentry>
103
 
        <term><option>interface<literal> = </literal><replaceable
104
 
        >NAME</replaceable></option></term>
 
104
        <term><varname>interface</varname></term>
105
105
        <listitem>
 
106
          <synopsis><literal>interface = </literal><replaceable
 
107
          >IF</replaceable>
 
108
          </synopsis>
106
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
107
110
        </listitem>
108
111
      </varlistentry>
109
112
 
110
113
      <varlistentry>
111
 
        <term><option>address<literal> = </literal><replaceable
112
 
          >ADDRESS</replaceable></option></term>
 
114
        <term><varname>address</varname></term>
113
115
        <listitem>
 
116
          <synopsis><literal>address = </literal><replaceable
 
117
          >ADDRESS</replaceable>
 
118
          </synopsis>
114
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
115
120
        </listitem>
116
121
      </varlistentry>
117
122
 
118
123
      <varlistentry>
119
 
        <term><option>port<literal> = </literal><replaceable
120
 
        >NUMBER</replaceable></option></term>
 
124
        <term><varname>port</varname></term>
121
125
        <listitem>
 
126
          <synopsis><literal>port = </literal><replaceable
 
127
          >PORT</replaceable>
 
128
          </synopsis>
122
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
123
130
        </listitem>
124
131
      </varlistentry>
125
132
 
126
133
      <varlistentry>
127
 
        <term><option>debug<literal> = </literal>{ <literal
 
134
        <term><varname>debug</varname></term>
 
135
        <listitem>
 
136
          <synopsis><literal>debug = </literal>{ <literal
128
137
          >1</literal> | <literal>yes</literal> | <literal
129
138
          >true</literal> | <literal>on</literal> | <literal
130
139
          >0</literal> | <literal>no</literal> | <literal
131
 
          >false</literal> | <literal>off</literal> }</option></term>
132
 
        <listitem>
 
140
          >false</literal> | <literal>off</literal> }
 
141
          </synopsis>
133
142
          <xi:include href="mandos-options.xml" xpointer="debug"/>
134
143
        </listitem>
135
144
      </varlistentry>
136
145
 
137
146
      <varlistentry>
138
 
        <term><option>priority<literal> = </literal><replaceable
139
 
        >STRING</replaceable></option></term>
 
147
        <term><varname>priority</varname></term>
140
148
        <listitem>
 
149
          <synopsis><literal>priority = </literal><replaceable
 
150
          >PRIORITY</replaceable>
 
151
          </synopsis>
141
152
          <xi:include href="mandos-options.xml" xpointer="priority"/>
142
153
        </listitem>
143
154
      </varlistentry>
144
155
 
145
156
      <varlistentry>
146
 
        <term><option>servicename<literal> = </literal
147
 
        ><replaceable>NAME</replaceable></option></term>
 
157
        <term><varname>servicename</varname></term>
148
158
        <listitem>
 
159
          <synopsis><literal>servicename = </literal><replaceable
 
160
          >NAME</replaceable>
 
161
          </synopsis>
149
162
          <xi:include href="mandos-options.xml"
150
163
                      xpointer="servicename"/>
151
164
        </listitem>
196
209
      </programlisting>
197
210
    </informalexample>
198
211
  </refsect1>
199
 
  
200
 
  <refsect1 id="see_also">
201
 
    <title>SEE ALSO</title>
202
 
    <para>
203
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
204
 
      ><manvolnum>3</manvolnum></citerefentry>,
205
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
206
 
      <manvolnum>8</manvolnum></citerefentry>,
207
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
208
 
      <manvolnum>5</manvolnum></citerefentry>
209
 
    </para>
210
 
 
211
 
    <variablelist>
212
 
      <varlistentry>
213
 
        <term>
214
 
          RFC 4291: <citetitle>IP Version 6 Addressing
215
 
          Architecture</citetitle>
216
 
        </term>
217
 
        <listitem>
218
 
          <variablelist>
219
 
            <varlistentry>
220
 
              <term>Section 2.2: <citetitle>Text Representation of
221
 
              Addresses</citetitle></term>
222
 
              <listitem><para/></listitem>
223
 
            </varlistentry>
224
 
            <varlistentry>
225
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
226
 
              Address</citetitle></term>
227
 
              <listitem><para/></listitem>
228
 
            </varlistentry>
229
 
            <varlistentry>
230
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
231
 
            Addresses</citetitle></term>
232
 
            <listitem>
233
 
              <para>
234
 
                The clients use IPv6 link-local addresses, which are
235
 
                immediately usable since a link-local addresses is
236
 
                automatically assigned to a network interfaces when it
237
 
                is brought up.
238
 
              </para>
239
 
            </listitem>
240
 
            </varlistentry>
241
 
          </variablelist>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
      <varlistentry>
245
 
        <term>
246
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
247
 
        </term>
248
 
        <listitem>
249
 
          <para>
250
 
            Zeroconf is the network protocol standard used by clients
251
 
            for finding the Mandos server on the local network.
252
 
          </para>
253
 
        </listitem>
254
 
      </varlistentry>
255
 
    </variablelist>
256
 
  </refsect1>
257
212
</refentry>
258
 
<!-- Local Variables: -->
259
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
260
 
<!-- time-stamp-end: "[\"']>" -->
261
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
262
 
<!-- End: -->