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