/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-31 09:26:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831092612-atz9uzia38h1ijy5
* mandos.xml (OPTIONS): Moved long options before short.  Use <option>
                        tags instead of <literal>.

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">
 
7
<!ENTITY TIMESTAMP "2008-08-30">
8
8
]>
9
9
 
10
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
11
  <refentryinfo>
12
 
    <title>&CONFNAME;</title>
 
12
    <title>Mandos Manual</title>
13
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>&CONFNAME;</productname>
 
14
    <productname>Mandos</productname>
15
15
    <productnumber>&VERSION;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
72
73
  </refnamediv>
73
74
 
74
75
  <refsynopsisdiv>
75
 
    <synopsis>
76
 
      &CONFPATH;
77
 
    </synopsis>
 
76
    <synopsis>&CONFPATH;</synopsis>
78
77
  </refsynopsisdiv>
79
78
 
80
79
  <refsect1 id="description">
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>
101
100
    
102
101
    <variablelist>
103
102
      <varlistentry>
104
 
        <term><varname>interface</varname></term>
 
103
        <term><option>interface<literal> = </literal><replaceable
 
104
        >NAME</replaceable></option></term>
105
105
        <listitem>
106
 
          <synopsis><literal>interface = </literal><replaceable
107
 
          >IF</replaceable>
108
 
          </synopsis>
109
106
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
107
        </listitem>
111
108
      </varlistentry>
112
109
 
113
110
      <varlistentry>
114
 
        <term><varname>address</varname></term>
 
111
        <term><option>address<literal> = </literal><replaceable
 
112
          >ADDRESS</replaceable></option></term>
115
113
        <listitem>
116
 
          <synopsis><literal>address = </literal><replaceable
117
 
          >ADDRESS</replaceable>
118
 
          </synopsis>
119
114
          <xi:include href="mandos-options.xml" xpointer="address"/>
120
115
        </listitem>
121
116
      </varlistentry>
122
117
 
123
118
      <varlistentry>
124
 
        <term><varname>port</varname></term>
 
119
        <term><option>port<literal> = </literal><replaceable
 
120
        >NUMBER</replaceable></option></term>
125
121
        <listitem>
126
 
          <synopsis><literal>port = </literal><replaceable
127
 
          >PORT</replaceable>
128
 
          </synopsis>
129
122
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
123
        </listitem>
131
124
      </varlistentry>
132
125
 
133
126
      <varlistentry>
134
 
        <term><varname>debug</varname></term>
135
 
        <listitem>
136
 
          <synopsis><literal>debug = </literal>{ <literal
 
127
        <term><option>debug<literal> = </literal>{ <literal
137
128
          >1</literal> | <literal>yes</literal> | <literal
138
129
          >true</literal> | <literal>on</literal> | <literal
139
130
          >0</literal> | <literal>no</literal> | <literal
140
 
          >false</literal> | <literal>off</literal> }
141
 
          </synopsis>
 
131
          >false</literal> | <literal>off</literal> }</option></term>
 
132
        <listitem>
142
133
          <xi:include href="mandos-options.xml" xpointer="debug"/>
143
134
        </listitem>
144
135
      </varlistentry>
145
136
 
146
137
      <varlistentry>
147
 
        <term><varname>priority</varname></term>
 
138
        <term><option>priority<literal> = </literal><replaceable
 
139
        >STRING</replaceable></option></term>
148
140
        <listitem>
149
 
          <synopsis><literal>priority = </literal><replaceable
150
 
          >PRIORITY</replaceable>
151
 
          </synopsis>
152
141
          <xi:include href="mandos-options.xml" xpointer="priority"/>
153
142
        </listitem>
154
143
      </varlistentry>
155
144
 
156
145
      <varlistentry>
157
 
        <term><varname>servicename</varname></term>
 
146
        <term><option>servicename<literal> = </literal
 
147
        ><replaceable>NAME</replaceable></option></term>
158
148
        <listitem>
159
 
          <synopsis><literal>servicename = </literal><replaceable
160
 
          >NAME</replaceable>
161
 
          </synopsis>
162
149
          <xi:include href="mandos-options.xml"
163
150
                      xpointer="servicename"/>
164
151
        </listitem>
213
200
  <refsect1 id="see_also">
214
201
    <title>SEE ALSO</title>
215
202
    <para>
216
 
      <citerefentry>
217
 
        <refentrytitle>mandos</refentrytitle>
218
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
219
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
220
 
        <manvolnum>5</manvolnum></citerefentry>
 
203
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
204
      ><manvolnum>3</manvolnum></citerefentry>,
 
205
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
206
      <manvolnum>8</manvolnum></citerefentry>,
 
207
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
208
      <manvolnum>5</manvolnum></citerefentry>
221
209
    </para>
 
210
 
 
211
    <variablelist>
 
212
      <varlistentry>
 
213
        <term>
 
214
          RFC 4291: <citetitle>IP Version 6 Addressing
 
215
          Architecture</citetitle>
 
216
        </term>
 
217
        <listitem>
 
218
          <variablelist>
 
219
            <varlistentry>
 
220
              <term>Section 2.2: <citetitle>Text Representation of
 
221
              Addresses</citetitle></term>
 
222
              <listitem><para/></listitem>
 
223
            </varlistentry>
 
224
            <varlistentry>
 
225
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
226
              Address</citetitle></term>
 
227
              <listitem><para/></listitem>
 
228
            </varlistentry>
 
229
            <varlistentry>
 
230
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
231
            Addresses</citetitle></term>
 
232
            <listitem>
 
233
              <para>
 
234
                The clients use IPv6 link-local addresses, which are
 
235
                immediately usable since a link-local addresses is
 
236
                automatically assigned to a network interfaces when it
 
237
                is brought up.
 
238
              </para>
 
239
            </listitem>
 
240
            </varlistentry>
 
241
          </variablelist>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
      <varlistentry>
 
245
        <term>
 
246
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
247
        </term>
 
248
        <listitem>
 
249
          <para>
 
250
            Zeroconf is the network protocol standard used by clients
 
251
            for finding the Mandos server on the local network.
 
252
          </para>
 
253
        </listitem>
 
254
      </varlistentry>
 
255
    </variablelist>
222
256
  </refsect1>
223
257
</refentry>
 
258
<!-- Local Variables: -->
 
259
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
260
<!-- time-stamp-end: "[\"']>" -->
 
261
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
262
<!-- End: -->