/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/password-prompt.xml

Merge from trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "password-prompt">
6
 
<!ENTITY TIMESTAMP "2008-09-01">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
83
86
    <title>DESCRIPTION</title>
84
87
    <para>
85
88
      All <command>&COMMANDNAME;</command> does is prompt for a
86
 
      password and output any given password to standard output.  This
87
 
      is not very useful on its own.  This program is really meant to
88
 
      run as a plugin in the <application>Mandos</application>
89
 
      client-side system, where it is used as a fallback and
90
 
      alternative to retriving passwords from a <application
91
 
      >Mandos</application> server.
 
89
      password and output any given password to standard output.
 
90
    </para>
 
91
    <para>
 
92
      This program is not very useful on its own.  This program is
 
93
      really meant to run as a plugin in the <application
 
94
      >Mandos</application> client-side system, where it is used as a
 
95
      fallback and alternative to retrieving passwords from a
 
96
      <application >Mandos</application> server.
92
97
    </para>
93
98
    <para>
94
99
      This program is little more than a <citerefentry><refentrytitle
179
184
    <title>ENVIRONMENT</title>
180
185
    <variablelist>
181
186
      <varlistentry>
182
 
        <term><envar>cryptsource</envar></term>
183
 
        <term><envar>crypttarget</envar></term>
 
187
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
188
        <term><envar>CRYPTTAB_NAME</envar></term>
184
189
        <listitem>
185
190
          <para>
186
191
            If set, these environment variables will be assumed to
240
245
      <para>
241
246
        Show a prefix before the prompt; in this case, a host name.
242
247
        It might be useful to be reminded of which host needs a
243
 
        password, in case of KVM switches, etc.
 
248
        password, in case of <acronym>KVM</acronym> switches, etc.
244
249
      </para>
245
250
      <para>
246
251
 
270
275
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
271
276
      </citerefentry>, and will, when run standalone, outside, in a
272
277
      normal environment, immediately output on its standard output
273
 
      any presumably secret password it just recieved.  Therefore,
 
278
      any presumably secret password it just received.  Therefore,
274
279
      when running this program standalone (which should never
275
280
      normally be done), take care not to type in any real secret
276
281
      password by force of habit, since it would then immediately be
288
293
  <refsect1 id="see_also">
289
294
    <title>SEE ALSO</title>
290
295
    <para>
 
296
      <citerefentry><refentrytitle>intro</refentrytitle>
 
297
      <manvolnum>8mandos</manvolnum></citerefentry>
291
298
      <citerefentry><refentrytitle>crypttab</refentrytitle>
292
299
      <manvolnum>5</manvolnum></citerefentry>
293
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
300
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
294
301
      <manvolnum>8mandos</manvolnum></citerefentry>
295
302
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
296
303
      <manvolnum>8mandos</manvolnum></citerefentry>,