/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-09 15:56:13 UTC
  • mfrom: (24.1.29 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080809155613-pm1o10yh44nafc0g
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.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 "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' 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 terminal program that ask for
 
84
      passwords during boot sequence. It is a plugin to
 
85
      <firstterm>mandos</firstterm>, and is used as a fallback and
 
86
      alternative to retriving passwords from a mandos server. During
 
87
      boot sequence the user is prompted for the disk password, and
 
88
      when a password is given it then gets forwarded to
 
89
      <acronym>LUKS</acronym>.
 
90
    </para>
 
91
 
 
92
    <variablelist>
 
93
      <varlistentry>
 
94
        <term><literal>-p</literal>, <literal>--prefix=<replaceable>PREFIX
 
95
        </replaceable></literal></term>
 
96
        <listitem>
 
97
          <para>
 
98
            Prefix used before the passprompt
 
99
          </para>
 
100
        </listitem>
 
101
      </varlistentry>
 
102
      
 
103
      <varlistentry>
 
104
        <term><literal>--debug</literal></term>
 
105
        <listitem>
 
106
          <para>
 
107
            Debug mode
 
108
          </para>
 
109
        </listitem>
 
110
      </varlistentry>
 
111
      
 
112
      <varlistentry>
 
113
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
114
        <listitem>
 
115
          <para>
 
116
            Gives a help message
 
117
          </para>
 
118
        </listitem>
 
119
      </varlistentry>
 
120
      
 
121
      <varlistentry>
 
122
        <term><literal>--usage</literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Gives a short usage message
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
132
        <listitem>
 
133
          <para>
 
134
            Prints the program version
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>            
 
138
    </variablelist>
 
139
  </refsect1>
 
140
</refentry>