/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« 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
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-30">
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
76
    <synopsis>&CONFPATH;</synopsis>
55
77
  </refsynopsisdiv>
56
 
  
 
78
 
57
79
  <refsect1 id="description">
58
80
    <title>DESCRIPTION</title>
59
81
    <para>
71
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
72
94
      to provide comments.
73
95
    </para>
74
 
    
 
96
 
75
97
  </refsect1>
76
98
  <refsect1>
77
99
    <title>OPTIONS</title>
84
106
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
107
        </listitem>
86
108
      </varlistentry>
87
 
      
 
109
 
88
110
      <varlistentry>
89
111
        <term><option>address<literal> = </literal><replaceable
90
112
          >ADDRESS</replaceable></option></term>
92
114
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
115
        </listitem>
94
116
      </varlistentry>
95
 
      
 
117
 
96
118
      <varlistentry>
97
119
        <term><option>port<literal> = </literal><replaceable
98
120
        >NUMBER</replaceable></option></term>
100
122
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
123
        </listitem>
102
124
      </varlistentry>
103
 
      
 
125
 
104
126
      <varlistentry>
105
127
        <term><option>debug<literal> = </literal>{ <literal
106
128
          >1</literal> | <literal>yes</literal> | <literal
111
133
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
134
        </listitem>
113
135
      </varlistentry>
114
 
      
 
136
 
115
137
      <varlistentry>
116
138
        <term><option>priority<literal> = </literal><replaceable
117
139
        >STRING</replaceable></option></term>
119
141
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
142
        </listitem>
121
143
      </varlistentry>
122
 
      
 
144
 
123
145
      <varlistentry>
124
146
        <term><option>servicename<literal> = </literal
125
147
        ><replaceable>NAME</replaceable></option></term>
144
166
    <para>
145
167
      The <literal>[DEFAULT]</literal> is necessary because the Python
146
168
      built-in module <systemitem class="library">ConfigParser</systemitem>
147
 
      requires it.
 
169
      requres it.
148
170
    </para>
149
171
  </refsect1>
150
172
  
185
207
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
208
      <manvolnum>5</manvolnum></citerefentry>
187
209
    </para>
188
 
    
 
210
 
189
211
    <variablelist>
190
212
      <varlistentry>
191
213
        <term>