/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
1
1
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY CONFNAME "mandos.conf">
8
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
 
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
9
8
]>
10
9
 
11
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
  <refentryinfo>
13
12
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>&CONFNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
37
37
    <legalnotice>
38
38
      <para>
67
67
  <refnamediv>
68
68
    <refname><filename>&CONFNAME;</filename></refname>
69
69
    <refpurpose>
70
 
      Configuration file for Mandos
 
70
      Configuration file for the Mandos server
71
71
    </refpurpose>
72
72
  </refnamediv>
73
73
 
80
80
  <refsect1 id="description">
81
81
    <title>DESCRIPTION</title>
82
82
    <para>
83
 
      The file &CONFPATH; is a simple configuration file for mandos
84
 
      and is looked on at startup of the service. The configuration
85
 
      file must start with <literal>[server]</literal>. The format for
86
 
      the rest is a simple VAR = VALUE pair. Values may not be empty.
87
 
    </para>
88
 
 
89
 
    <para>
90
 
      The paramters are:
91
 
    </para>
92
 
 
 
83
      The file &CONFPATH; is a simple configuration file for
 
84
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
85
      <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.
 
96
    </para>
 
97
 
 
98
  </refsect1>
 
99
  <refsect1>
 
100
    <title>OPTIONS</title>
 
101
    
93
102
    <variablelist>
94
103
      <varlistentry>
95
 
        <term><literal>interface</literal></term>
96
 
        <listitem>
97
 
          <para>
98
 
            This option allows you to override the default network
99
 
            interfaces. By default mandos will not bind to any
100
 
            specific interface but instead use default avahi-server
101
 
            behaviour.
102
 
          </para>
103
 
        </listitem>
104
 
      </varlistentry>
105
 
 
106
 
      <varlistentry>
107
 
        <term><literal>address</literal></term>
108
 
        <listitem>
109
 
          <para>
110
 
            This option allows you to override the default network
111
 
            address. By default mandos will not bind to any
112
 
            specific address but instead use default avahi-server
113
 
            behaviour.
114
 
          </para>
115
 
        </listitem>
116
 
      </varlistentry>      
117
 
 
118
 
      <varlistentry>
119
 
        <term><literal>port</literal></term>
120
 
        <listitem>
121
 
          <para>
122
 
            This option allows you to override the default port to
123
 
            listen on. By default mandos will not specify any specific
124
 
            port and instead use a random port given by the OS from
125
 
            the use of INADDR_ANY.
126
 
          </para>
127
 
        </listitem>
128
 
      </varlistentry>
129
 
 
130
 
      <varlistentry>
131
 
        <term><literal>debug</literal></term>
132
 
        <listitem>
133
 
          <para>
134
 
            This option allows you to modify debug mode with a true/false
135
 
            boolean value. By default is debug set to <literal>false</literal>.
136
 
          </para>
137
 
        </listitem>
138
 
      </varlistentry>      
139
 
 
140
 
      <varlistentry>
141
 
        <term><literal>priority</literal></term>
142
 
        <listitem>
143
 
          <para>
144
 
            This option allows you to override the default gnutls
145
 
            priority that will be used in gnutls session. See
146
 
            <citerefentry><refentrytitle>gnutls_priority_init
147
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
148
 
            more information on gnutls priority strings.
149
 
          </para>         
150
 
        </listitem>
151
 
      </varlistentry>
152
 
 
153
 
      <varlistentry>
154
 
        <term><literal>servicename</literal></term>
155
 
        <listitem>
156
 
          <para>
157
 
            This option allows you to override the default Zeroconf
158
 
            service name use to announce mandos as a avahi service. By
159
 
            default mandos will use "Mandos".
160
 
          </para>
 
104
        <term><varname>interface</varname></term>
 
105
        <listitem>
 
106
          <synopsis><literal>interface = </literal><arg
 
107
          choice="plain"><replaceable>IF</replaceable></arg>
 
108
          </synopsis>
 
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
110
        </listitem>
 
111
      </varlistentry>
 
112
 
 
113
      <varlistentry>
 
114
        <term><varname>address</varname></term>
 
115
        <listitem>
 
116
          <synopsis><literal>address = </literal><arg
 
117
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
 
118
          </synopsis>
 
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
120
        </listitem>
 
121
      </varlistentry>
 
122
 
 
123
      <varlistentry>
 
124
        <term><varname>port</varname></term>
 
125
        <listitem>
 
126
          <synopsis><literal>port = </literal><arg
 
127
          choice="plain"><replaceable>PORT</replaceable></arg>
 
128
          </synopsis>
 
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
130
        </listitem>
 
131
      </varlistentry>
 
132
 
 
133
      <varlistentry>
 
134
        <term><varname>debug</varname></term>
 
135
        <listitem>
 
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>
 
146
          </synopsis>
 
147
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
148
        </listitem>
 
149
      </varlistentry>
 
150
 
 
151
      <varlistentry>
 
152
        <term><varname>priority</varname></term>
 
153
        <listitem>
 
154
          <synopsis><literal>priority = </literal><arg
 
155
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
 
156
          </synopsis>
 
157
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
158
        </listitem>
 
159
      </varlistentry>
 
160
 
 
161
      <varlistentry>
 
162
        <term><varname>servicename</varname></term>
 
163
          <synopsis><literal>servicename = </literal><arg
 
164
          choice="plain"><replaceable>NAME</replaceable></arg>
 
165
          </synopsis>
 
166
        <listitem>
 
167
          <xi:include href="mandos-options.xml"
 
168
                      xpointer="servicename"/>
161
169
        </listitem>
162
170
      </varlistentry>
163
171
      
164
172
    </variablelist>
165
173
  </refsect1>
166
 
 
167
 
  <refsect1 id="examples">
168
 
    <title>EXAMPLES</title>
 
174
  
 
175
  <refsect1 id="files">
 
176
    <title>FILES</title>
 
177
    <para>
 
178
      The file described here is &CONFPATH;
 
179
    </para>
 
180
  </refsect1>
 
181
  
 
182
  <refsect1 id="bugs">
 
183
    <title>BUGS</title>
 
184
    <para>
 
185
      The <literal>[DEFAULT]</literal> is necessary because the Python
 
186
      module <systemitem class="library">ConfigParser</systemitem>
 
187
      requres it.
 
188
    </para>
 
189
  </refsect1>
 
190
  
 
191
  <refsect1 id="example">
 
192
    <title>EXAMPLE</title>
169
193
    <informalexample>
170
194
      <programlisting>
171
 
        [server]
172
 
        # A configuration example
173
 
        interface = eth0 
174
 
        address = 2001:DB8:
175
 
        port = 1025 
176
 
        debug = true 
177
 
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
178
 
        servicename = Mandos
 
195
[DEFAULT]
 
196
# A configuration example
 
197
interface = eth0
 
198
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
199
port = 1025
 
200
debug = true
 
201
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
202
servicename = Mandos
179
203
      </programlisting>
180
204
    </informalexample>
181
 
  </refsect1>  
182
 
  
183
 
  <refsect1 id="files">
184
 
    <title>FILES</title>
185
 
    <para>
186
 
      The file described here is &CONFPATH;
187
 
    </para>
188
205
  </refsect1>
189
206
</refentry>