/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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-02-25">
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>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <year>2008</year>
36
 
      <year>2009</year>
37
33
      <holder>Teddy Hogeborn</holder>
38
34
      <holder>Björn Påhlsson</holder>
39
35
    </copyright>
40
 
    <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>
41
59
  </refentryinfo>
42
 
  
 
60
 
43
61
  <refmeta>
44
62
    <refentrytitle>&CONFNAME;</refentrytitle>
45
63
    <manvolnum>5</manvolnum>
51
69
      Configuration file for the Mandos server
52
70
    </refpurpose>
53
71
  </refnamediv>
54
 
  
 
72
 
55
73
  <refsynopsisdiv>
56
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
57
77
  </refsynopsisdiv>
58
 
  
 
78
 
59
79
  <refsect1 id="description">
60
80
    <title>DESCRIPTION</title>
61
81
    <para>
73
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
74
94
      to provide comments.
75
95
    </para>
76
 
    
 
96
 
77
97
  </refsect1>
78
98
  <refsect1>
79
99
    <title>OPTIONS</title>
80
100
    
81
101
    <variablelist>
82
102
      <varlistentry>
83
 
        <term><option>interface<literal> = </literal><replaceable
84
 
        >NAME</replaceable></option></term>
 
103
        <term><varname>interface</varname></term>
85
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >NAME</replaceable>
 
107
          </synopsis>
86
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
87
109
        </listitem>
88
110
      </varlistentry>
89
 
      
 
111
 
90
112
      <varlistentry>
91
 
        <term><option>address<literal> = </literal><replaceable
92
 
          >ADDRESS</replaceable></option></term>
 
113
        <term><varname>address</varname></term>
93
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
94
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
95
119
        </listitem>
96
120
      </varlistentry>
97
 
      
 
121
 
98
122
      <varlistentry>
99
 
        <term><option>port<literal> = </literal><replaceable
100
 
        >NUMBER</replaceable></option></term>
 
123
        <term><varname>port</varname></term>
101
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >NUMBER</replaceable>
 
127
          </synopsis>
102
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
103
129
        </listitem>
104
130
      </varlistentry>
105
 
      
 
131
 
106
132
      <varlistentry>
107
 
        <term><option>debug<literal> = </literal>{ <literal
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </literal>{ <literal
108
136
          >1</literal> | <literal>yes</literal> | <literal
109
137
          >true</literal> | <literal>on</literal> | <literal
110
138
          >0</literal> | <literal>no</literal> | <literal
111
 
          >false</literal> | <literal>off</literal> }</option></term>
112
 
        <listitem>
 
139
          >false</literal> | <literal>off</literal> }
 
140
          </synopsis>
113
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
114
142
        </listitem>
115
143
      </varlistentry>
116
 
      
 
144
 
117
145
      <varlistentry>
118
 
        <term><option>priority<literal> = </literal><replaceable
119
 
        >STRING</replaceable></option></term>
 
146
        <term><varname>priority</varname></term>
120
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >STRING</replaceable>
 
150
          </synopsis>
121
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
122
152
        </listitem>
123
153
      </varlistentry>
124
 
      
 
154
 
125
155
      <varlistentry>
126
 
        <term><option>servicename<literal> = </literal
127
 
        ><replaceable>NAME</replaceable></option></term>
 
156
        <term><varname>servicename</varname></term>
128
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
129
161
          <xi:include href="mandos-options.xml"
130
162
                      xpointer="servicename"/>
131
163
        </listitem>
132
164
      </varlistentry>
133
165
      
134
 
      <varlistentry>
135
 
        <term><option>use_dbus<literal> = </literal>{ <literal
136
 
          >1</literal> | <literal>yes</literal> | <literal
137
 
          >true</literal> | <literal>on</literal> | <literal
138
 
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }</option></term>
140
 
        <listitem>
141
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
      
145
 
      <varlistentry>
146
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
147
 
          >1</literal> | <literal>yes</literal> | <literal
148
 
          >true</literal> | <literal>on</literal> | <literal
149
 
          >0</literal> | <literal>no</literal> | <literal
150
 
          >false</literal> | <literal>off</literal> }</option></term>
151
 
        <listitem>
152
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
      
156
166
    </variablelist>
157
167
  </refsect1>
158
168
  
168
178
    <para>
169
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
170
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
171
 
      requires it.
 
181
      requres it.
172
182
    </para>
173
183
  </refsect1>
174
184
  
190
200
[DEFAULT]
191
201
# A configuration example
192
202
interface = eth0
193
 
address = fe80::aede:48ff:fe71:f6f2
 
203
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
194
204
port = 1025
195
205
debug = true
196
206
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
197
207
servicename = Daena
198
 
use_dbus = False
199
 
use_ipv6 = True
200
208
      </programlisting>
201
209
    </informalexample>
202
210
  </refsect1>
204
212
  <refsect1 id="see_also">
205
213
    <title>SEE ALSO</title>
206
214
    <para>
207
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
208
 
      ><manvolnum>3</manvolnum></citerefentry>,
209
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
210
 
      <manvolnum>8</manvolnum></citerefentry>,
211
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
212
 
      <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>
213
222
    </para>
214
 
    
 
223
 
215
224
    <variablelist>
216
225
      <varlistentry>
217
226
        <term>
237
246
              <para>
238
247
                The clients use IPv6 link-local addresses, which are
239
248
                immediately usable since a link-local addresses is
240
 
                automatically assigned to a network interface when it
 
249
                automatically assigned to a network interfaces when it
241
250
                is brought up.
242
251
              </para>
243
252
            </listitem>
259
268
    </variablelist>
260
269
  </refsect1>
261
270
</refentry>
262
 
<!-- Local Variables: -->
263
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
264
 
<!-- time-stamp-end: "[\"']>" -->
265
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
266
 
<!-- End: -->