/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
24.1.23 by Björn Påhlsson
Added manual pages for:
1
<?xml version='1.0' encoding='UTF-8'?>
2
<?xml-stylesheet type="text/xsl"
3
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
<!ENTITY VERSION "1.0">
7
<!ENTITY COMMANDNAME "mandos">
8
]>
9
10
<refentry>
11
  <refentryinfo>
12
    <title>&COMMANDNAME;</title>
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
    <productname>&COMMANDNAME;</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>
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
35
    </copyright>
36
    <legalnotice>
37
      <para>
38
	This manual page is free software: you can redistribute it
39
	and/or modify it under the terms of the GNU General Public
40
	License as published by the Free Software Foundation,
41
	either version 3 of the License, or (at your option) any
42
	later version.
43
      </para>
44
45
      <para>
46
	This manual page is distributed in the hope that it will
47
	be useful, but WITHOUT ANY WARRANTY; without even the
48
	implied warranty of MERCHANTABILITY or FITNESS FOR A
49
	PARTICULAR PURPOSE.  See the GNU General Public License
50
	for more details.
51
      </para>
52
53
      <para>
54
	You should have received a copy of the GNU General Public
55
	License along with this program; If not, see
56
	<ulink url="http://www.gnu.org/licenses/"/>.
57
      </para>
58
    </legalnotice>
59
  </refentryinfo>
60
61
  <refmeta>
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
24.1.24 by Björn Påhlsson
minor edits
63
    <manvolnum>8</manvolnum>
24.1.23 by Björn Påhlsson
Added manual pages for:
64
  </refmeta>
65
  
66
  <refnamediv>
67
    <refname><command>&COMMANDNAME;</command></refname>
68
    <refpurpose>
69
      Sends encrypted passwords to authenticated mandos clients
70
    </refpurpose>
71
  </refnamediv>
72
73
  <refsynopsisdiv>
74
    <cmdsynopsis>
75
      <command>&COMMANDNAME;</command>
24.1.33 by Björn Påhlsson
synopsis changed
76
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
77
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
78
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
79
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
80
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
81
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
82
      <arg choice='opt'>--debug</arg>
83
    </cmdsynopsis>
84
    <cmdsynopsis>
85
      <command>&COMMANDNAME;</command>
86
      <arg choice='plain'>--help</arg>
87
    </cmdsynopsis>
88
    <cmdsynopsis>
89
      <command>&COMMANDNAME;</command>
24.1.35 by Björn Påhlsson
version 1.0
90
      <arg choice='plain'>--version</arg>
91
    </cmdsynopsis>
92
    <cmdsynopsis>
93
      <command>&COMMANDNAME;</command>
24.1.33 by Björn Påhlsson
synopsis changed
94
      <arg choice='plain'>--check</arg>
95
    </cmdsynopsis>    
24.1.23 by Björn Påhlsson
Added manual pages for:
96
  </refsynopsisdiv>
97
98
  <refsect1 id="description">
99
    <title>DESCRIPTION</title>
100
    <para>
101
      <command>&COMMANDNAME;</command> is a server daemon that handels
102
      incomming passwords request for passwords. Mandos use avahi to
103
      announce the service, and through gnutls authenticates
104
      clients. Any authenticated client is then given its encrypted
105
      password.
106
    </para>
107
108
    <variablelist>
109
      <varlistentry>
110
	<term><literal>-h</literal>, <literal>--help</literal></term>
111
	<listitem>
112
	  <para>
113
	    show a help message and exit
114
	  </para>
115
	</listitem>
116
      </varlistentry>
117
118
      <varlistentry>
119
	<term><literal>-i</literal>, <literal>--interface <replaceable>
120
	IF</replaceable></literal></term>
121
	<listitem>
122
	  <para>
123
	    Bind to interface IF
124
	  </para>
125
	</listitem>
126
      </varlistentry>      
127
128
      <varlistentry>
129
	<term><literal>-a</literal>, <literal>--address <replaceable>
130
	ADDRESS</replaceable></literal></term>
131
	<listitem>
132
	  <para>
133
	    Address to listen for requests on
134
	  </para>
135
	</listitem>
136
      </varlistentry>          
137
138
      <varlistentry>
139
	<term><literal>-p</literal>, <literal>--port <replaceable>
140
	PORT</replaceable></literal></term>
141
	<listitem>
142
	  <para>
143
	    Port number to receive requests on
144
	  </para>
145
	</listitem>
146
      </varlistentry>          
147
148
      <varlistentry>
149
	<term><literal>--check</literal></term>
150
	<listitem>
151
	  <para>
152
	    Run self-test on the server
153
	  </para>
154
	</listitem>
155
      </varlistentry>      
156
157
      <varlistentry>
158
	<term><literal>--debug</literal></term>
159
	<listitem>
160
	  <para>
161
	    Debug mode
162
	  </para>
163
	</listitem>
164
      </varlistentry>
165
166
      <varlistentry>
167
	<term><literal>--priority <replaceable>
168
	PRIORITY</replaceable></literal></term>
169
	<listitem>
170
	  <para>
171
	    GnuTLS priority string. See <citerefentry>
172
	    <refentrytitle>gnutls_priority_init</refentrytitle>
173
	    <manvolnum>3</manvolnum></citerefentry>
174
	  </para>
175
	</listitem>
176
      </varlistentry>      
177
178
      <varlistentry>
179
	<term><literal>--servicename <replaceable>NAME</replaceable>
180
	</literal></term>
181
	<listitem>
182
	  <para>
183
	    Zeroconf service name
184
	  </para>
185
	</listitem>
186
      </varlistentry>     
187
188
      <varlistentry>
189
	<term><literal>--configdir <replaceable>DIR</replaceable>
190
	</literal></term>
191
	<listitem>
192
	  <para>
193
	    Directory to search for configuration files
194
	  </para>
195
	</listitem>
196
      </varlistentry>
24.1.35 by Björn Påhlsson
version 1.0
197
198
      <varlistentry>
199
	<term><literal>--version</literal></term>
200
	<listitem>
201
	  <para>
202
	    Prints the program version
203
	  </para>
204
	</listitem>
205
      </varlistentry>      
24.1.23 by Björn Påhlsson
Added manual pages for:
206
      
207
    </variablelist>
208
  </refsect1>
209
</refentry>