/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/askpass-fifo.xml

  • Committer: Teddy Hogeborn
  • Date: 2016-03-23 07:14:57 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 343.
  • Revision ID: teddy@recompile.se-20160323071457-2yft5uevmaxwds16
Client: Install intro(8mandos) manual page

When installing client, include the intro(8mandos) manual page so that
it is available even if the server is not installed.

* Makefile (install-client-nokey): Also install intro.8mandos.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
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 COMMANDNAME "askpass-fifo">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
 
8
]>
 
9
 
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
  <refentryinfo>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
 
17
    <authorgroup>
 
18
      <author>
 
19
        <firstname>Björn</firstname>
 
20
        <surname>Påhlsson</surname>
 
21
        <address>
 
22
          <email>belorn@recompile.se</email>
 
23
        </address>
 
24
      </author>
 
25
      <author>
 
26
        <firstname>Teddy</firstname>
 
27
        <surname>Hogeborn</surname>
 
28
        <address>
 
29
          <email>teddy@recompile.se</email>
 
30
        </address>
 
31
      </author>
 
32
    </authorgroup>
 
33
    <copyright>
 
34
      <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
      <holder>Teddy Hogeborn</holder>
 
44
      <holder>Björn Påhlsson</holder>
 
45
    </copyright>
 
46
  </refentryinfo>
 
47
  
 
48
  <refmeta>
 
49
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
50
    <manvolnum>8mandos</manvolnum>
 
51
  </refmeta>
 
52
  
 
53
  <refnamediv>
 
54
    <refname><command>&COMMANDNAME;</command></refname>
 
55
    <refpurpose>Mandos plugin to get a password from a
 
56
    FIFO.</refpurpose>
 
57
  </refnamediv>
 
58
  
 
59
  <refsynopsisdiv>
 
60
    <cmdsynopsis>
 
61
      <command>&COMMANDNAME;</command>
 
62
    </cmdsynopsis>
 
63
  </refsynopsisdiv>
 
64
  
 
65
  <refsect1 id="description">
 
66
    <title>DESCRIPTION</title>
 
67
    <para>
 
68
      This program reads a password from a <acronym>FIFO</acronym> and
 
69
      outputs it to standard output.
 
70
    </para>
 
71
    <para>
 
72
      This program is not very useful on its own.  This program is
 
73
      really meant to run as a plugin in the <application
 
74
      >Mandos</application> client-side system, where it is used as a
 
75
      fallback and alternative to retrieving passwords from a
 
76
      <application >Mandos</application> server.
 
77
    </para>
 
78
    <para>
 
79
      This program is meant to be imitate a feature of the
 
80
      <command>askpass</command> program, so that programs written to
 
81
      interface with it can keep working under the
 
82
      <application>Mandos</application> system.
 
83
    </para>
 
84
  </refsect1>
 
85
  
 
86
  <refsect1 id="options">
 
87
    <title>OPTIONS</title>
 
88
    <para>
 
89
      This program takes no options.
 
90
    </para>
 
91
  </refsect1>
 
92
  
 
93
  <refsect1 id="exit_status">
 
94
    <title>EXIT STATUS</title>
 
95
    <para>
 
96
      If exit status is 0, the output from the program is the password
 
97
      as it was read.  Otherwise, if exit status is other than 0, the
 
98
      program was interrupted or encountered an error, and any output
 
99
      so far could be corrupt and/or truncated, and should therefore
 
100
      be ignored.
 
101
    </para>
 
102
  </refsect1>
 
103
  
 
104
  <refsect1 id="files">
 
105
    <title>FILES</title>
 
106
    <variablelist>
 
107
      <varlistentry>
 
108
        <term><filename>/lib/cryptsetup/passfifo</filename></term>
 
109
        <listitem>
 
110
          <para>
 
111
            This is the <acronym>FIFO</acronym> where this program
 
112
            will read the password.  If it does not exist, it will be
 
113
            created.
 
114
          </para>
 
115
        </listitem>
 
116
      </varlistentry>
 
117
    </variablelist>
 
118
  </refsect1>
 
119
  
 
120
  <refsect1 id="bugs">
 
121
    <title>BUGS</title>
 
122
    <xi:include href="../bugs.xml"/>
 
123
  </refsect1>
 
124
  
 
125
  <refsect1 id="example">
 
126
    <title>EXAMPLE</title>
 
127
    <para>
 
128
      Note that normally, this program will not be invoked directly,
 
129
      but instead started by the Mandos <citerefentry><refentrytitle
 
130
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
131
      </citerefentry>.
 
132
    </para>
 
133
    <informalexample>
 
134
      <para>
 
135
        This program takes no options.
 
136
      </para>
 
137
      <para>
 
138
        <userinput>&COMMANDNAME;</userinput>
 
139
      </para>
 
140
    </informalexample>
 
141
  </refsect1>
 
142
  
 
143
  <refsect1 id="security">
 
144
    <title>SECURITY</title>
 
145
    <para>
 
146
      The only thing that could be considered worthy of note is
 
147
      this:  This program is meant to be run by <citerefentry>
 
148
      <refentrytitle>plugin-runner</refentrytitle><manvolnum
 
149
      >8mandos</manvolnum></citerefentry>, and will, when run
 
150
      standalone, outside, in a normal environment, immediately output
 
151
      on its standard output any presumably secret password it just
 
152
      received.  Therefore, when running this program standalone
 
153
      (which should never normally be done), take care not to type in
 
154
      any real secret password by force of habit, since it would then
 
155
      immediately be shown as output.
 
156
    </para>
 
157
  </refsect1>
 
158
  
 
159
  <refsect1 id="see_also">
 
160
    <title>SEE ALSO</title>
 
161
    <para>
 
162
      <citerefentry><refentrytitle>intro</refentrytitle>
 
163
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
164
      <citerefentry><refentrytitle>fifo</refentrytitle>
 
165
      <manvolnum>7</manvolnum></citerefentry>,
 
166
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
167
      <manvolnum>8mandos</manvolnum></citerefentry>
 
168
    </para>
 
169
  </refsect1>
 
170
</refentry>
 
171
<!-- Local Variables: -->
 
172
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
173
<!-- time-stamp-end: "[\"']>" -->
 
174
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
175
<!-- End: -->