/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 plugins.d/password-prompt.xml

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 "password-prompt">
 
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
      Passprompt for luks during boot sequence
 
70
    </refpurpose>
 
71
  </refnamediv>
 
72
  
 
73
  <refsynopsisdiv>
 
74
    <cmdsynopsis>
 
75
      <command>&COMMANDNAME;</command>
 
76
      <arg choice='opt'>--prefix<arg choice='plain'>PREFIX</arg></arg>
 
77
      <arg choice='opt'>--debug</arg>
 
78
    </cmdsynopsis>
 
79
    <cmdsynopsis>
 
80
      <command>&COMMANDNAME;</command>
 
81
      <arg choice='plain'>--help</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg choice='plain'>--usage</arg>
 
86
    </cmdsynopsis>
 
87
    <cmdsynopsis>
 
88
      <command>&COMMANDNAME;</command>
 
89
      <arg choice='plain'>--version</arg>
 
90
    </cmdsynopsis>    
 
91
  </refsynopsisdiv>
 
92
 
 
93
  <refsect1 id="description">
 
94
    <title>DESCRIPTION</title>
 
95
    <para>
 
96
      <command>&COMMANDNAME;</command> is a terminal program that ask for
 
97
      passwords during boot sequence. It is a plugin to
 
98
      <firstterm>mandos</firstterm>, and is used as a fallback and
 
99
      alternative to retriving passwords from a mandos server. During
 
100
      boot sequence the user is prompted for the disk password, and
 
101
      when a password is given it then gets forwarded to
 
102
      <acronym>LUKS</acronym>.
 
103
    </para>
 
104
  </refsect1>
 
105
  
 
106
  <refsect1 id="options">
 
107
    <title>OPTIONS</title>
 
108
    <para>
 
109
      Commonly not invoked as command lines but from configuration
 
110
      file of plugin runner.
 
111
    </para>
 
112
 
 
113
    <variablelist>
 
114
      <varlistentry>
 
115
        <term><literal>-p</literal>, <literal>--prefix=<replaceable>PREFIX
 
116
        </replaceable></literal></term>
 
117
        <listitem>
 
118
          <para>
 
119
            Prefix used before the passprompt
 
120
          </para>
 
121
        </listitem>
 
122
      </varlistentry>
 
123
      
 
124
      <varlistentry>
 
125
        <term><literal>--debug</literal></term>
 
126
        <listitem>
 
127
          <para>
 
128
            Debug mode
 
129
          </para>
 
130
        </listitem>
 
131
      </varlistentry>
 
132
      
 
133
      <varlistentry>
 
134
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
135
        <listitem>
 
136
          <para>
 
137
            Gives a help message
 
138
          </para>
 
139
        </listitem>
 
140
      </varlistentry>
 
141
      
 
142
      <varlistentry>
 
143
        <term><literal>--usage</literal></term>
 
144
        <listitem>
 
145
          <para>
 
146
            Gives a short usage message
 
147
          </para>
 
148
        </listitem>
 
149
      </varlistentry>
 
150
 
 
151
      <varlistentry>
 
152
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Prints the program version
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>            
 
159
    </variablelist>
 
160
  </refsect1>
 
161
 
 
162
  <refsect1 id="exit_status">
 
163
    <title>EXIT STATUS</title>
 
164
    <para>
 
165
    </para>
 
166
  </refsect1>
 
167
 
 
168
  <refsect1 id="environment">
 
169
    <title>ENVIRONMENT</title>
 
170
    <para>
 
171
    </para>
 
172
  </refsect1>
 
173
 
 
174
  <refsect1 id="files">
 
175
    <title>FILES</title>
 
176
    <para>
 
177
    </para>
 
178
  </refsect1>
 
179
  
 
180
  <refsect1 id="bugs">
 
181
    <title>BUGS</title>
 
182
    <para>
 
183
    </para>
 
184
  </refsect1>  
 
185
 
 
186
  <refsect1 id="example">
 
187
    <title>EXAMPLE</title>
 
188
    <para>
 
189
    </para>
 
190
  </refsect1>
 
191
 
 
192
  <refsect1 id="security">
 
193
    <title>SECURITY</title>
 
194
    <para>
 
195
    </para>
 
196
  </refsect1>
 
197
 
 
198
  <refsect1 id="see_also">
 
199
    <title>SEE ALSO</title>
 
200
    <para>
 
201
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
202
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
203
      <refentrytitle>plugin-runner</refentrytitle>
 
204
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
 
205
      <refentrytitle>password-request</refentrytitle>
 
206
      <manvolnum>8mandos</manvolnum></citerefentry>
 
207
    </para>
 
208
  </refsect1>  
 
209
  
 
210
</refentry>