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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-09 04:56:00 UTC
  • mfrom: (24.1.27 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080809045600-m7jx3tj4wwunaffa
Merge.

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' rep='repeat'>OPTION</arg>
 
77
    </cmdsynopsis>
 
78
  </refsynopsisdiv>
 
79
 
 
80
  <refsect1 id="description">
 
81
    <title>DESCRIPTION</title>
 
82
    <para>
 
83
      <command>&COMMANDNAME;</command> is a server daemon that handels
 
84
      incomming passwords request for passwords. Mandos use avahi to
 
85
      announce the service, and through gnutls authenticates
 
86
      clients. Any authenticated client is then given its encrypted
 
87
      password.
 
88
    </para>
 
89
 
 
90
    <variablelist>
 
91
      <varlistentry>
 
92
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
93
        <listitem>
 
94
          <para>
 
95
            show a help message and exit
 
96
          </para>
 
97
        </listitem>
 
98
      </varlistentry>
 
99
 
 
100
      <varlistentry>
 
101
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
102
        IF</replaceable></literal></term>
 
103
        <listitem>
 
104
          <para>
 
105
            Bind to interface IF
 
106
          </para>
 
107
        </listitem>
 
108
      </varlistentry>      
 
109
 
 
110
      <varlistentry>
 
111
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
112
        ADDRESS</replaceable></literal></term>
 
113
        <listitem>
 
114
          <para>
 
115
            Address to listen for requests on
 
116
          </para>
 
117
        </listitem>
 
118
      </varlistentry>          
 
119
 
 
120
      <varlistentry>
 
121
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
122
        PORT</replaceable></literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Port number to receive requests on
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>          
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>--check</literal></term>
 
132
        <listitem>
 
133
          <para>
 
134
            Run self-test on the server
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>      
 
138
 
 
139
      <varlistentry>
 
140
        <term><literal>--debug</literal></term>
 
141
        <listitem>
 
142
          <para>
 
143
            Debug mode
 
144
          </para>
 
145
        </listitem>
 
146
      </varlistentry>
 
147
 
 
148
      <varlistentry>
 
149
        <term><literal>--priority <replaceable>
 
150
        PRIORITY</replaceable></literal></term>
 
151
        <listitem>
 
152
          <para>
 
153
            GnuTLS priority string. See <citerefentry>
 
154
            <refentrytitle>gnutls_priority_init</refentrytitle>
 
155
            <manvolnum>3</manvolnum></citerefentry>
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>      
 
159
 
 
160
      <varlistentry>
 
161
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
162
        </literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Zeroconf service name
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>     
 
169
 
 
170
      <varlistentry>
 
171
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
172
        </literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            Directory to search for configuration files
 
176
          </para>
 
177
        </listitem>
 
178
      </varlistentry>
 
179
      
 
180
    </variablelist>
 
181
  </refsect1>
 
182
</refentry>