/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.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-16 20:32:58 UTC
  • mfrom: (24.1.55 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080816203258-eq4by31vdgxkhs9g
* mandos-keygen.xml: New man page for mandos-keygen(8).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>
 
63
    <manvolnum>8</manvolnum>
 
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>
 
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>
 
90
      <arg choice='plain'>--version</arg>
 
91
    </cmdsynopsis>
 
92
    <cmdsynopsis>
 
93
      <command>&COMMANDNAME;</command>
 
94
      <arg choice='plain'>--check</arg>
 
95
    </cmdsynopsis>    
 
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
  </refsect1>  
 
108
  
 
109
  <refsect1 id="options">
 
110
    <title>OPTIONS</title>
 
111
 
 
112
    <variablelist>
 
113
      <varlistentry>
 
114
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
115
        <listitem>
 
116
          <para>
 
117
            show a help message and exit
 
118
          </para>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
 
 
122
      <varlistentry>
 
123
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
124
        IF</replaceable></literal></term>
 
125
        <listitem>
 
126
          <para>
 
127
            Bind to interface IF
 
128
          </para>
 
129
        </listitem>
 
130
      </varlistentry>      
 
131
 
 
132
      <varlistentry>
 
133
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
134
        ADDRESS</replaceable></literal></term>
 
135
        <listitem>
 
136
          <para>
 
137
            Address to listen for requests on
 
138
          </para>
 
139
        </listitem>
 
140
      </varlistentry>          
 
141
 
 
142
      <varlistentry>
 
143
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
144
        PORT</replaceable></literal></term>
 
145
        <listitem>
 
146
          <para>
 
147
            Port number to receive requests on
 
148
          </para>
 
149
        </listitem>
 
150
      </varlistentry>          
 
151
 
 
152
      <varlistentry>
 
153
        <term><literal>--check</literal></term>
 
154
        <listitem>
 
155
          <para>
 
156
            Run self-test on the server
 
157
          </para>
 
158
        </listitem>
 
159
      </varlistentry>      
 
160
 
 
161
      <varlistentry>
 
162
        <term><literal>--debug</literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Debug mode
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>
 
169
 
 
170
      <varlistentry>
 
171
        <term><literal>--priority <replaceable>
 
172
        PRIORITY</replaceable></literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            GnuTLS priority string. See <citerefentry>
 
176
            <refentrytitle>gnutls_priority_init</refentrytitle>
 
177
            <manvolnum>3</manvolnum></citerefentry>
 
178
          </para>
 
179
        </listitem>
 
180
      </varlistentry>      
 
181
 
 
182
      <varlistentry>
 
183
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
184
        </literal></term>
 
185
        <listitem>
 
186
          <para>
 
187
            Zeroconf service name
 
188
          </para>
 
189
        </listitem>
 
190
      </varlistentry>     
 
191
 
 
192
      <varlistentry>
 
193
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
194
        </literal></term>
 
195
        <listitem>
 
196
          <para>
 
197
            Directory to search for configuration files
 
198
          </para>
 
199
        </listitem>
 
200
      </varlistentry>
 
201
 
 
202
      <varlistentry>
 
203
        <term><literal>--version</literal></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Prints the program version
 
207
          </para>
 
208
        </listitem>
 
209
      </varlistentry>      
 
210
    </variablelist>
 
211
  </refsect1>
 
212
 
 
213
  <refsect1 id="exit_status">
 
214
    <title>EXIT STATUS</title>
 
215
    <para>
 
216
    </para>
 
217
  </refsect1>
 
218
 
 
219
  <refsect1 id="file">
 
220
    <title>FILES</title>
 
221
    <para>
 
222
    </para>
 
223
  </refsect1>  
 
224
 
 
225
  <refsect1 id="notes">
 
226
    <title>NOTES</title>
 
227
    <para>
 
228
    </para>
 
229
  </refsect1>
 
230
  
 
231
  <refsect1 id="bugs">
 
232
    <title>BUGS</title>
 
233
    <para>
 
234
    </para>
 
235
  </refsect1>  
 
236
 
 
237
  <refsect1 id="examples">
 
238
    <title>EXAMPLES</title>
 
239
    <para>
 
240
    </para>
 
241
  </refsect1>
 
242
 
 
243
  <refsect1 id="security">
 
244
    <title>SECURITY</title>
 
245
    <para>
 
246
    </para>
 
247
  </refsect1>
 
248
 
 
249
  <refsect1 id="see_also">
 
250
    <title>SEE ALSO</title>
 
251
    <para>
 
252
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
253
      <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
254
      <refentrytitle>password-request</refentrytitle>
 
255
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
 
256
      <refentrytitle>password-prompt</refentrytitle>
 
257
      <manvolnum>8mandos</manvolnum></citerefentry>
 
258
    </para>
 
259
  </refsect1>
 
260
  
 
261
</refentry>