/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

* mandos (Client.timeout, Client.interval): Changed from being a
                                            property to be a normal
                                            attribute.
  (Client._timeout, Client._interval): Removed.
  (Client._timeout_milliseconds): Changed from being an attribute to
                                  be a method "timeout_milliseconds".
                                  All users changed.
  (Client._interval_milliseconds): Changed from being an attribute to
                                   be method "interval_milliseconds".
                                   All users changed.
  (Client.__init__): Take additional "use_dbus" keyword argument.
                     Only provide D-Bus interface if "use_dbus" is
                     True.
  (Client.use_dbus): New attribute.
  (Client.dbus_object_path): Changed to only be set if "self.use_dbus"
                             is True.
  (Client.enable, Client.disable, Client.checker_callback,
  Client.bump_timeout, Client.start_checker, Client.stop_checker):
  Only emit D-Bus signals if "self.use_dbus".
  (Client.SetChecker, Client.SetHost, Client.Enable): Bug fix: Emit
                                                      D-Bus signals.
  (Client.SetInterval, Client.SetTimeout): Changed to emit D-Bus
                                           signals.

  (main): Remove deprecated "default" keyword argument to "--check"
          option.  Added new "--no-dbus" option.  Added corresponding
          "use_dbus" server configuration option.  Only provide D-Bus
          interface and emit D-Bus signals if "use_dbus".  Pass
          "use_dbus" on to Client constructor.

* mandos-options.xml ([@id="dbus"]): New option.

* mandos.conf (use_dbus): New option.

* mandos.conf.xml (OPTIONS): New option "use_dbus".
  (EXAMPLE): - '' -

* mandos.xml (SYNOPSIS): New option "--no-dbus".
  (D-BUS INTERFACE): New section.

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