/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-09-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): Improve wording.

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