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