/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-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

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 TIMESTAMP "2008-08-30">
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
 
14
    <productname>Mandos</productname>
14
15
    <productnumber>&VERSION;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
15
17
    <authorgroup>
16
18
      <author>
17
19
        <firstname>Björn</firstname>
71
73
  </refnamediv>
72
74
 
73
75
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
76
    <synopsis>&CONFPATH;</synopsis>
77
77
  </refsynopsisdiv>
78
78
 
79
79
  <refsect1 id="description">
100
100
    
101
101
    <variablelist>
102
102
      <varlistentry>
103
 
        <term><varname>interface</varname></term>
 
103
        <term><option>interface<literal> = </literal><replaceable
 
104
        >NAME</replaceable></option></term>
104
105
        <listitem>
105
 
          <synopsis><literal>interface = </literal><replaceable
106
 
          >NAME</replaceable>
107
 
          </synopsis>
108
106
          <xi:include href="mandos-options.xml" xpointer="interface"/>
109
107
        </listitem>
110
108
      </varlistentry>
111
109
 
112
110
      <varlistentry>
113
 
        <term><varname>address</varname></term>
 
111
        <term><option>address<literal> = </literal><replaceable
 
112
          >ADDRESS</replaceable></option></term>
114
113
        <listitem>
115
 
          <synopsis><literal>address = </literal><replaceable
116
 
          >ADDRESS</replaceable>
117
 
          </synopsis>
118
114
          <xi:include href="mandos-options.xml" xpointer="address"/>
119
115
        </listitem>
120
116
      </varlistentry>
121
117
 
122
118
      <varlistentry>
123
 
        <term><varname>port</varname></term>
 
119
        <term><option>port<literal> = </literal><replaceable
 
120
        >NUMBER</replaceable></option></term>
124
121
        <listitem>
125
 
          <synopsis><literal>port = </literal><replaceable
126
 
          >NUMBER</replaceable>
127
 
          </synopsis>
128
122
          <xi:include href="mandos-options.xml" xpointer="port"/>
129
123
        </listitem>
130
124
      </varlistentry>
131
125
 
132
126
      <varlistentry>
133
 
        <term><varname>debug</varname></term>
134
 
        <listitem>
135
 
          <synopsis><literal>debug = </literal>{ <literal
 
127
        <term><option>debug<literal> = </literal>{ <literal
136
128
          >1</literal> | <literal>yes</literal> | <literal
137
129
          >true</literal> | <literal>on</literal> | <literal
138
130
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }
140
 
          </synopsis>
 
131
          >false</literal> | <literal>off</literal> }</option></term>
 
132
        <listitem>
141
133
          <xi:include href="mandos-options.xml" xpointer="debug"/>
142
134
        </listitem>
143
135
      </varlistentry>
144
136
 
145
137
      <varlistentry>
146
 
        <term><varname>priority</varname></term>
 
138
        <term><option>priority<literal> = </literal><replaceable
 
139
        >STRING</replaceable></option></term>
147
140
        <listitem>
148
 
          <synopsis><literal>priority = </literal><replaceable
149
 
          >STRING</replaceable>
150
 
          </synopsis>
151
141
          <xi:include href="mandos-options.xml" xpointer="priority"/>
152
142
        </listitem>
153
143
      </varlistentry>
154
144
 
155
145
      <varlistentry>
156
 
        <term><varname>servicename</varname></term>
 
146
        <term><option>servicename<literal> = </literal
 
147
        ><replaceable>NAME</replaceable></option></term>
157
148
        <listitem>
158
 
          <synopsis><literal>servicename = </literal><replaceable
159
 
          >NAME</replaceable>
160
 
          </synopsis>
161
149
          <xi:include href="mandos-options.xml"
162
150
                      xpointer="servicename"/>
163
151
        </listitem>
212
200
  <refsect1 id="see_also">
213
201
    <title>SEE ALSO</title>
214
202
    <para>
215
 
      <citerefentry>
216
 
        <refentrytitle>mandos</refentrytitle>
217
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
218
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
219
 
        <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>
220
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>
221
256
  </refsect1>
222
257
</refentry>
 
258
<!-- Local Variables: -->
 
259
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
260
<!-- time-stamp-end: "[\"']>" -->
 
261
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
262
<!-- End: -->