/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/xsl"
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY VERSION "1.0">
<!ENTITY COMMANDNAME "password-prompt">
]>

<refentry>
  <refentryinfo>
    <title>&COMMANDNAME;</title>
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
    <productname>&COMMANDNAME;</productname>
    <productnumber>&VERSION;</productnumber>
    <authorgroup>
      <author>
	<firstname>Björn</firstname>
	<surname>Påhlsson</surname>
	<address>
	  <email>belorn@fukt.bsnet.se</email>
	</address>
      </author>
      <author>
	<firstname>Teddy</firstname>
	<surname>Hogeborn</surname>
	<address>
	  <email>teddy@fukt.bsnet.se</email>
	</address>
      </author>
    </authorgroup>
    <copyright>
      <year>2008</year>
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
    </copyright>
    <legalnotice>
      <para>
	This manual page is free software: you can redistribute it
	and/or modify it under the terms of the GNU General Public
	License as published by the Free Software Foundation,
	either version 3 of the License, or (at your option) any
	later version.
      </para>

      <para>
	This manual page is distributed in the hope that it will
	be useful, but WITHOUT ANY WARRANTY; without even the
	implied warranty of MERCHANTABILITY or FITNESS FOR A
	PARTICULAR PURPOSE.  See the GNU General Public License
	for more details.
      </para>

      <para>
	You should have received a copy of the GNU General Public
	License along with this program; If not, see
	<ulink url="http://www.gnu.org/licenses/"/>.
      </para>
    </legalnotice>
  </refentryinfo>

  <refmeta>
    <refentrytitle>&COMMANDNAME;</refentrytitle>
    <manvolnum>8mandos</manvolnum>
  </refmeta>
  
  <refnamediv>
    <refname><command>&COMMANDNAME;</command></refname>
    <refpurpose>
      Passprompt for luks during boot sequence
    </refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='opt'>--prefix<arg choice='plain'>PREFIX</arg></arg>
      <arg choice='opt'>--debug</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='plain'>--help</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='plain'>--usage</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <arg choice='plain'>--version</arg>
    </cmdsynopsis>    
  </refsynopsisdiv>

  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>
      <command>&COMMANDNAME;</command> is a terminal program that ask for
      passwords during boot sequence. It is a plugin to
      <firstterm>mandos</firstterm>, and is used as a fallback and
      alternative to retriving passwords from a mandos server. During
      boot sequence the user is prompted for the disk password, and
      when a password is given it then gets forwarded to
      <acronym>LUKS</acronym>.
    </para>

    <variablelist>
      <varlistentry>
	<term><literal>-p</literal>, <literal>--prefix=<replaceable>PREFIX
	</replaceable></literal></term>
	<listitem>
	  <para>
	    Prefix used before the passprompt
	  </para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><literal>--debug</literal></term>
	<listitem>
	  <para>
	    Debug mode
	  </para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><literal>-?</literal>, <literal>--help</literal></term>
	<listitem>
	  <para>
	    Gives a help message
	  </para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term><literal>--usage</literal></term>
	<listitem>
	  <para>
	    Gives a short usage message
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-V</literal>, <literal>--version</literal></term>
	<listitem>
	  <para>
	    Prints the program version
	  </para>
	</listitem>
      </varlistentry>            
    </variablelist>
  </refsect1>
</refentry>