/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-17 20:34:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817203418-l691ahxyc7vmezad
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".

* mandos.xml: More improvements.  Replaced " with <quote>'s.
  (NETWORK PROTOCOL): Replaced <informaltable> with <table> with a
                      <title>.
  (CHECKING): New section describing the continual checking of
              clients.
  (LOGGING): We log to /dev/log, not syslog(3).
  (FILES): Changed to use a <variablelist> instead of an
           <itemizedlist>.  Added "/dev/log" and brief descriptions of
           all files.
  (BUGS): Added content.
  (EXAMPLES): - '' -
  (SECURITY): Added content to subsections "SERVER" and "CLIENTS".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY CONFNAME "mandos.conf">
6
8
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
9
]>
9
10
 
10
11
<refentry>
11
12
  <refentryinfo>
12
13
    <title>&CONFNAME;</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
15
    <productname>&CONFNAME;</productname>
15
16
    <productnumber>&VERSION;</productnumber>
16
17
    <authorgroup>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
36
    </copyright>
37
37
    <legalnotice>
38
38
      <para>
67
67
  <refnamediv>
68
68
    <refname><filename>&CONFNAME;</filename></refname>
69
69
    <refpurpose>
70
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos
71
71
    </refpurpose>
72
72
  </refnamediv>
73
73
 
80
80
  <refsect1 id="description">
81
81
    <title>DESCRIPTION</title>
82
82
    <para>
83
 
      The file &CONFPATH; is a simple configuration file for
84
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
 
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
86
 
      startup.  The configuration file starts with
87
 
      <quote><literal>[DEFAULT]</literal></quote> on a line by itself,
88
 
      followed by any number of
89
 
      <quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
90
 
      entries, with continuations in the style of RFC 822.
91
 
      <quote><varname><replaceable>option</replaceable></varname>:
92
 
      <replaceable>value</replaceable></quote> is also accepted.  Note
93
 
      that leading whitespace is removed from values.  Lines beginning
94
 
      with <quote>#</quote> or <quote>;</quote> are ignored and may be
95
 
      used to provide comments.
 
83
      The file &CONFPATH; is a simple configuration file for mandos
 
84
      and is looked on at startup of the service. The configuration
 
85
      file must start with <literal>[server]</literal>. The format for
 
86
      the rest is a simple VAR = VALUE pair. Values may not be empty.
96
87
    </para>
97
88
 
98
89
    <para>
99
 
      The options are:
 
90
      The paramters are:
100
91
    </para>
101
92
 
102
93
    <variablelist>
103
94
      <varlistentry>
104
 
        <term><literal><varname>interface</varname></literal></term>
 
95
        <term><literal>interface</literal></term>
105
96
        <listitem>
106
97
          <para>
107
98
            This option allows you to override the default network
113
104
      </varlistentry>
114
105
 
115
106
      <varlistentry>
116
 
        <term><literal><varname>address</varname></literal></term>
 
107
        <term><literal>address</literal></term>
117
108
        <listitem>
118
109
          <para>
119
110
            This option allows you to override the default network
125
116
      </varlistentry>      
126
117
 
127
118
      <varlistentry>
128
 
        <term><literal><varname>port</varname></literal></term>
 
119
        <term><literal>port</literal></term>
129
120
        <listitem>
130
121
          <para>
131
122
            This option allows you to override the default port to
137
128
      </varlistentry>
138
129
 
139
130
      <varlistentry>
140
 
        <term><literal><varname>debug</varname></literal></term>
 
131
        <term><literal>debug</literal></term>
141
132
        <listitem>
142
133
          <para>
143
134
            This option allows you to modify debug mode with a true/false
147
138
      </varlistentry>      
148
139
 
149
140
      <varlistentry>
150
 
        <term><literal><varname>priority</varname></literal></term>
 
141
        <term><literal>priority</literal></term>
151
142
        <listitem>
152
143
          <para>
153
144
            This option allows you to override the default gnutls
160
151
      </varlistentry>
161
152
 
162
153
      <varlistentry>
163
 
        <term><literal><varname>servicename</varname></literal></term>
 
154
        <term><literal>servicename</literal></term>
164
155
        <listitem>
165
156
          <para>
166
157
            This option allows you to override the default Zeroconf