/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-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved 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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-01-04">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-30">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
    <title>Mandos Manual</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
40
 
    <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>
41
61
  </refentryinfo>
42
 
  
 
62
 
43
63
  <refmeta>
44
64
    <refentrytitle>&CONFNAME;</refentrytitle>
45
65
    <manvolnum>5</manvolnum>
51
71
      Configuration file for the Mandos server
52
72
    </refpurpose>
53
73
  </refnamediv>
54
 
  
 
74
 
55
75
  <refsynopsisdiv>
56
76
    <synopsis>&CONFPATH;</synopsis>
57
77
  </refsynopsisdiv>
58
 
  
 
78
 
59
79
  <refsect1 id="description">
60
80
    <title>DESCRIPTION</title>
61
81
    <para>
73
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
74
94
      to provide comments.
75
95
    </para>
76
 
    
 
96
 
77
97
  </refsect1>
78
98
  <refsect1>
79
99
    <title>OPTIONS</title>
86
106
          <xi:include href="mandos-options.xml" xpointer="interface"/>
87
107
        </listitem>
88
108
      </varlistentry>
89
 
      
 
109
 
90
110
      <varlistentry>
91
111
        <term><option>address<literal> = </literal><replaceable
92
112
          >ADDRESS</replaceable></option></term>
94
114
          <xi:include href="mandos-options.xml" xpointer="address"/>
95
115
        </listitem>
96
116
      </varlistentry>
97
 
      
 
117
 
98
118
      <varlistentry>
99
119
        <term><option>port<literal> = </literal><replaceable
100
120
        >NUMBER</replaceable></option></term>
102
122
          <xi:include href="mandos-options.xml" xpointer="port"/>
103
123
        </listitem>
104
124
      </varlistentry>
105
 
      
 
125
 
106
126
      <varlistentry>
107
127
        <term><option>debug<literal> = </literal>{ <literal
108
128
          >1</literal> | <literal>yes</literal> | <literal
113
133
          <xi:include href="mandos-options.xml" xpointer="debug"/>
114
134
        </listitem>
115
135
      </varlistentry>
116
 
      
 
136
 
117
137
      <varlistentry>
118
138
        <term><option>priority<literal> = </literal><replaceable
119
139
        >STRING</replaceable></option></term>
121
141
          <xi:include href="mandos-options.xml" xpointer="priority"/>
122
142
        </listitem>
123
143
      </varlistentry>
124
 
      
 
144
 
125
145
      <varlistentry>
126
146
        <term><option>servicename<literal> = </literal
127
147
        ><replaceable>NAME</replaceable></option></term>
131
151
        </listitem>
132
152
      </varlistentry>
133
153
      
134
 
      <varlistentry>
135
 
        <term><option>use_dbus<literal> = </literal>{ <literal
136
 
          >1</literal> | <literal>yes</literal> | <literal
137
 
          >true</literal> | <literal>on</literal> | <literal
138
 
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }</option></term>
140
 
        <listitem>
141
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
      
145
154
    </variablelist>
146
155
  </refsect1>
147
156
  
157
166
    <para>
158
167
      The <literal>[DEFAULT]</literal> is necessary because the Python
159
168
      built-in module <systemitem class="library">ConfigParser</systemitem>
160
 
      requires it.
 
169
      requres it.
161
170
    </para>
162
171
  </refsect1>
163
172
  
184
193
debug = true
185
194
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
186
195
servicename = Daena
187
 
use_dbus = False
188
196
      </programlisting>
189
197
    </informalexample>
190
198
  </refsect1>
199
207
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
200
208
      <manvolnum>5</manvolnum></citerefentry>
201
209
    </para>
202
 
    
 
210
 
203
211
    <variablelist>
204
212
      <varlistentry>
205
213
        <term>