/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-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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
<!ENTITY TIMESTAMP "2008-08-29">
8
8
]>
9
9
 
10
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
35
35
      <holder>Teddy Hogeborn</holder>
36
36
      <holder>Björn Påhlsson</holder>
37
37
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
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
61
  </refentryinfo>
40
 
  
 
62
 
41
63
  <refmeta>
42
64
    <refentrytitle>&CONFNAME;</refentrytitle>
43
65
    <manvolnum>5</manvolnum>
49
71
      Configuration file for the Mandos server
50
72
    </refpurpose>
51
73
  </refnamediv>
52
 
  
 
74
 
53
75
  <refsynopsisdiv>
54
 
    <synopsis>&CONFPATH;</synopsis>
 
76
    <synopsis>
 
77
      &CONFPATH;
 
78
    </synopsis>
55
79
  </refsynopsisdiv>
56
 
  
 
80
 
57
81
  <refsect1 id="description">
58
82
    <title>DESCRIPTION</title>
59
83
    <para>
71
95
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
72
96
      to provide comments.
73
97
    </para>
74
 
    
 
98
 
75
99
  </refsect1>
76
100
  <refsect1>
77
101
    <title>OPTIONS</title>
78
102
    
79
103
    <variablelist>
80
104
      <varlistentry>
81
 
        <term><option>interface<literal> = </literal><replaceable
82
 
        >NAME</replaceable></option></term>
 
105
        <term><varname>interface</varname></term>
83
106
        <listitem>
 
107
          <synopsis><literal>interface = </literal><replaceable
 
108
          >NAME</replaceable>
 
109
          </synopsis>
84
110
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
111
        </listitem>
86
112
      </varlistentry>
87
 
      
 
113
 
88
114
      <varlistentry>
89
 
        <term><option>address<literal> = </literal><replaceable
90
 
          >ADDRESS</replaceable></option></term>
 
115
        <term><varname>address</varname></term>
91
116
        <listitem>
 
117
          <synopsis><literal>address = </literal><replaceable
 
118
          >ADDRESS</replaceable>
 
119
          </synopsis>
92
120
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
121
        </listitem>
94
122
      </varlistentry>
95
 
      
 
123
 
96
124
      <varlistentry>
97
 
        <term><option>port<literal> = </literal><replaceable
98
 
        >NUMBER</replaceable></option></term>
 
125
        <term><varname>port</varname></term>
99
126
        <listitem>
 
127
          <synopsis><literal>port = </literal><replaceable
 
128
          >NUMBER</replaceable>
 
129
          </synopsis>
100
130
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
131
        </listitem>
102
132
      </varlistentry>
103
 
      
 
133
 
104
134
      <varlistentry>
105
 
        <term><option>debug<literal> = </literal>{ <literal
 
135
        <term><varname>debug</varname></term>
 
136
        <listitem>
 
137
          <synopsis><literal>debug = </literal>{ <literal
106
138
          >1</literal> | <literal>yes</literal> | <literal
107
139
          >true</literal> | <literal>on</literal> | <literal
108
140
          >0</literal> | <literal>no</literal> | <literal
109
 
          >false</literal> | <literal>off</literal> }</option></term>
110
 
        <listitem>
 
141
          >false</literal> | <literal>off</literal> }
 
142
          </synopsis>
111
143
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
144
        </listitem>
113
145
      </varlistentry>
114
 
      
 
146
 
115
147
      <varlistentry>
116
 
        <term><option>priority<literal> = </literal><replaceable
117
 
        >STRING</replaceable></option></term>
 
148
        <term><varname>priority</varname></term>
118
149
        <listitem>
 
150
          <synopsis><literal>priority = </literal><replaceable
 
151
          >STRING</replaceable>
 
152
          </synopsis>
119
153
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
154
        </listitem>
121
155
      </varlistentry>
122
 
      
 
156
 
123
157
      <varlistentry>
124
 
        <term><option>servicename<literal> = </literal
125
 
        ><replaceable>NAME</replaceable></option></term>
 
158
        <term><varname>servicename</varname></term>
126
159
        <listitem>
 
160
          <synopsis><literal>servicename = </literal><replaceable
 
161
          >NAME</replaceable>
 
162
          </synopsis>
127
163
          <xi:include href="mandos-options.xml"
128
164
                      xpointer="servicename"/>
129
165
        </listitem>
144
180
    <para>
145
181
      The <literal>[DEFAULT]</literal> is necessary because the Python
146
182
      built-in module <systemitem class="library">ConfigParser</systemitem>
147
 
      requires it.
 
183
      requres it.
148
184
    </para>
149
185
  </refsect1>
150
186
  
178
214
  <refsect1 id="see_also">
179
215
    <title>SEE ALSO</title>
180
216
    <para>
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>
 
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>
187
224
    </para>
188
 
    
 
225
 
189
226
    <variablelist>
190
227
      <varlistentry>
191
228
        <term>