/mandos/trunk : revision 90

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.

files added:
mandos-options.xml

files modified:
Makefile

mandos.conf.xml

mandos.xml

overview.xml

Show diffs side-by-side

added added

removed removed

mandos-options.xml

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE simplesect PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

<!--

This file is used by both mandos(8) and mandos.conf(5), since these

options can be used both on the command line and in the config file.

-->

If this is specified, the server will only announce the service

and listen to requests on network interface

<replaceable>IF</replaceable>. Default is to use all available

interfaces. <emphasis>Note:</emphasis> a failure to bind to the

specified interface is not considered critical, and the server

does not exit.

</para>

If this option is used, the server will only listen to a specific

address. This must currently be an IPv6 address; an IPv4 address

can only be specified using the <quote><systemitem

class="ipaddress">::FFFF:192.0.2.3</systemitem></quote> format.

Also, if a link-local address is specified, an interface should be

set, since a link-local address is only valid on a single

interface. By default, the server will listen to all available

addresses.

</para>

If this option is used, the server will bind to that port. By

default, the server will listen to an arbitrary port given by the

operating system.

</para>

If the server is run in debug mode, it will run in the foreground

and print a lot of debugging information. The default is

<emphasis>not</emphasis> to run in debug mode.

</para>

GnuTLS priority string for the TLS handshake with the clients.

The default is

<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.

See <citerefentry><refentrytitle>gnutls_priority_init

</refentrytitle><manvolnum>3</manvolnum></citerefentry> for the

syntax. <emphasis>Warning</emphasis>: changing this may make the

TLS handshake fail, making communication with clients impossible.

</para>

Zeroconf service name. The default is

<quote><literal>Mandos</literal></quote>. This only needs to be

changed this if it, for some reason, is necessary to run more than

one server on the same <emphasis>host</emphasis>, which would not

normally be useful. If there are name collisions on the same

<emphasis>network</emphasis>, the newer server will automatically

rename itself to <quote><literal>Mandos #2</literal></quote>, and

so on; therefore, this option is not needed in that case.

</para>

</simplesect>

Older »