/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-options.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-options.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
2
<!DOCTYPE simplesect PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4
4
 
5
5
<!--
7
7
options can be used both on the command line and in the config file.
8
8
-->
9
9
 
10
 
<section>
 
10
<simplesect>
11
11
  <title/>
12
12
  
13
13
  <para id="interface">
16
16
    <replaceable>IF</replaceable>.  Default is to use all available
17
17
    interfaces.  <emphasis>Note:</emphasis> a failure to bind to the
18
18
    specified interface is not considered critical, and the server
19
 
    does not exit, but will instead continue starting normally.
 
19
    does not exit.
20
20
  </para>
21
21
  
22
22
  <para id="address">
23
 
    If this option is used, the server will only listen to the
24
 
    specified IPv6 address.  If a link-local address is specified, an
25
 
    interface should be set, since a link-local address is only valid
26
 
    on a single interface.  By default, the server will listen to all
27
 
    available addresses.  If set, this must be an IPv6 address; an
28
 
    IPv4 address can only be specified using the <quote><systemitem
29
 
    class="ipaddress">::FFFF:192.0.2.3</systemitem ></quote> format.
 
23
    If this option is used, the server will only listen to a specific
 
24
    address.  This must currently be an IPv6 address; an IPv4 address
 
25
    can only be specified using the <quote><systemitem
 
26
    class="ipaddress">::FFFF:192.0.2.3</systemitem></quote> format.
 
27
    Also, if a link-local address is specified, an interface should be
 
28
    set, since a link-local address is only valid on a single
 
29
    interface.  By default, the server will listen to all available
 
30
    addresses.
30
31
  </para>
31
32
  
32
33
  <para id="port">
62
63
    so on; therefore, this option is not needed in that case.
63
64
  </para>
64
65
  
65
 
</section>
 
66
</simplesect>