/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 mandos.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
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
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY CONFNAME "mandos.conf">
6
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-09-04">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
 
13
    <productname>&CONFNAME;</productname>
15
14
    <productnumber>&VERSION;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
15
    <authorgroup>
18
16
      <author>
19
17
        <firstname>Björn</firstname>
35
33
      <holder>Teddy Hogeborn</holder>
36
34
      <holder>Björn Påhlsson</holder>
37
35
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
39
59
  </refentryinfo>
40
60
 
41
61
  <refmeta>
51
71
  </refnamediv>
52
72
 
53
73
  <refsynopsisdiv>
54
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
55
77
  </refsynopsisdiv>
56
78
 
57
79
  <refsect1 id="description">
78
100
    
79
101
    <variablelist>
80
102
      <varlistentry>
81
 
        <term><option>interface<literal> = </literal><replaceable
82
 
        >NAME</replaceable></option></term>
 
103
        <term><varname>interface</varname></term>
83
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >NAME</replaceable>
 
107
          </synopsis>
84
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
109
        </listitem>
86
110
      </varlistentry>
87
111
 
88
112
      <varlistentry>
89
 
        <term><option>address<literal> = </literal><replaceable
90
 
          >ADDRESS</replaceable></option></term>
 
113
        <term><varname>address</varname></term>
91
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
92
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
119
        </listitem>
94
120
      </varlistentry>
95
121
 
96
122
      <varlistentry>
97
 
        <term><option>port<literal> = </literal><replaceable
98
 
        >NUMBER</replaceable></option></term>
 
123
        <term><varname>port</varname></term>
99
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >NUMBER</replaceable>
 
127
          </synopsis>
100
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
129
        </listitem>
102
130
      </varlistentry>
103
131
 
104
132
      <varlistentry>
105
 
        <term><option>debug<literal> = </literal>{ <literal
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </literal>{ <literal
106
136
          >1</literal> | <literal>yes</literal> | <literal
107
137
          >true</literal> | <literal>on</literal> | <literal
108
138
          >0</literal> | <literal>no</literal> | <literal
109
 
          >false</literal> | <literal>off</literal> }</option></term>
110
 
        <listitem>
 
139
          >false</literal> | <literal>off</literal> }
 
140
          </synopsis>
111
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
142
        </listitem>
113
143
      </varlistentry>
114
144
 
115
145
      <varlistentry>
116
 
        <term><option>priority<literal> = </literal><replaceable
117
 
        >STRING</replaceable></option></term>
 
146
        <term><varname>priority</varname></term>
118
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >STRING</replaceable>
 
150
          </synopsis>
119
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
152
        </listitem>
121
153
      </varlistentry>
122
154
 
123
155
      <varlistentry>
124
 
        <term><option>servicename<literal> = </literal
125
 
        ><replaceable>NAME</replaceable></option></term>
 
156
        <term><varname>servicename</varname></term>
126
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
127
161
          <xi:include href="mandos-options.xml"
128
162
                      xpointer="servicename"/>
129
163
        </listitem>
144
178
    <para>
145
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
146
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
147
 
      requires it.
 
181
      requres it.
148
182
    </para>
149
183
  </refsect1>
150
184
  
178
212
  <refsect1 id="see_also">
179
213
    <title>SEE ALSO</title>
180
214
    <para>
181
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
182
 
      ><manvolnum>3</manvolnum></citerefentry>,
183
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
184
 
      <manvolnum>8</manvolnum></citerefentry>,
185
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
 
      <manvolnum>5</manvolnum></citerefentry>
 
215
      <citerefentry>
 
216
        <refentrytitle>mandos</refentrytitle>
 
217
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
218
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
219
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
220
        <refentrytitle>gnutls_priority_init</refentrytitle>
 
221
        <manvolnum>3</manvolnum></citerefentry>
187
222
    </para>
188
223
 
189
224
    <variablelist>
233
268
    </variablelist>
234
269
  </refsect1>
235
270
</refentry>
236
 
<!-- Local Variables: -->
237
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
238
 
<!-- time-stamp-end: "[\"']>" -->
239
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
240
 
<!-- End: -->