/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

merge

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"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY CONFNAME "mandos.conf">
8
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
 
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
9
8
]>
10
9
 
11
10
<refentry>
12
11
  <refentryinfo>
13
12
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>&CONFNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>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 Mandos
 
70
      Configuration file for the Mandos server
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 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.
 
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.
87
96
    </para>
88
97
 
89
98
    <para>
90
 
      The paramters are:
 
99
      The options are:
91
100
    </para>
92
101
 
93
102
    <variablelist>
94
103
      <varlistentry>
95
 
        <term><literal>interface</literal></term>
 
104
        <term><literal><varname>interface</varname></literal></term>
96
105
        <listitem>
97
106
          <para>
98
107
            This option allows you to override the default network
104
113
      </varlistentry>
105
114
 
106
115
      <varlistentry>
107
 
        <term><literal>address</literal></term>
 
116
        <term><literal><varname>address</varname></literal></term>
108
117
        <listitem>
109
118
          <para>
110
119
            This option allows you to override the default network
116
125
      </varlistentry>      
117
126
 
118
127
      <varlistentry>
119
 
        <term><literal>port</literal></term>
 
128
        <term><literal><varname>port</varname></literal></term>
120
129
        <listitem>
121
130
          <para>
122
131
            This option allows you to override the default port to
128
137
      </varlistentry>
129
138
 
130
139
      <varlistentry>
131
 
        <term><literal>debug</literal></term>
 
140
        <term><literal><varname>debug</varname></literal></term>
132
141
        <listitem>
133
142
          <para>
134
143
            This option allows you to modify debug mode with a true/false
138
147
      </varlistentry>      
139
148
 
140
149
      <varlistentry>
141
 
        <term><literal>priority</literal></term>
 
150
        <term><literal><varname>priority</varname></literal></term>
142
151
        <listitem>
143
152
          <para>
144
153
            This option allows you to override the default gnutls
151
160
      </varlistentry>
152
161
 
153
162
      <varlistentry>
154
 
        <term><literal>servicename</literal></term>
 
163
        <term><literal><varname>servicename</varname></literal></term>
155
164
        <listitem>
156
165
          <para>
157
166
            This option allows you to override the default Zeroconf