/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
24.1.23 by Björn Påhlsson
Added manual pages for:
1
<?xml version='1.0' encoding='UTF-8'?>
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 VERSION "1.0">
5
<!ENTITY CONFNAME "mandos.conf">
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
24.1.23 by Björn Påhlsson
Added manual pages for:
8
]>
9
10
<refentry>
11
  <refentryinfo>
12
    <title>&CONFNAME;</title>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
24.1.23 by Björn Påhlsson
Added manual pages for:
14
    <productname>&CONFNAME;</productname>
15
    <productnumber>&VERSION;</productnumber>
16
    <authorgroup>
17
      <author>
18
	<firstname>Björn</firstname>
19
	<surname>Påhlsson</surname>
20
	<address>
21
	  <email>belorn@fukt.bsnet.se</email>
22
	</address>
23
      </author>
24
      <author>
25
	<firstname>Teddy</firstname>
26
	<surname>Hogeborn</surname>
27
	<address>
28
	  <email>teddy@fukt.bsnet.se</email>
29
	</address>
30
      </author>
31
    </authorgroup>
32
    <copyright>
33
      <year>2008</year>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
34
      <holder>Teddy Hogeborn</holder>
35
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
36
    </copyright>
37
    <legalnotice>
38
      <para>
39
	This manual page is free software: you can redistribute it
40
	and/or modify it under the terms of the GNU General Public
41
	License as published by the Free Software Foundation,
42
	either version 3 of the License, or (at your option) any
43
	later version.
44
      </para>
45
46
      <para>
47
	This manual page is distributed in the hope that it will
48
	be useful, but WITHOUT ANY WARRANTY; without even the
49
	implied warranty of MERCHANTABILITY or FITNESS FOR A
50
	PARTICULAR PURPOSE.  See the GNU General Public License
51
	for more details.
52
      </para>
53
54
      <para>
55
	You should have received a copy of the GNU General Public
56
	License along with this program; If not, see
57
	<ulink url="http://www.gnu.org/licenses/"/>.
58
      </para>
59
    </legalnotice>
60
  </refentryinfo>
61
62
  <refmeta>
63
    <refentrytitle>&CONFNAME;</refentrytitle>
64
    <manvolnum>5</manvolnum>
65
  </refmeta>
66
  
67
  <refnamediv>
68
    <refname><filename>&CONFNAME;</filename></refname>
69
    <refpurpose>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
70
      Configuration file for the Mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
71
    </refpurpose>
72
  </refnamediv>
73
74
  <refsynopsisdiv>
75
    <synopsis>
76
      &CONFPATH;
77
    </synopsis>
78
  </refsynopsisdiv>
79
80
  <refsect1 id="description">
81
    <title>DESCRIPTION</title>
82
    <para>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
83
      The file &CONFPATH; is a simple configuration file for
84
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
86
      startup.  The configuration file starts with
87
      <quote><literal>[DEFAULT]</literal></quote> on a line by itself,
88
      followed by any number of
89
      <quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
90
      entries, with continuations in the style of RFC 822.
91
      <quote><varname><replaceable>option</replaceable></varname>:
92
      <replaceable>value</replaceable></quote> is also accepted.  Note
93
      that leading whitespace is removed from values.  Lines beginning
94
      with <quote>#</quote> or <quote>;</quote> are ignored and may be
95
      used to provide comments.
24.1.23 by Björn Påhlsson
Added manual pages for:
96
    </para>
97
98
    <para>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
99
      The options are:
24.1.23 by Björn Påhlsson
Added manual pages for:
100
    </para>
101
102
    <variablelist>
103
      <varlistentry>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
104
	<term><literal><varname>interface</varname></literal></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
105
	<listitem>
106
	  <para>
107
	    This option allows you to override the default network
108
	    interfaces. By default mandos will not bind to any
109
	    specific interface but instead use default avahi-server
110
	    behaviour.
111
	  </para>
112
	</listitem>
113
      </varlistentry>
114
115
      <varlistentry>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
116
	<term><literal><varname>address</varname></literal></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
117
	<listitem>
118
	  <para>
119
	    This option allows you to override the default network
120
	    address. By default mandos will not bind to any
121
	    specific address but instead use default avahi-server
122
	    behaviour.
123
	  </para>
124
	</listitem>
125
      </varlistentry>      
126
127
      <varlistentry>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
128
	<term><literal><varname>port</varname></literal></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
129
	<listitem>
130
	  <para>
131
	    This option allows you to override the default port to
132
	    listen on. By default mandos will not specify any specific
133
	    port and instead use a random port given by the OS from
134
	    the use of INADDR_ANY.
135
	  </para>
136
	</listitem>
137
      </varlistentry>
138
139
      <varlistentry>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
140
	<term><literal><varname>debug</varname></literal></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
141
	<listitem>
142
	  <para>
143
	    This option allows you to modify debug mode with a true/false
144
	    boolean value. By default is debug set to <literal>false</literal>.
145
	  </para>
146
	</listitem>
147
      </varlistentry>      
148
149
      <varlistentry>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
150
	<term><literal><varname>priority</varname></literal></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
151
	<listitem>
152
	  <para>
153
	    This option allows you to override the default gnutls
154
	    priority that will be used in gnutls session. See
155
	    <citerefentry><refentrytitle>gnutls_priority_init
156
	    </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
157
	    more information on gnutls priority strings.
158
	  </para>	  
159
	</listitem>
160
      </varlistentry>
161
162
      <varlistentry>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
163
	<term><literal><varname>servicename</varname></literal></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
164
	<listitem>
165
	  <para>
166
	    This option allows you to override the default Zeroconf
167
	    service name use to announce mandos as a avahi service. By
168
	    default mandos will use "Mandos".
169
	  </para>
170
	</listitem>
171
      </varlistentry>
172
      
173
    </variablelist>
174
  </refsect1>
175
176
  <refsect1 id="examples">
177
    <title>EXAMPLES</title>
178
    <informalexample>
179
      <programlisting>
180
	[server]
181
	# A configuration example
182
	interface = eth0 
183
	address = 2001:DB8:
184
	port = 1025 
185
	debug = true 
186
	priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
187
	servicename = Mandos
188
      </programlisting>
189
    </informalexample>
190
  </refsect1>  
191
  
192
  <refsect1 id="files">
193
    <title>FILES</title>
194
    <para>
195
      The file described here is &CONFPATH;
196
    </para>
197
  </refsect1>
198
</refentry>