/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

merge

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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-29">
 
6
<!ENTITY TIMESTAMP "2008-09-30">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
  <refentryinfo>
12
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>&CONFNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
35
36
      <holder>Teddy Hogeborn</holder>
36
37
      <holder>Björn Påhlsson</holder>
37
38
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
39
    <xi:include href="legalnotice.xml"/>
61
40
  </refentryinfo>
62
 
 
 
41
  
63
42
  <refmeta>
64
43
    <refentrytitle>&CONFNAME;</refentrytitle>
65
44
    <manvolnum>5</manvolnum>
71
50
      Configuration file for the Mandos server
72
51
    </refpurpose>
73
52
  </refnamediv>
74
 
 
 
53
  
75
54
  <refsynopsisdiv>
76
 
    <synopsis>
77
 
      &CONFPATH;
78
 
    </synopsis>
 
55
    <synopsis>&CONFPATH;</synopsis>
79
56
  </refsynopsisdiv>
80
 
 
 
57
  
81
58
  <refsect1 id="description">
82
59
    <title>DESCRIPTION</title>
83
60
    <para>
95
72
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
96
73
      to provide comments.
97
74
    </para>
98
 
 
 
75
    
99
76
  </refsect1>
100
77
  <refsect1>
101
78
    <title>OPTIONS</title>
102
79
    
103
80
    <variablelist>
104
81
      <varlistentry>
105
 
        <term><varname>interface</varname></term>
 
82
        <term><option>interface<literal> = </literal><replaceable
 
83
        >NAME</replaceable></option></term>
106
84
        <listitem>
107
 
          <synopsis><literal>interface = </literal><replaceable
108
 
          >NAME</replaceable>
109
 
          </synopsis>
110
85
          <xi:include href="mandos-options.xml" xpointer="interface"/>
111
86
        </listitem>
112
87
      </varlistentry>
113
 
 
 
88
      
114
89
      <varlistentry>
115
 
        <term><varname>address</varname></term>
 
90
        <term><option>address<literal> = </literal><replaceable
 
91
          >ADDRESS</replaceable></option></term>
116
92
        <listitem>
117
 
          <synopsis><literal>address = </literal><replaceable
118
 
          >ADDRESS</replaceable>
119
 
          </synopsis>
120
93
          <xi:include href="mandos-options.xml" xpointer="address"/>
121
94
        </listitem>
122
95
      </varlistentry>
123
 
 
 
96
      
124
97
      <varlistentry>
125
 
        <term><varname>port</varname></term>
 
98
        <term><option>port<literal> = </literal><replaceable
 
99
        >NUMBER</replaceable></option></term>
126
100
        <listitem>
127
 
          <synopsis><literal>port = </literal><replaceable
128
 
          >NUMBER</replaceable>
129
 
          </synopsis>
130
101
          <xi:include href="mandos-options.xml" xpointer="port"/>
131
102
        </listitem>
132
103
      </varlistentry>
133
 
 
 
104
      
134
105
      <varlistentry>
135
 
        <term><varname>debug</varname></term>
136
 
        <listitem>
137
 
          <synopsis><literal>debug = </literal>{ <literal
 
106
        <term><option>debug<literal> = </literal>{ <literal
138
107
          >1</literal> | <literal>yes</literal> | <literal
139
108
          >true</literal> | <literal>on</literal> | <literal
140
109
          >0</literal> | <literal>no</literal> | <literal
141
 
          >false</literal> | <literal>off</literal> }
142
 
          </synopsis>
 
110
          >false</literal> | <literal>off</literal> }</option></term>
 
111
        <listitem>
143
112
          <xi:include href="mandos-options.xml" xpointer="debug"/>
144
113
        </listitem>
145
114
      </varlistentry>
146
 
 
 
115
      
147
116
      <varlistentry>
148
 
        <term><varname>priority</varname></term>
 
117
        <term><option>priority<literal> = </literal><replaceable
 
118
        >STRING</replaceable></option></term>
149
119
        <listitem>
150
 
          <synopsis><literal>priority = </literal><replaceable
151
 
          >STRING</replaceable>
152
 
          </synopsis>
153
120
          <xi:include href="mandos-options.xml" xpointer="priority"/>
154
121
        </listitem>
155
122
      </varlistentry>
156
 
 
 
123
      
157
124
      <varlistentry>
158
 
        <term><varname>servicename</varname></term>
 
125
        <term><option>servicename<literal> = </literal
 
126
        ><replaceable>NAME</replaceable></option></term>
159
127
        <listitem>
160
 
          <synopsis><literal>servicename = </literal><replaceable
161
 
          >NAME</replaceable>
162
 
          </synopsis>
163
128
          <xi:include href="mandos-options.xml"
164
129
                      xpointer="servicename"/>
165
130
        </listitem>
180
145
    <para>
181
146
      The <literal>[DEFAULT]</literal> is necessary because the Python
182
147
      built-in module <systemitem class="library">ConfigParser</systemitem>
183
 
      requres it.
 
148
      requires it.
184
149
    </para>
185
150
  </refsect1>
186
151
  
214
179
  <refsect1 id="see_also">
215
180
    <title>SEE ALSO</title>
216
181
    <para>
217
 
      <citerefentry>
218
 
        <refentrytitle>mandos</refentrytitle>
219
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
220
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
221
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
222
 
        <refentrytitle>gnutls_priority_init</refentrytitle>
223
 
        <manvolnum>3</manvolnum></citerefentry>
 
182
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
183
      ><manvolnum>3</manvolnum></citerefentry>,
 
184
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
185
      <manvolnum>8</manvolnum></citerefentry>,
 
186
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
187
      <manvolnum>5</manvolnum></citerefentry>
224
188
    </para>
225
 
 
 
189
    
226
190
    <variablelist>
227
191
      <varlistentry>
228
192
        <term>