/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 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:
mandos.conf.xml
103
103
      <varlistentry>
104
104
        <term><varname>interface</varname></term>
105
105
        <listitem>
106
 
          <synopsis><literal>interface = </literal><replaceable
107
 
          >IF</replaceable>
 
106
          <synopsis><literal>interface = </literal><arg
 
107
          choice="plain"><replaceable>IF</replaceable></arg>
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><replaceable
117
 
          >ADDRESS</replaceable>
 
116
          <synopsis><literal>address = </literal><arg
 
117
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
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><replaceable
127
 
          >PORT</replaceable>
 
126
          <synopsis><literal>port = </literal><arg
 
127
          choice="plain"><replaceable>PORT</replaceable></arg>
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>{ <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> }
 
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>
141
146
          </synopsis>
142
147
          <xi:include href="mandos-options.xml" xpointer="debug"/>
143
148
        </listitem>
146
151
      <varlistentry>
147
152
        <term><varname>priority</varname></term>
148
153
        <listitem>
149
 
          <synopsis><literal>priority = </literal><replaceable
150
 
          >PRIORITY</replaceable>
 
154
          <synopsis><literal>priority = </literal><arg
 
155
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
151
156
          </synopsis>
152
157
          <xi:include href="mandos-options.xml" xpointer="priority"/>
153
158
        </listitem>
155
160
 
156
161
      <varlistentry>
157
162
        <term><varname>servicename</varname></term>
 
163
          <synopsis><literal>servicename = </literal><arg
 
164
          choice="plain"><replaceable>NAME</replaceable></arg>
 
165
          </synopsis>
158
166
        <listitem>
159
 
          <synopsis><literal>servicename = </literal><replaceable
160
 
          >NAME</replaceable>
161
 
          </synopsis>
162
167
          <xi:include href="mandos-options.xml"
163
168
                      xpointer="servicename"/>
164
169
        </listitem>
178
183
    <title>BUGS</title>
179
184
    <para>
180
185
      The <literal>[DEFAULT]</literal> is necessary because the Python
181
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
186
      module <systemitem class="library">ConfigParser</systemitem>
182
187
      requres it.
183
188
    </para>
184
189
  </refsect1>
186
191
  <refsect1 id="example">
187
192
    <title>EXAMPLE</title>
188
193
    <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>
200
194
      <programlisting>
201
195
[DEFAULT]
202
196
# A configuration example
205
199
port = 1025
206
200
debug = true
207
201
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
208
 
servicename = Daena
 
202
servicename = Mandos
209
203
      </programlisting>
210
204
    </informalexample>
211
205
  </refsect1>