/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-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
7
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
8
]>
9
9
 
10
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
11
  <refentryinfo>
12
12
    <title>&CONFNAME;</title>
13
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
95
95
      used to provide comments.
96
96
    </para>
97
97
 
98
 
    <para>
99
 
      The options are:
100
 
    </para>
101
 
 
 
98
  </refsect1>
 
99
  <refsect1>
 
100
    <title>OPTIONS</title>
 
101
    
102
102
    <variablelist>
103
103
      <varlistentry>
104
 
        <term><literal><varname>interface</varname></literal></term>
105
 
        <listitem>
106
 
          <para>
107
 
            This option allows you to override the default network
108
 
            interfaces. By default mandos will not bind to any
109
 
            specific interface but instead use default avahi-server
110
 
            behaviour.
111
 
          </para>
112
 
        </listitem>
113
 
      </varlistentry>
114
 
 
115
 
      <varlistentry>
116
 
        <term><literal><varname>address</varname></literal></term>
117
 
        <listitem>
118
 
          <para>
119
 
            This option allows you to override the default network
120
 
            address. By default mandos will not bind to any
121
 
            specific address but instead use default avahi-server
122
 
            behaviour.
123
 
          </para>
124
 
        </listitem>
125
 
      </varlistentry>      
126
 
 
127
 
      <varlistentry>
128
 
        <term><literal><varname>port</varname></literal></term>
129
 
        <listitem>
130
 
          <para>
131
 
            This option allows you to override the default port to
132
 
            listen on. By default mandos will not specify any specific
133
 
            port and instead use a random port given by the OS from
134
 
            the use of INADDR_ANY.
135
 
          </para>
136
 
        </listitem>
137
 
      </varlistentry>
138
 
 
139
 
      <varlistentry>
140
 
        <term><literal><varname>debug</varname></literal></term>
141
 
        <listitem>
142
 
          <para>
143
 
            This option allows you to modify debug mode with a true/false
144
 
            boolean value. By default is debug set to <literal>false</literal>.
145
 
          </para>
146
 
        </listitem>
147
 
      </varlistentry>      
148
 
 
149
 
      <varlistentry>
150
 
        <term><literal><varname>priority</varname></literal></term>
151
 
        <listitem>
152
 
          <para>
153
 
            This option allows you to override the default gnutls
154
 
            priority that will be used in gnutls session. See
155
 
            <citerefentry><refentrytitle>gnutls_priority_init
156
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
157
 
            more information on gnutls priority strings.
158
 
          </para>         
159
 
        </listitem>
160
 
      </varlistentry>
161
 
 
162
 
      <varlistentry>
163
 
        <term><literal><varname>servicename</varname></literal></term>
164
 
        <listitem>
165
 
          <para>
166
 
            This option allows you to override the default Zeroconf
167
 
            service name use to announce mandos as a avahi service. By
168
 
            default mandos will use "Mandos".
169
 
          </para>
 
104
        <term><varname>interface</varname></term>
 
105
        <listitem>
 
106
          <synopsis><literal>interface = </literal><arg
 
107
          choice="plain"><replaceable>IF</replaceable></arg>
 
108
          </synopsis>
 
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
110
        </listitem>
 
111
      </varlistentry>
 
112
 
 
113
      <varlistentry>
 
114
        <term><varname>address</varname></term>
 
115
        <listitem>
 
116
          <synopsis><literal>address = </literal><arg
 
117
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
 
118
          </synopsis>
 
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
120
        </listitem>
 
121
      </varlistentry>
 
122
 
 
123
      <varlistentry>
 
124
        <term><varname>port</varname></term>
 
125
        <listitem>
 
126
          <synopsis><literal>port = </literal><arg
 
127
          choice="plain"><replaceable>PORT</replaceable></arg>
 
128
          </synopsis>
 
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
130
        </listitem>
 
131
      </varlistentry>
 
132
 
 
133
      <varlistentry>
 
134
        <term><varname>debug</varname></term>
 
135
        <listitem>
 
136
          <synopsis><literal>debug =</literal><group choice="req">
 
137
            <arg choice="plain">1</arg>
 
138
            <arg choice="plain">yes</arg>
 
139
            <arg choice="plain">true</arg>
 
140
            <arg choice="plain">on</arg>
 
141
            <arg choice="plain">0</arg>
 
142
            <arg choice="plain">no</arg>
 
143
            <arg choice="plain">false</arg>
 
144
            <arg choice="plain">off</arg>
 
145
          </group>
 
146
          </synopsis>
 
147
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
148
        </listitem>
 
149
      </varlistentry>
 
150
 
 
151
      <varlistentry>
 
152
        <term><varname>priority</varname></term>
 
153
        <listitem>
 
154
          <synopsis><literal>priority = </literal><arg
 
155
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
 
156
          </synopsis>
 
157
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
158
        </listitem>
 
159
      </varlistentry>
 
160
 
 
161
      <varlistentry>
 
162
        <term><varname>servicename</varname></term>
 
163
          <synopsis><literal>servicename = </literal><arg
 
164
          choice="plain"><replaceable>NAME</replaceable></arg>
 
165
          </synopsis>
 
166
        <listitem>
 
167
          <xi:include href="mandos-options.xml"
 
168
                      xpointer="servicename"/>
170
169
        </listitem>
171
170
      </varlistentry>
172
171
      
173
172
    </variablelist>
174
173
  </refsect1>
175
 
 
176
 
  <refsect1 id="examples">
177
 
    <title>EXAMPLES</title>
 
174
  
 
175
  <refsect1 id="files">
 
176
    <title>FILES</title>
 
177
    <para>
 
178
      The file described here is &CONFPATH;
 
179
    </para>
 
180
  </refsect1>
 
181
  
 
182
  <refsect1 id="bugs">
 
183
    <title>BUGS</title>
 
184
    <para>
 
185
      The <literal>[DEFAULT]</literal> is necessary because the Python
 
186
      module <systemitem class="library">ConfigParser</systemitem>
 
187
      requres it.
 
188
    </para>
 
189
  </refsect1>
 
190
  
 
191
  <refsect1 id="example">
 
192
    <title>EXAMPLE</title>
178
193
    <informalexample>
179
194
      <programlisting>
180
 
        [server]
181
 
        # A configuration example
182
 
        interface = eth0 
183
 
        address = 2001:DB8:
184
 
        port = 1025 
185
 
        debug = true 
186
 
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
187
 
        servicename = Mandos
 
195
[DEFAULT]
 
196
# A configuration example
 
197
interface = eth0
 
198
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
199
port = 1025
 
200
debug = true
 
201
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
202
servicename = Mandos
188
203
      </programlisting>
189
204
    </informalexample>
190
 
  </refsect1>  
191
 
  
192
 
  <refsect1 id="files">
193
 
    <title>FILES</title>
194
 
    <para>
195
 
      The file described here is &CONFPATH;
196
 
    </para>
197
205
  </refsect1>
198
206
</refentry>