/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-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

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 "2008-09-30">
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>
36
35
      <holder>Teddy Hogeborn</holder>
37
36
      <holder>Björn Påhlsson</holder>
38
37
    </copyright>
39
 
    <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>
40
61
  </refentryinfo>
41
 
  
 
62
 
42
63
  <refmeta>
43
64
    <refentrytitle>&CONFNAME;</refentrytitle>
44
65
    <manvolnum>5</manvolnum>
50
71
      Configuration file for the Mandos server
51
72
    </refpurpose>
52
73
  </refnamediv>
53
 
  
 
74
 
54
75
  <refsynopsisdiv>
55
76
    <synopsis>&CONFPATH;</synopsis>
56
77
  </refsynopsisdiv>
57
 
  
 
78
 
58
79
  <refsect1 id="description">
59
80
    <title>DESCRIPTION</title>
60
81
    <para>
72
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
73
94
      to provide comments.
74
95
    </para>
75
 
    
 
96
 
76
97
  </refsect1>
77
98
  <refsect1>
78
99
    <title>OPTIONS</title>
85
106
          <xi:include href="mandos-options.xml" xpointer="interface"/>
86
107
        </listitem>
87
108
      </varlistentry>
88
 
      
 
109
 
89
110
      <varlistentry>
90
111
        <term><option>address<literal> = </literal><replaceable
91
112
          >ADDRESS</replaceable></option></term>
93
114
          <xi:include href="mandos-options.xml" xpointer="address"/>
94
115
        </listitem>
95
116
      </varlistentry>
96
 
      
 
117
 
97
118
      <varlistentry>
98
119
        <term><option>port<literal> = </literal><replaceable
99
120
        >NUMBER</replaceable></option></term>
101
122
          <xi:include href="mandos-options.xml" xpointer="port"/>
102
123
        </listitem>
103
124
      </varlistentry>
104
 
      
 
125
 
105
126
      <varlistentry>
106
127
        <term><option>debug<literal> = </literal>{ <literal
107
128
          >1</literal> | <literal>yes</literal> | <literal
112
133
          <xi:include href="mandos-options.xml" xpointer="debug"/>
113
134
        </listitem>
114
135
      </varlistentry>
115
 
      
 
136
 
116
137
      <varlistentry>
117
138
        <term><option>priority<literal> = </literal><replaceable
118
139
        >STRING</replaceable></option></term>
120
141
          <xi:include href="mandos-options.xml" xpointer="priority"/>
121
142
        </listitem>
122
143
      </varlistentry>
123
 
      
 
144
 
124
145
      <varlistentry>
125
146
        <term><option>servicename<literal> = </literal
126
147
        ><replaceable>NAME</replaceable></option></term>
145
166
    <para>
146
167
      The <literal>[DEFAULT]</literal> is necessary because the Python
147
168
      built-in module <systemitem class="library">ConfigParser</systemitem>
148
 
      requires it.
 
169
      requres it.
149
170
    </para>
150
171
  </refsect1>
151
172
  
186
207
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
187
208
      <manvolnum>5</manvolnum></citerefentry>
188
209
    </para>
189
 
    
 
210
 
190
211
    <variablelist>
191
212
      <varlistentry>
192
213
        <term>