/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-19 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
103
103
      <varlistentry>
104
104
        <term><varname>interface</varname></term>
105
105
        <listitem>
106
 
          <synopsis><literal>interface = </literal><arg
107
 
          choice="plain"><replaceable>IF</replaceable></arg>
 
106
          <synopsis><literal>interface = </literal><replaceable
 
107
          >IF</replaceable>
108
108
          </synopsis>
109
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
110
        </listitem>
113
113
      <varlistentry>
114
114
        <term><varname>address</varname></term>
115
115
        <listitem>
116
 
          <synopsis><literal>address = </literal><arg
117
 
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
 
116
          <synopsis><literal>address = </literal><replaceable
 
117
          >ADDRESS</replaceable>
118
118
          </synopsis>
119
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
120
120
        </listitem>
123
123
      <varlistentry>
124
124
        <term><varname>port</varname></term>
125
125
        <listitem>
126
 
          <synopsis><literal>port = </literal><arg
127
 
          choice="plain"><replaceable>PORT</replaceable></arg>
 
126
          <synopsis><literal>port = </literal><replaceable
 
127
          >PORT</replaceable>
128
128
          </synopsis>
129
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
130
        </listitem>
133
133
      <varlistentry>
134
134
        <term><varname>debug</varname></term>
135
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>
 
136
          <synopsis><literal>debug = </literal>{ <literal
 
137
          >1</literal> | <literal>yes</literal> | <literal
 
138
          >true</literal> | <literal>on</literal> | <literal
 
139
          >0</literal> | <literal>no</literal> | <literal
 
140
          >false</literal> | <literal>off</literal> }
146
141
          </synopsis>
147
142
          <xi:include href="mandos-options.xml" xpointer="debug"/>
148
143
        </listitem>
151
146
      <varlistentry>
152
147
        <term><varname>priority</varname></term>
153
148
        <listitem>
154
 
          <synopsis><literal>priority = </literal><arg
155
 
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
 
149
          <synopsis><literal>priority = </literal><replaceable
 
150
          >PRIORITY</replaceable>
156
151
          </synopsis>
157
152
          <xi:include href="mandos-options.xml" xpointer="priority"/>
158
153
        </listitem>
160
155
 
161
156
      <varlistentry>
162
157
        <term><varname>servicename</varname></term>
163
 
          <synopsis><literal>servicename = </literal><arg
164
 
          choice="plain"><replaceable>NAME</replaceable></arg>
 
158
        <listitem>
 
159
          <synopsis><literal>servicename = </literal><replaceable
 
160
          >NAME</replaceable>
165
161
          </synopsis>
166
 
        <listitem>
167
162
          <xi:include href="mandos-options.xml"
168
163
                      xpointer="servicename"/>
169
164
        </listitem>
183
178
    <title>BUGS</title>
184
179
    <para>
185
180
      The <literal>[DEFAULT]</literal> is necessary because the Python
186
 
      module <systemitem class="library">ConfigParser</systemitem>
 
181
      built-in module <systemitem class="library">ConfigParser</systemitem>
187
182
      requres it.
188
183
    </para>
189
184
  </refsect1>
191
186
  <refsect1 id="example">
192
187
    <title>EXAMPLE</title>
193
188
    <informalexample>
 
189
      <para>
 
190
        No options are actually required:
 
191
      </para>
 
192
      <programlisting>
 
193
[DEFAULT]
 
194
      </programlisting>
 
195
    </informalexample>
 
196
    <informalexample>
 
197
      <para>
 
198
        An example using all the options:
 
199
      </para>
194
200
      <programlisting>
195
201
[DEFAULT]
196
202
# A configuration example
199
205
port = 1025
200
206
debug = true
201
207
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
202
 
servicename = Mandos
 
208
servicename = Daena
203
209
      </programlisting>
204
210
    </informalexample>
205
211
  </refsect1>