/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-09-03 13:59:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903135958-k0he2xucqmx7nz4b
* plugins.d/password-request.xml (OPTIONS): Improved wording.
  (FILES): Add text about public and secret key files.
  (BUGS): Commented out.
  (EXAMPLE): Added examples.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">
4
5
<!ENTITY COMMANDNAME "password-prompt">
5
 
<!ENTITY TIMESTAMP "2017-02-23">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
34
      <holder>Teddy Hogeborn</holder>
45
35
      <holder>Björn Påhlsson</holder>
46
36
    </copyright>
93
83
    <title>DESCRIPTION</title>
94
84
    <para>
95
85
      All <command>&COMMANDNAME;</command> does is prompt for a
96
 
      password and output any given password to standard output.
97
 
    </para>
98
 
    <para>
99
 
      This program is not very useful on its own.  This program is
100
 
      really meant to run as a plugin in the <application
101
 
      >Mandos</application> client-side system, where it is used as a
102
 
      fallback and alternative to retrieving passwords from a
103
 
      <application >Mandos</application> server.
 
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.
104
92
    </para>
105
93
    <para>
106
94
      This program is little more than a <citerefentry><refentrytitle
191
179
    <title>ENVIRONMENT</title>
192
180
    <variablelist>
193
181
      <varlistentry>
194
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
195
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
182
        <term><envar>cryptsource</envar></term>
 
183
        <term><envar>crypttarget</envar></term>
196
184
        <listitem>
197
185
          <para>
198
186
            If set, these environment variables will be assumed to
227
215
  
228
216
  <refsect1 id="bugs">
229
217
    <title>BUGS</title>
230
 
    <xi:include href="../bugs.xml"/>
 
218
    <para>
 
219
      None are known at this time.
 
220
    </para>
231
221
  </refsect1>
232
222
  
233
223
  <refsect1 id="example">
250
240
      <para>
251
241
        Show a prefix before the prompt; in this case, a host name.
252
242
        It might be useful to be reminded of which host needs a
253
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
243
        password, in case of KVM switches, etc.
254
244
      </para>
255
245
      <para>
256
246
 
280
270
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
281
271
      </citerefentry>, and will, when run standalone, outside, in a
282
272
      normal environment, immediately output on its standard output
283
 
      any presumably secret password it just received.  Therefore,
 
273
      any presumably secret password it just recieved.  Therefore,
284
274
      when running this program standalone (which should never
285
275
      normally be done), take care not to type in any real secret
286
276
      password by force of habit, since it would then immediately be
298
288
  <refsect1 id="see_also">
299
289
    <title>SEE ALSO</title>
300
290
    <para>
301
 
      <citerefentry><refentrytitle>intro</refentrytitle>
302
 
      <manvolnum>8mandos</manvolnum></citerefentry>
303
291
      <citerefentry><refentrytitle>crypttab</refentrytitle>
304
292
      <manvolnum>5</manvolnum></citerefentry>
305
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
293
      <citerefentry><refentrytitle>password-request</refentrytitle>
306
294
      <manvolnum>8mandos</manvolnum></citerefentry>
307
295
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
308
296
      <manvolnum>8mandos</manvolnum></citerefentry>,