/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: Teddy Hogeborn
  • Date: 2008-09-30 07:23:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930072339-jn15gyrtfpdk2dhx
* .bzrignore: Added "man" directory (created by "make install-html").

* Makefile: Add "common.ent" dependency to all manual pages.
  (htmldir, version, SED): New variables.
  (CFLAGS): Add -D option to define VERSION to $(version).
  (MANPOST, HTMLPOST): Use $(SED).
  (PROGS): Use $(CPROGS)
  (CPROGS): New; C-only programs.
  (objects): Use $(CPROGS).
  (common.ent, mandos, mandos-keygen): New targets; update version
                                       number to $(version).
  (clean): Use $(CPROGS).
  (check): Depend on "all".
  (install-html): Install to $(htmldir).

* common.ent: New file with "version" entity.

* mandos-clients.conf.xml: Use "common.ent".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.xml: - '' -

* plugin-runner.c (argp_program_version): Use VERSION.
* plugins.d/mandos-client.c (argp_program_version): - '' -
* plugins.d/password-prompt.c (argp_program_version): - '' -

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 "2008-09-30">
 
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>
34
35
      <holder>Teddy Hogeborn</holder>
35
36
      <holder>Björn Påhlsson</holder>
36
37
    </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>
 
38
    <xi:include href="../legalnotice.xml"/>
60
39
  </refentryinfo>
61
40
  
62
41
  <refmeta>
109
88
      is not very useful on its own.  This program is really meant to
110
89
      run as a plugin in the <application>Mandos</application>
111
90
      client-side system, where it is used as a fallback and
112
 
      alternative to retriving passwords from a <application
 
91
      alternative to retrieving passwords from a <application
113
92
      >Mandos</application> server.
114
93
    </para>
115
94
    <para>
134
113
    
135
114
    <variablelist>
136
115
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
 
116
        <term><option>--prefix=<replaceable
 
117
        >PREFIX</replaceable></option></term>
 
118
        <term><option>-p
 
119
        <replaceable>PREFIX</replaceable></option></term>
141
120
        <listitem>
142
121
          <para>
143
122
            Prefix string shown before the password prompt.
157
136
      </varlistentry>
158
137
      
159
138
      <varlistentry>
 
139
        <term><option>--help</option></term>
160
140
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
141
        <listitem>
163
142
          <para>
164
143
            Gives a help message about options and their meanings.
176
155
      </varlistentry>
177
156
      
178
157
      <varlistentry>
 
158
        <term><option>--version</option></term>
179
159
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
160
        <listitem>
182
161
          <para>
183
162
            Prints the program version.
216
195
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
196
          normally have inherited them from
218
197
          <filename>/scripts/local-top/cryptroot</filename> in the
219
 
          initial RAM disk environment, which will have set them from
220
 
          parsing kernel arguments and
 
198
          initial <acronym>RAM</acronym> disk environment, which will
 
199
          have set them from parsing kernel arguments and
221
200
          <filename>/conf/conf.d/cryptroot</filename> (also in the
222
201
          initial RAM disk environment), which in turn will have been
223
202
          created when the initial RAM disk image was created by
262
241
      <para>
263
242
        Show a prefix before the prompt; in this case, a host name.
264
243
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
 
244
        password, in case of <acronym>KVM</acronym> switches, etc.
266
245
      </para>
267
246
      <para>
268
247
 
292
271
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
272
      </citerefentry>, and will, when run standalone, outside, in a
294
273
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
 
274
      any presumably secret password it just received.  Therefore,
296
275
      when running this program standalone (which should never
297
276
      normally be done), take care not to type in any real secret
298
277
      password by force of habit, since it would then immediately be
312
291
    <para>
313
292
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
293
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
294
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
316
295
      <manvolnum>8mandos</manvolnum></citerefentry>
317
296
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
297
      <manvolnum>8mandos</manvolnum></citerefentry>,