/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
1
<?xml version="1.0" encoding="UTF-8"?>
24.1.23 by Björn Påhlsson
Added manual pages for:
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY CONFNAME "mandos.conf">
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
237.2.9 by Teddy Hogeborn
* README: Update copyright year; add "2009".
6
<!ENTITY TIMESTAMP "2009-01-04">
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
24.1.23 by Björn Påhlsson
Added manual pages for:
9
]>
10
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
12
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
13
    <title>Mandos Manual</title>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
15
    <productname>Mandos</productname>
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
16
    <productnumber>&version;</productnumber>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
17
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
18
    <authorgroup>
19
      <author>
20
	<firstname>Björn</firstname>
21
	<surname>Påhlsson</surname>
22
	<address>
23
	  <email>belorn@fukt.bsnet.se</email>
24
	</address>
25
      </author>
26
      <author>
27
	<firstname>Teddy</firstname>
28
	<surname>Hogeborn</surname>
29
	<address>
30
	  <email>teddy@fukt.bsnet.se</email>
31
	</address>
32
      </author>
33
    </authorgroup>
34
    <copyright>
35
      <year>2008</year>
237.2.9 by Teddy Hogeborn
* README: Update copyright year; add "2009".
36
      <year>2009</year>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
37
      <holder>Teddy Hogeborn</holder>
38
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
39
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
40
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
41
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
42
  
24.1.23 by Björn Påhlsson
Added manual pages for:
43
  <refmeta>
44
    <refentrytitle>&CONFNAME;</refentrytitle>
45
    <manvolnum>5</manvolnum>
46
  </refmeta>
47
  
48
  <refnamediv>
49
    <refname><filename>&CONFNAME;</filename></refname>
50
    <refpurpose>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
51
      Configuration file for the Mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
52
    </refpurpose>
53
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
54
  
24.1.23 by Björn Påhlsson
Added manual pages for:
55
  <refsynopsisdiv>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
56
    <synopsis>&CONFPATH;</synopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
57
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
58
  
24.1.23 by Björn Påhlsson
Added manual pages for:
59
  <refsect1 id="description">
60
    <title>DESCRIPTION</title>
61
    <para>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
62
      The file &CONFPATH; is a simple configuration file for
63
      <citerefentry><refentrytitle>mandos</refentrytitle>
64
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
65
      startup.  The configuration file starts with <quote><literal
66
      >[DEFAULT]</literal></quote> on a line by itself, followed by
67
      any number of <quote><varname><replaceable>option</replaceable
68
      ></varname>=<replaceable>value</replaceable></quote> entries,
69
      with continuations in the style of RFC 822.  <quote><varname
70
      ><replaceable>option</replaceable></varname>: <replaceable
71
      >value</replaceable></quote> is also accepted.  Note that
72
      leading whitespace is removed from values.  Lines beginning with
73
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
74
      to provide comments.
24.1.23 by Björn Påhlsson
Added manual pages for:
75
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
76
    
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
77
  </refsect1>
78
  <refsect1>
79
    <title>OPTIONS</title>
80
    
24.1.23 by Björn Påhlsson
Added manual pages for:
81
    <variablelist>
82
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
83
	<term><option>interface<literal> = </literal><replaceable
84
	>NAME</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
85
	<listitem>
86
	  <xi:include href="mandos-options.xml" xpointer="interface"/>
87
	</listitem>
88
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
89
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
90
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
91
	<term><option>address<literal> = </literal><replaceable
92
	  >ADDRESS</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
93
	<listitem>
94
	  <xi:include href="mandos-options.xml" xpointer="address"/>
95
	</listitem>
96
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
97
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
98
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
99
	<term><option>port<literal> = </literal><replaceable
100
	>NUMBER</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
101
	<listitem>
102
	  <xi:include href="mandos-options.xml" xpointer="port"/>
103
	</listitem>
104
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
105
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
106
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
107
	<term><option>debug<literal> = </literal>{ <literal
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
108
	  >1</literal> | <literal>yes</literal> | <literal
109
	  >true</literal> | <literal>on</literal> | <literal
110
	  >0</literal> | <literal>no</literal> | <literal
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
111
	  >false</literal> | <literal>off</literal> }</option></term>
112
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
113
	  <xi:include href="mandos-options.xml" xpointer="debug"/>
114
	</listitem>
115
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
116
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
117
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
118
	<term><option>priority<literal> = </literal><replaceable
119
	>STRING</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
120
	<listitem>
121
	  <xi:include href="mandos-options.xml" xpointer="priority"/>
122
	</listitem>
123
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
124
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
125
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
126
	<term><option>servicename<literal> = </literal
127
	><replaceable>NAME</replaceable></option></term>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
128
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
129
	  <xi:include href="mandos-options.xml"
130
		      xpointer="servicename"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
131
	</listitem>
132
      </varlistentry>
133
      
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
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
      
24.1.23 by Björn Påhlsson
Added manual pages for:
145
    </variablelist>
146
  </refsect1>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
147
  
148
  <refsect1 id="files">
149
    <title>FILES</title>
150
    <para>
151
      The file described here is &CONFPATH;
152
    </para>
153
  </refsect1>
154
  
155
  <refsect1 id="bugs">
156
    <title>BUGS</title>
157
    <para>
158
      The <literal>[DEFAULT]</literal> is necessary because the Python
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
159
      built-in module <systemitem class="library">ConfigParser</systemitem>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
160
      requires it.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
161
    </para>
162
  </refsect1>
163
  
164
  <refsect1 id="example">
165
    <title>EXAMPLE</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
166
    <informalexample>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
167
      <para>
168
	No options are actually required:
169
      </para>
170
      <programlisting>
171
[DEFAULT]
172
      </programlisting>
173
    </informalexample>
174
    <informalexample>
175
      <para>
176
	An example using all the options:
177
      </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
178
      <programlisting>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
179
[DEFAULT]
180
# A configuration example
181
interface = eth0
182
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
183
port = 1025
184
debug = true
185
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
186
servicename = Daena
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
187
use_dbus = False
24.1.23 by Björn Påhlsson
Added manual pages for:
188
      </programlisting>
189
    </informalexample>
190
  </refsect1>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
191
  
192
  <refsect1 id="see_also">
193
    <title>SEE ALSO</title>
194
    <para>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
195
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
196
      ><manvolnum>3</manvolnum></citerefentry>,
197
      <citerefentry><refentrytitle>mandos</refentrytitle>
198
      <manvolnum>8</manvolnum></citerefentry>,
199
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
200
      <manvolnum>5</manvolnum></citerefentry>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
201
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
202
    
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
203
    <variablelist>
204
      <varlistentry>
205
	<term>
206
	  RFC 4291: <citetitle>IP Version 6 Addressing
207
	  Architecture</citetitle>
208
	</term>
209
	<listitem>
210
	  <variablelist>
211
	    <varlistentry>
212
	      <term>Section 2.2: <citetitle>Text Representation of
213
	      Addresses</citetitle></term>
214
	      <listitem><para/></listitem>
215
	    </varlistentry>
216
	    <varlistentry>
217
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
218
	      Address</citetitle></term>
219
	      <listitem><para/></listitem>
220
	    </varlistentry>
221
	    <varlistentry>
222
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
223
	    Addresses</citetitle></term>
224
	    <listitem>
225
	      <para>
226
		The clients use IPv6 link-local addresses, which are
227
		immediately usable since a link-local addresses is
228
		automatically assigned to a network interfaces when it
229
		is brought up.
230
	      </para>
231
	    </listitem>
232
	    </varlistentry>
233
	  </variablelist>
234
	</listitem>
235
      </varlistentry>
236
      <varlistentry>
237
	<term>
238
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
239
	</term>
240
	<listitem>
241
	  <para>
242
	    Zeroconf is the network protocol standard used by clients
243
	    for finding the Mandos server on the local network.
244
	  </para>
245
	</listitem>
246
      </varlistentry>
247
    </variablelist>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
248
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
249
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
250
<!-- Local Variables: -->
251
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
252
<!-- time-stamp-end: "[\"']>" -->
253
<!-- time-stamp-format: "%:y-%02m-%02d" -->
254
<!-- End: -->