/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 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:
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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2008-09-30">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
7
]>
10
8
 
11
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
36
33
      <holder>Teddy Hogeborn</holder>
37
34
      <holder>Björn Påhlsson</holder>
38
35
    </copyright>
39
 
    <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>
40
59
  </refentryinfo>
41
 
  
 
60
 
42
61
  <refmeta>
43
62
    <refentrytitle>&CONFNAME;</refentrytitle>
44
63
    <manvolnum>5</manvolnum>
50
69
      Configuration file for the Mandos server
51
70
    </refpurpose>
52
71
  </refnamediv>
53
 
  
 
72
 
54
73
  <refsynopsisdiv>
55
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
56
77
  </refsynopsisdiv>
57
 
  
 
78
 
58
79
  <refsect1 id="description">
59
80
    <title>DESCRIPTION</title>
60
81
    <para>
72
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
73
94
      to provide comments.
74
95
    </para>
75
 
    
 
96
 
76
97
  </refsect1>
77
98
  <refsect1>
78
99
    <title>OPTIONS</title>
79
100
    
80
101
    <variablelist>
81
102
      <varlistentry>
82
 
        <term><option>interface<literal> = </literal><replaceable
83
 
        >NAME</replaceable></option></term>
 
103
        <term><varname>interface</varname></term>
84
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >NAME</replaceable>
 
107
          </synopsis>
85
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
86
109
        </listitem>
87
110
      </varlistentry>
88
 
      
 
111
 
89
112
      <varlistentry>
90
 
        <term><option>address<literal> = </literal><replaceable
91
 
          >ADDRESS</replaceable></option></term>
 
113
        <term><varname>address</varname></term>
92
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
93
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
94
119
        </listitem>
95
120
      </varlistentry>
96
 
      
 
121
 
97
122
      <varlistentry>
98
 
        <term><option>port<literal> = </literal><replaceable
99
 
        >NUMBER</replaceable></option></term>
 
123
        <term><varname>port</varname></term>
100
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >NUMBER</replaceable>
 
127
          </synopsis>
101
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
102
129
        </listitem>
103
130
      </varlistentry>
104
 
      
 
131
 
105
132
      <varlistentry>
106
 
        <term><option>debug<literal> = </literal>{ <literal
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </literal>{ <literal
107
136
          >1</literal> | <literal>yes</literal> | <literal
108
137
          >true</literal> | <literal>on</literal> | <literal
109
138
          >0</literal> | <literal>no</literal> | <literal
110
 
          >false</literal> | <literal>off</literal> }</option></term>
111
 
        <listitem>
 
139
          >false</literal> | <literal>off</literal> }
 
140
          </synopsis>
112
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
113
142
        </listitem>
114
143
      </varlistentry>
115
 
      
 
144
 
116
145
      <varlistentry>
117
 
        <term><option>priority<literal> = </literal><replaceable
118
 
        >STRING</replaceable></option></term>
 
146
        <term><varname>priority</varname></term>
119
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >STRING</replaceable>
 
150
          </synopsis>
120
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
121
152
        </listitem>
122
153
      </varlistentry>
123
 
      
 
154
 
124
155
      <varlistentry>
125
 
        <term><option>servicename<literal> = </literal
126
 
        ><replaceable>NAME</replaceable></option></term>
 
156
        <term><varname>servicename</varname></term>
127
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
128
161
          <xi:include href="mandos-options.xml"
129
162
                      xpointer="servicename"/>
130
163
        </listitem>
145
178
    <para>
146
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
147
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
148
 
      requires it.
 
181
      requres it.
149
182
    </para>
150
183
  </refsect1>
151
184
  
179
212
  <refsect1 id="see_also">
180
213
    <title>SEE ALSO</title>
181
214
    <para>
182
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
183
 
      ><manvolnum>3</manvolnum></citerefentry>,
184
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
185
 
      <manvolnum>8</manvolnum></citerefentry>,
186
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
187
 
      <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>
188
222
    </para>
189
 
    
 
223
 
190
224
    <variablelist>
191
225
      <varlistentry>
192
226
        <term>
234
268
    </variablelist>
235
269
  </refsect1>
236
270
</refentry>
237
 
<!-- Local Variables: -->
238
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
239
 
<!-- time-stamp-end: "[\"']>" -->
240
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
241
 
<!-- End: -->