/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

  • Committer: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: (237.7.53 trunk)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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-08-31">
 
5
<!ENTITY TIMESTAMP "2011-08-08">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
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>
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>
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>
45
 
      
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>
53
 
      
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>
 
40
    <xi:include href="../legalnotice.xml"/>
60
41
  </refentryinfo>
61
42
  
62
43
  <refmeta>
105
86
    <title>DESCRIPTION</title>
106
87
    <para>
107
88
      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.
 
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.
114
97
    </para>
115
98
    <para>
116
99
      This program is little more than a <citerefentry><refentrytitle
134
117
    
135
118
    <variablelist>
136
119
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
 
120
        <term><option>--prefix=<replaceable
 
121
        >PREFIX</replaceable></option></term>
 
122
        <term><option>-p
 
123
        <replaceable>PREFIX</replaceable></option></term>
141
124
        <listitem>
142
125
          <para>
143
126
            Prefix string shown before the password prompt.
157
140
      </varlistentry>
158
141
      
159
142
      <varlistentry>
 
143
        <term><option>--help</option></term>
160
144
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
145
        <listitem>
163
146
          <para>
164
147
            Gives a help message about options and their meanings.
176
159
      </varlistentry>
177
160
      
178
161
      <varlistentry>
 
162
        <term><option>--version</option></term>
179
163
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
164
        <listitem>
182
165
          <para>
183
166
            Prints the program version.
201
184
    <title>ENVIRONMENT</title>
202
185
    <variablelist>
203
186
      <varlistentry>
204
 
        <term><envar>cryptsource</envar></term>
205
 
        <term><envar>crypttarget</envar></term>
 
187
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
188
        <term><envar>CRYPTTAB_NAME</envar></term>
206
189
        <listitem>
207
190
          <para>
208
191
            If set, these environment variables will be assumed to
216
199
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
200
          normally have inherited them from
218
201
          <filename>/scripts/local-top/cryptroot</filename> in the
219
 
          initial RAM disk environment, which will have set them from
220
 
          parsing kernel arguments and
 
202
          initial <acronym>RAM</acronym> disk environment, which will
 
203
          have set them from parsing kernel arguments and
221
204
          <filename>/conf/conf.d/cryptroot</filename> (also in the
222
205
          initial RAM disk environment), which in turn will have been
223
206
          created when the initial RAM disk image was created by
262
245
      <para>
263
246
        Show a prefix before the prompt; in this case, a host name.
264
247
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
 
248
        password, in case of <acronym>KVM</acronym> switches, etc.
266
249
      </para>
267
250
      <para>
268
251
 
292
275
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
276
      </citerefentry>, and will, when run standalone, outside, in a
294
277
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
 
278
      any presumably secret password it just received.  Therefore,
296
279
      when running this program standalone (which should never
297
280
      normally be done), take care not to type in any real secret
298
281
      password by force of habit, since it would then immediately be
310
293
  <refsect1 id="see_also">
311
294
    <title>SEE ALSO</title>
312
295
    <para>
 
296
      <citerefentry><refentrytitle>intro</refentrytitle>
 
297
      <manvolnum>8mandos</manvolnum></citerefentry>
313
298
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
299
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
300
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
316
301
      <manvolnum>8mandos</manvolnum></citerefentry>
317
302
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
303
      <manvolnum>8mandos</manvolnum></citerefentry>,