/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
7
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
11
11
  <refentryinfo>
12
12
    <title>&CONFNAME;</title>
13
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
95
95
      used to provide comments.
96
96
    </para>
97
97
 
98
 
  </refsect1>
99
 
  <refsect1>
100
 
    <title>OPTIONS</title>
101
 
    
 
98
    <para>
 
99
      The options are:
 
100
    </para>
 
101
 
102
102
    <variablelist>
103
103
      <varlistentry>
104
 
        <term><varname>interface</varname></term>
105
 
        <listitem>
106
 
          <synopsis><literal>interface = </literal><replaceable
107
 
          >IF</replaceable>
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><replaceable
117
 
          >ADDRESS</replaceable>
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><replaceable
127
 
          >PORT</replaceable>
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>{ <literal
137
 
          >1</literal> | <literal>yes</literal> | <literal
138
 
          >true</literal> | <literal>on</literal> | <literal
139
 
          >0</literal> | <literal>no</literal> | <literal
140
 
          >false</literal> | <literal>off</literal> }
141
 
          </synopsis>
142
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
143
 
        </listitem>
144
 
      </varlistentry>
145
 
 
146
 
      <varlistentry>
147
 
        <term><varname>priority</varname></term>
148
 
        <listitem>
149
 
          <synopsis><literal>priority = </literal><replaceable
150
 
          >PRIORITY</replaceable>
151
 
          </synopsis>
152
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
 
156
 
      <varlistentry>
157
 
        <term><varname>servicename</varname></term>
158
 
        <listitem>
159
 
          <synopsis><literal>servicename = </literal><replaceable
160
 
          >NAME</replaceable>
161
 
          </synopsis>
162
 
          <xi:include href="mandos-options.xml"
163
 
                      xpointer="servicename"/>
 
104
        <term><literal><varname>interface</varname></literal></term>
 
105
        <listitem>
 
106
          <para>
 
107
            This option allows you to override the default network
 
108
            interfaces. By default mandos will not bind to any
 
109
            specific interface but instead use default avahi-server
 
110
            behaviour.
 
111
          </para>
 
112
        </listitem>
 
113
      </varlistentry>
 
114
 
 
115
      <varlistentry>
 
116
        <term><literal><varname>address</varname></literal></term>
 
117
        <listitem>
 
118
          <para>
 
119
            This option allows you to override the default network
 
120
            address. By default mandos will not bind to any
 
121
            specific address but instead use default avahi-server
 
122
            behaviour.
 
123
          </para>
 
124
        </listitem>
 
125
      </varlistentry>      
 
126
 
 
127
      <varlistentry>
 
128
        <term><literal><varname>port</varname></literal></term>
 
129
        <listitem>
 
130
          <para>
 
131
            This option allows you to override the default port to
 
132
            listen on. By default mandos will not specify any specific
 
133
            port and instead use a random port given by the OS from
 
134
            the use of INADDR_ANY.
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>
 
138
 
 
139
      <varlistentry>
 
140
        <term><literal><varname>debug</varname></literal></term>
 
141
        <listitem>
 
142
          <para>
 
143
            This option allows you to modify debug mode with a true/false
 
144
            boolean value. By default is debug set to <literal>false</literal>.
 
145
          </para>
 
146
        </listitem>
 
147
      </varlistentry>      
 
148
 
 
149
      <varlistentry>
 
150
        <term><literal><varname>priority</varname></literal></term>
 
151
        <listitem>
 
152
          <para>
 
153
            This option allows you to override the default gnutls
 
154
            priority that will be used in gnutls session. See
 
155
            <citerefentry><refentrytitle>gnutls_priority_init
 
156
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
 
157
            more information on gnutls priority strings.
 
158
          </para>         
 
159
        </listitem>
 
160
      </varlistentry>
 
161
 
 
162
      <varlistentry>
 
163
        <term><literal><varname>servicename</varname></literal></term>
 
164
        <listitem>
 
165
          <para>
 
166
            This option allows you to override the default Zeroconf
 
167
            service name use to announce mandos as a avahi service. By
 
168
            default mandos will use "Mandos".
 
169
          </para>
164
170
        </listitem>
165
171
      </varlistentry>
166
172
      
167
173
    </variablelist>
168
174
  </refsect1>
 
175
 
 
176
  <refsect1 id="examples">
 
177
    <title>EXAMPLES</title>
 
178
    <informalexample>
 
179
      <programlisting>
 
180
        [server]
 
181
        # A configuration example
 
182
        interface = eth0 
 
183
        address = 2001:DB8:
 
184
        port = 1025 
 
185
        debug = true 
 
186
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
187
        servicename = Mandos
 
188
      </programlisting>
 
189
    </informalexample>
 
190
  </refsect1>  
169
191
  
170
192
  <refsect1 id="files">
171
193
    <title>FILES</title>
173
195
      The file described here is &CONFPATH;
174
196
    </para>
175
197
  </refsect1>
176
 
  
177
 
  <refsect1 id="bugs">
178
 
    <title>BUGS</title>
179
 
    <para>
180
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
181
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
182
 
      requres it.
183
 
    </para>
184
 
  </refsect1>
185
 
  
186
 
  <refsect1 id="example">
187
 
    <title>EXAMPLE</title>
188
 
    <informalexample>
189
 
      <para>
190
 
        No options are actually required:
191
 
      </para>
192
 
      <programlisting>
193
 
[DEFAULT]
194
 
      </programlisting>
195
 
    </informalexample>
196
 
    <informalexample>
197
 
      <para>
198
 
        An example using all the options:
199
 
      </para>
200
 
      <programlisting>
201
 
[DEFAULT]
202
 
# A configuration example
203
 
interface = eth0
204
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
205
 
port = 1025
206
 
debug = true
207
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
208
 
servicename = Daena
209
 
      </programlisting>
210
 
    </informalexample>
211
 
  </refsect1>
212
 
  
213
 
  <refsect1 id="see_also">
214
 
    <title>SEE ALSO</title>
215
 
    <para>
216
 
      <citerefentry>
217
 
        <refentrytitle>mandos</refentrytitle>
218
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
219
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
220
 
        <manvolnum>5</manvolnum></citerefentry>
221
 
    </para>
222
 
  </refsect1>
223
198
</refentry>