/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
1
<?xml version="1.0" encoding="UTF-8"?>
24.1.23 by Björn Påhlsson
Added manual pages for:
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
<!ENTITY COMMANDNAME "password-prompt">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
6
<!ENTITY TIMESTAMP "2008-08-31">
24.1.23 by Björn Påhlsson
Added manual pages for:
7
]>
8
9
<refentry>
10
  <refentryinfo>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
11
    <title>Mandos Manual</title>
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
    <productname>Mandos</productname>
24.1.23 by Björn Påhlsson
Added manual pages for:
14
    <productnumber>&VERSION;</productnumber>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
15
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
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>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
34
      <holder>Teddy Hogeborn</holder>
35
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
36
    </copyright>
37
    <legalnotice>
38
      <para>
39
	This manual page is free software: you can redistribute it
40
	and/or modify it under the terms of the GNU General Public
41
	License as published by the Free Software Foundation,
42
	either version 3 of the License, or (at your option) any
43
	later version.
44
      </para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
45
      
24.1.23 by Björn Påhlsson
Added manual pages for:
46
      <para>
47
	This manual page is distributed in the hope that it will
48
	be useful, but WITHOUT ANY WARRANTY; without even the
49
	implied warranty of MERCHANTABILITY or FITNESS FOR A
50
	PARTICULAR PURPOSE.  See the GNU General Public License
51
	for more details.
52
      </para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
53
      
24.1.23 by Björn Påhlsson
Added manual pages for:
54
      <para>
55
	You should have received a copy of the GNU General Public
56
	License along with this program; If not, see
57
	<ulink url="http://www.gnu.org/licenses/"/>.
58
      </para>
59
    </legalnotice>
60
  </refentryinfo>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
61
  
24.1.23 by Björn Påhlsson
Added manual pages for:
62
  <refmeta>
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
    <manvolnum>8mandos</manvolnum>
65
  </refmeta>
66
  
67
  <refnamediv>
68
    <refname><command>&COMMANDNAME;</command></refname>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
69
    <refpurpose>Prompt for a password and output it.</refpurpose>
24.1.23 by Björn Påhlsson
Added manual pages for:
70
  </refnamediv>
24.1.33 by Björn Påhlsson
synopsis changed
71
  
24.1.23 by Björn Påhlsson
Added manual pages for:
72
  <refsynopsisdiv>
73
    <cmdsynopsis>
74
      <command>&COMMANDNAME;</command>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
75
      <group choice="opt">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
76
	<arg choice="plain"><option>--prefix <replaceable
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
77
	>PREFIX</replaceable></option></arg>
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
78
	<arg choice="plain"><option>-p </option><replaceable
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
79
	>PREFIX</replaceable></arg>
80
      </group>
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
81
      <sbr/>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
82
      <arg choice="opt"><option>--debug</option></arg>
83
    </cmdsynopsis>
84
    <cmdsynopsis>
85
      <command>&COMMANDNAME;</command>
86
      <group choice="req">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
87
	<arg choice="plain"><option>--help</option></arg>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
88
	<arg choice="plain"><option>-?</option></arg>
89
      </group>
90
    </cmdsynopsis>
91
    <cmdsynopsis>
92
      <command>&COMMANDNAME;</command>
93
      <arg choice="plain"><option>--usage</option></arg>
94
    </cmdsynopsis>
95
    <cmdsynopsis>
96
      <command>&COMMANDNAME;</command>
97
      <group choice="req">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
98
	<arg choice="plain"><option>--version</option></arg>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
99
	<arg choice="plain"><option>-V</option></arg>
100
      </group>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
101
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
102
  </refsynopsisdiv>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
103
  
24.1.23 by Björn Påhlsson
Added manual pages for:
104
  <refsect1 id="description">
105
    <title>DESCRIPTION</title>
106
    <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
107
      All <command>&COMMANDNAME;</command> does is prompt for a
108
      password and output any given password to standard output.  This
109
      is not very useful on its own.  This program is really meant to
110
      run as a plugin in the <application>Mandos</application>
111
      client-side system, where it is used as a fallback and
112
      alternative to retriving passwords from a <application
113
      >Mandos</application> server.
114
    </para>
115
    <para>
116
      This program is little more than a <citerefentry><refentrytitle
117
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>
118
      wrapper, although actual use of that function is not guaranteed
119
      or implied.
24.1.23 by Björn Påhlsson
Added manual pages for:
120
    </para>
24.1.55 by Björn Påhlsson
updated some partial manual pages
121
  </refsect1>
122
  
123
  <refsect1 id="options">
124
    <title>OPTIONS</title>
125
    <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
126
      This program is commonly not invoked from the command line; it
127
      is normally started by the <application>Mandos</application>
128
      plugin runner, see <citerefentry><refentrytitle
129
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
130
      </citerefentry>.  Any command line options this program accepts
131
      are therefore normally provided by the plugin runner, and not
132
      directly.
24.1.55 by Björn Påhlsson
updated some partial manual pages
133
    </para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
134
    
24.1.23 by Björn Påhlsson
Added manual pages for:
135
    <variablelist>
136
      <varlistentry>
126 by Teddy Hogeborn
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
137
	<term><option>--prefix=<replaceable
138
	>PREFIX</replaceable></option></term>
139
	<term><option>-p
140
	<replaceable>PREFIX</replaceable></option></term>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
141
	<listitem>
142
	  <para>
143
	    Prefix string shown before the password prompt.
144
	  </para>
145
	</listitem>
146
      </varlistentry>
147
      
148
      <varlistentry>
149
	<term><option>--debug</option></term>
150
	<listitem>
151
	  <para>
152
	    Enable debug mode.  This will enable a lot of output to
153
	    standard error about what the program is doing.  The
154
	    program will still perform all other functions normally.
155
	  </para>
156
	</listitem>
157
      </varlistentry>
158
      
159
      <varlistentry>
126 by Teddy Hogeborn
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
160
	<term><option>--help</option></term>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
161
	<term><option>-?</option></term>
162
	<listitem>
163
	  <para>
164
	    Gives a help message about options and their meanings.
165
	  </para>
166
	</listitem>
167
      </varlistentry>
168
      
169
      <varlistentry>
170
	<term><option>--usage</option></term>
171
	<listitem>
172
	  <para>
173
	    Gives a short usage message.
174
	  </para>
175
	</listitem>
176
      </varlistentry>
177
      
178
      <varlistentry>
126 by Teddy Hogeborn
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
179
	<term><option>--version</option></term>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
180
	<term><option>-V</option></term>
181
	<listitem>
182
	  <para>
183
	    Prints the program version.
24.1.23 by Björn Påhlsson
Added manual pages for:
184
	  </para>
185
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
186
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
187
    </variablelist>
188
  </refsect1>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
189
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
190
  <refsect1 id="exit_status">
191
    <title>EXIT STATUS</title>
192
    <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
193
      If exit status is 0, the output from the program is the password
194
      as it was read.  Otherwise, if exit status is other than 0, the
195
      program has encountered an error, and any output so far could be
196
      corrupt and/or truncated, and should therefore be ignored.
24.1.55 by Björn Påhlsson
updated some partial manual pages
197
    </para>
198
  </refsect1>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
199
  
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
200
  <refsect1 id="environment">
201
    <title>ENVIRONMENT</title>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
202
    <variablelist>
203
      <varlistentry>
204
	<term><envar>cryptsource</envar></term>
205
	<term><envar>crypttarget</envar></term>
206
	<listitem>
207
	  <para>
208
	    If set, these environment variables will be assumed to
209
	    contain the source device name and the target device
210
	    mapper name, respectively, and will be shown as part of
211
	    the prompt.
212
	</para>
213
	<para>
214
	  These variables will normally be inherited from
215
	  <citerefentry><refentrytitle>plugin-runner</refentrytitle>
216
	  <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
	  normally have inherited them from
218
	  <filename>/scripts/local-top/cryptroot</filename> in the
219
	  initial RAM disk environment, which will have set them from
220
	  parsing kernel arguments and
221
	  <filename>/conf/conf.d/cryptroot</filename> (also in the
222
	  initial RAM disk environment), which in turn will have been
223
	  created when the initial RAM disk image was created by
224
	  <filename
225
	  >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
226
	  extracting the information of the root file system from
227
	  <filename >/etc/crypttab</filename>.
228
	</para>
229
	<para>
230
	  This behavior is meant to exactly mirror the behavior of
231
	  <command>askpass</command>, the default password prompter.
232
	</para>
233
	</listitem>
234
      </varlistentry>
235
    </variablelist>
24.1.55 by Björn Påhlsson
updated some partial manual pages
236
  </refsect1>
237
  
238
  <refsect1 id="bugs">
239
    <title>BUGS</title>
240
    <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
241
      None are known at this time.
24.1.55 by Björn Påhlsson
updated some partial manual pages
242
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
243
  </refsect1>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
244
  
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
245
  <refsect1 id="example">
246
    <title>EXAMPLE</title>
24.1.55 by Björn Påhlsson
updated some partial manual pages
247
    <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
248
      Note that normally, command line options will not be given
249
      directly, but via options for the Mandos <citerefentry
250
      ><refentrytitle>plugin-runner</refentrytitle>
251
      <manvolnum>8mandos</manvolnum></citerefentry>.
24.1.55 by Björn Påhlsson
updated some partial manual pages
252
    </para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
253
    <informalexample>
254
      <para>
255
	Normal invocation needs no options:
256
      </para>
257
      <para>
258
	<userinput>&COMMANDNAME;</userinput>
259
      </para>
260
    </informalexample>
261
    <informalexample>
262
      <para>
263
	Show a prefix before the prompt; in this case, a host name.
264
	It might be useful to be reminded of which host needs a
265
	password, in case of KVM switches, etc.
266
      </para>
267
      <para>
268
269
<!-- do not wrap this line -->
270
<userinput>&COMMANDNAME; --prefix=host.example.org:</userinput>
271
272
      </para>
273
    </informalexample>
274
    <informalexample>
275
      <para>
276
	Run in debug mode.
277
      </para>
278
      <para>
279
	<!-- do not wrap this line -->
280
	<userinput>&COMMANDNAME; --debug</userinput>
281
      </para>
282
    </informalexample>
24.1.55 by Björn Påhlsson
updated some partial manual pages
283
  </refsect1>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
284
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
285
  <refsect1 id="security">
286
    <title>SECURITY</title>
287
    <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
288
      On its own, this program is very simple, and does not exactly
289
      present any security risks.  The one thing that could be
290
      considered worthy of note is this: This program is meant to be
291
      run by <citerefentry><refentrytitle
292
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
      </citerefentry>, and will, when run standalone, outside, in a
294
      normal environment, immediately output on its standard output
295
      any presumably secret password it just recieved.  Therefore,
296
      when running this program standalone (which should never
297
      normally be done), take care not to type in any real secret
298
      password by force of habit, since it would then immediately be
299
      shown as output.
300
    </para>
301
    <para>
302
      To further alleviate any risk of being locked out of a system,
303
      the <citerefentry><refentrytitle>plugin-runner</refentrytitle>
304
      <manvolnum>8mandos</manvolnum></citerefentry> has a fallback
305
      mode which does the same thing as this program, only with less
306
      features.
24.1.55 by Björn Påhlsson
updated some partial manual pages
307
    </para>
308
  </refsect1>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
309
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
310
  <refsect1 id="see_also">
311
    <title>SEE ALSO</title>
312
    <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
313
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
      <manvolnum>5</manvolnum></citerefentry>
315
      <citerefentry><refentrytitle>password-request</refentrytitle>
24.1.55 by Björn Påhlsson
updated some partial manual pages
316
      <manvolnum>8mandos</manvolnum></citerefentry>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
317
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
      <manvolnum>8mandos</manvolnum></citerefentry>,
24.1.55 by Björn Påhlsson
updated some partial manual pages
319
    </para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
320
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
321
</refentry>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
322
<!-- Local Variables: -->
323
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
324
<!-- time-stamp-end: "[\"']>" -->
325
<!-- time-stamp-format: "%:y-%02m-%02d" -->
326
<!-- End: -->