/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-25 06:44:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825064413-smqg5qwxfvhkeop4
* Makefile (DOCBOOKTOMAN): Only cd to one directory.

* mandos-options.xml (interface): Removed mention of a specific
                                  replaceable.
  (debug): Reworded slightly.

* mandos.conf.xml (OPTIONS): Renamed some replaceable names.

* mandos.xml (SYNOPSIS, OPTIONS): Renamed replaceable of "interface"
                                  from "IF" to "NAME".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY CONFNAME "mandos.conf">
6
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
83
82
      The file &CONFPATH; is a simple configuration file for
84
83
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
84
      <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.
 
85
      startup.  The configuration file starts with <quote><literal
 
86
      >[DEFAULT]</literal></quote> on a line by itself, followed by
 
87
      any number of <quote><varname><replaceable>option</replaceable
 
88
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
89
      with continuations in the style of RFC 822.  <quote><varname
 
90
      ><replaceable>option</replaceable></varname>: <replaceable
 
91
      >value</replaceable></quote> is also accepted.  Note that
 
92
      leading whitespace is removed from values.  Lines beginning with
 
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
 
94
      to provide comments.
96
95
    </para>
97
96
 
98
97
  </refsect1>
103
102
      <varlistentry>
104
103
        <term><varname>interface</varname></term>
105
104
        <listitem>
106
 
          <synopsis><literal>interface = </literal><arg
107
 
          choice="plain"><replaceable>IF</replaceable></arg>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >NAME</replaceable>
108
107
          </synopsis>
109
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
109
        </listitem>
113
112
      <varlistentry>
114
113
        <term><varname>address</varname></term>
115
114
        <listitem>
116
 
          <synopsis><literal>address = </literal><arg
117
 
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
118
117
          </synopsis>
119
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
120
119
        </listitem>
123
122
      <varlistentry>
124
123
        <term><varname>port</varname></term>
125
124
        <listitem>
126
 
          <synopsis><literal>port = </literal><arg
127
 
          choice="plain"><replaceable>PORT</replaceable></arg>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >NUMBER</replaceable>
128
127
          </synopsis>
129
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
129
        </listitem>
133
132
      <varlistentry>
134
133
        <term><varname>debug</varname></term>
135
134
        <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>
 
135
          <synopsis><literal>debug = </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> }
146
140
          </synopsis>
147
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
148
142
        </listitem>
151
145
      <varlistentry>
152
146
        <term><varname>priority</varname></term>
153
147
        <listitem>
154
 
          <synopsis><literal>priority = </literal><arg
155
 
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >STRING</replaceable>
156
150
          </synopsis>
157
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
158
152
        </listitem>
160
154
 
161
155
      <varlistentry>
162
156
        <term><varname>servicename</varname></term>
163
 
          <synopsis><literal>servicename = </literal><arg
164
 
          choice="plain"><replaceable>NAME</replaceable></arg>
 
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
165
160
          </synopsis>
166
 
        <listitem>
167
161
          <xi:include href="mandos-options.xml"
168
162
                      xpointer="servicename"/>
169
163
        </listitem>
183
177
    <title>BUGS</title>
184
178
    <para>
185
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
186
 
      module <systemitem class="library">ConfigParser</systemitem>
 
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
187
181
      requres it.
188
182
    </para>
189
183
  </refsect1>
191
185
  <refsect1 id="example">
192
186
    <title>EXAMPLE</title>
193
187
    <informalexample>
 
188
      <para>
 
189
        No options are actually required:
 
190
      </para>
 
191
      <programlisting>
 
192
[DEFAULT]
 
193
      </programlisting>
 
194
    </informalexample>
 
195
    <informalexample>
 
196
      <para>
 
197
        An example using all the options:
 
198
      </para>
194
199
      <programlisting>
195
200
[DEFAULT]
196
201
# A configuration example
199
204
port = 1025
200
205
debug = true
201
206
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
202
 
servicename = Mandos
 
207
servicename = Daena
203
208
      </programlisting>
204
209
    </informalexample>
205
210
  </refsect1>
 
211
  
 
212
  <refsect1 id="see_also">
 
213
    <title>SEE ALSO</title>
 
214
    <para>
 
215
      <citerefentry>
 
216
        <refentrytitle>mandos</refentrytitle>
 
217
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
218
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
219
        <manvolnum>5</manvolnum></citerefentry>
 
220
    </para>
 
221
  </refsect1>
206
222
</refentry>