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

synopsis changed

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-client.xml
 
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-client">
 
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>8mandos</manvolnum>
 
64
  </refmeta>
 
65
  
 
66
  <refnamediv>
 
67
    <refname><command>&COMMANDNAME;</command></refname>
 
68
    <refpurpose>
 
69
      get password for encrypted rootdisk
 
70
    </refpurpose>
 
71
  </refnamediv>
 
72
 
 
73
  <refsynopsisdiv>
 
74
    <cmdsynopsis>
 
75
      <command>&COMMANDNAME;</command>
 
76
      <arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
 
77
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
 
78
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
 
79
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
 
80
      <arg choice='opt'>--userpid<arg choice='plain'>ID</arg></arg>
 
81
      <arg choice='opt'>--plugin-dir<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'>--usage</arg>
 
91
    </cmdsynopsis>
 
92
    <cmdsynopsis>
 
93
      <command>&COMMANDNAME;</command>
 
94
      <arg choice='plain'>--version</arg>
 
95
    </cmdsynopsis>    
 
96
  </refsynopsisdiv>
 
97
 
 
98
  <refsect1 id="description">
 
99
    <title>DESCRIPTION</title>
 
100
    <para>
 
101
      <command>&COMMANDNAME;</command> is a plugin runner that waits
 
102
      for any of its plugins to return sucessfull with a password, and
 
103
      passes it to cryptsetup. plugins is defined as any executables
 
104
      in the plugins directory will by default will be
 
105
      /conf/conf.d/mandos/plugins.d.  to stdout.
 
106
    </para>
 
107
 
 
108
    <variablelist>
 
109
      <varlistentry>
 
110
        <term><literal>-g</literal>,<literal>--global-options
 
111
        <replaceable>OPTIONS</replaceable></literal></term>
 
112
        <listitem>
 
113
          <para>
 
114
            Global options given to all plugins as additional start
 
115
            arguments.  Options are specified with a -o flag followed
 
116
            by a comma separated string of options.
 
117
          </para>         
 
118
        </listitem>
 
119
      </varlistentry>
 
120
 
 
121
      <varlistentry>
 
122
        <term><literal>-o</literal>,<literal> --options-for
 
123
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
124
        </literal></term>
 
125
        <listitem>
 
126
          <para>
 
127
            Plugin specific options given to the plugin as additional
 
128
            start arguments.  Options are specified with a -o flag
 
129
            followed by a comma separated string of options.
 
130
          </para>         
 
131
        </listitem>
 
132
      </varlistentry>      
 
133
 
 
134
      <varlistentry>
 
135
        <term><literal>-d</literal>,<literal> --disable
 
136
        <replaceable>PLUGIN</replaceable>
 
137
        </literal></term>
 
138
        <listitem>
 
139
          <para>
 
140
            Disable a specific plugin
 
141
          </para>         
 
142
        </listitem>
 
143
      </varlistentry>
 
144
 
 
145
      <varlistentry>
 
146
        <term><literal>--groupid <replaceable>ID</replaceable>
 
147
        </literal></term>
 
148
        <listitem>
 
149
          <para>
 
150
            Group ID the plugins will run as
 
151
          </para>
 
152
        </listitem>
 
153
      </varlistentry>      
 
154
 
 
155
      <varlistentry>
 
156
        <term><literal>--userid <replaceable>ID</replaceable>
 
157
        </literal></term>
 
158
        <listitem>
 
159
          <para>
 
160
            User ID the plugins will run as
 
161
          </para>
 
162
        </listitem>
 
163
      </varlistentry>      
 
164
 
 
165
      <varlistentry>
 
166
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
167
        </literal></term>
 
168
        <listitem>
 
169
          <para>
 
170
            Specify a different plugin directory
 
171
          </para>
 
172
        </listitem>
 
173
      </varlistentry>       
 
174
      
 
175
      <varlistentry>
 
176
        <term><literal>--debug</literal></term>
 
177
        <listitem>
 
178
          <para>
 
179
            Debug mode
 
180
          </para>
 
181
        </listitem>
 
182
      </varlistentry>
 
183
      
 
184
      <varlistentry>
 
185
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
186
        <listitem>
 
187
          <para>
 
188
            Gives a help message
 
189
          </para>
 
190
        </listitem>
 
191
      </varlistentry>
 
192
      
 
193
      <varlistentry>
 
194
        <term><literal>--usage</literal></term>
 
195
        <listitem>
 
196
          <para>
 
197
            Gives a short usage message
 
198
          </para>
 
199
        </listitem>
 
200
      </varlistentry>
 
201
 
 
202
      <varlistentry>
 
203
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Prints the program version
 
207
          </para>
 
208
        </listitem>
 
209
      </varlistentry>            
 
210
    </variablelist>
 
211
  </refsect1>
 
212
</refentry>