From 88f272bac7af8c021f0bd272dbc841441279f5c7 Mon Sep 17 00:00:00 2001 From: Christian Pointner Date: Thu, 11 Feb 2010 10:57:11 +0000 Subject: cleaned up manpages --- doc/anytun.8.txt | 107 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 54 insertions(+), 53 deletions(-) (limited to 'doc/anytun.8.txt') diff --git a/doc/anytun.8.txt b/doc/anytun.8.txt index 230558e..00d3e91 100644 --- a/doc/anytun.8.txt +++ b/doc/anytun.8.txt @@ -3,6 +3,7 @@ anytun(8) NAME ---- + anytun - anycast tunneling daemon SYNOPSIS @@ -66,44 +67,44 @@ passed to the daemon: This option instructs *Anytun* to run in foreground instead of becoming a daemon which is the default. -*-u, --username *:: +*-u, --username ''*:: run as this user. If no group is specified (*-g*) the default group of the user is used. The default is to not drop privileges. -*-g, --groupname *:: +*-g, --groupname ''*:: run as this group. If no username is specified (*-u*) this gets ignored. The default is to not drop privileges. -*-C, --chroot *:: +*-C, --chroot ''*:: Instruct *Anytun* to run in a chroot jail. The default is to not run in chroot. -*-P, --write-pid *:: +*-P, --write-pid ''*:: Instruct *Anytun* to write it's pid to this file. The default is to not create a pid file. -*-L, --log :[,[,[..]]]*:: +*-L, --log ':[,[,[..]]]'*:: add log target to logging system. This can be invoked several times in order to log to different targets at the same time. Every target hast its own log level which is a number between 0 and 5. Where 0 means disabling log and 5 means debug messages are enabled. + The file target can be used more the once with different levels. If no target is provided at the command line a single target with the - config *syslog:3,anytun,daemon* is added. + + config 'syslog:3,anytun,daemon' is added. + The following targets are supported: - *syslog*;; log to syslog daemon, parameters [,[,]] - *file*;; log to file, parameters [,] - *stdout*;; log to standard output, parameters - *stderr*;; log to standard error, parameters + 'syslog';; log to syslog daemon, parameters [,[,]] + 'file';; log to file, parameters [,] + 'stdout';; log to standard output, parameters + 'stderr';; log to standard error, parameters *-U, --debug*:: This option instructs *Anytun* to run in debug mode. It implicits *-D* (don't daemonize) and adds a log target with the configuration - *stdout:5* (logging with maximum level). In future releases there might + 'stdout:5' (logging with maximum level). In future releases there might be additional output when this option is supplied. -*-i, --interface *:: +*-i, --interface ''*:: This IP address is used as the sender address for outgoing packets. In case of anycast tunnel endpoints, the anycast IP has to be used. In case of unicast endpoints, the @@ -111,20 +112,20 @@ passed to the daemon: table. The default is to not use a special inteface and just bind on all interfaces. -*-p, --port *:: +*-p, --port ''*:: The local UDP port that is used to send and receive the payload data. The two tunnel endpoints can use different ports. If a tunnel endpoint consists of multiple anycast hosts, all hosts have to use the same port. default: 4444 -*-r, --remote-host *:: +*-r, --remote-host ''*:: This option can be used to specify the remote tunnel endpoint. In case of anycast tunnel endpoints, the anycast IP address has to be used. If you do not specify an address, it is automatically determined after receiving the first data packet. -*-o, --remote-port *:: +*-o, --remote-port ''*:: The UDP port used for payload data by the remote host (specified with -p on the remote host). If you do not specify a port, it is automatically determined after receiving @@ -138,7 +139,7 @@ passed to the daemon: Resolv to IPv6 addresses only. The default is to resolv both IPv4 and IPv6 addresses. -*-I, --sync-interface *:: +*-I, --sync-interface ''*:: local unicast(sync) ip address to bind to + This option is only needed for tunnel endpoints consisting of multiple anycast hosts. The unicast IP address of @@ -147,7 +148,7 @@ passed to the daemon: not use a special inteface and just bind on all interfaces. However this is only the case if synchronisation is active see *--sync-port*. -*-S, --sync-port *:: +*-S, --sync-port ''*:: local unicast(sync) port to bind to + This option is only needed for tunnel endpoints consisting of multiple anycast hosts. This port is used @@ -160,7 +161,7 @@ passed to the daemon: and unprotected by default. It is advised to protect this port using firewall rules and, eventually, IPsec. -*-M, --sync-hosts [:],[[:][...]]*:: +*-M, --sync-hosts '[:],[[:][...]]'*:: remote hosts to sync with + This option is only needed for tunnel endpoints consisting of multiple anycast hosts. Here, one has to specify all @@ -172,7 +173,7 @@ passed to the daemon: from the port, eg.: [::1]:1234. If you want to use the default port [ and ] can be omitted. -*-X, --control-host [:]*:: +*-X, --control-host '[:]'*:: fetch the config from this host. The default is not to use a control host and therefore this is empty. Mind that the port can be omitted in which case port 2323 is used. If you want to specify an @@ -180,41 +181,41 @@ passed to the daemon: from the port, eg.: [::1]:1234. If you want to use the default port [ and ] can be omitted. -*-d, --dev *:: +*-d, --dev ''*:: device name + By default, tapN is used for Ethernet tunnel interfaces, and tunN for IP tunnels, respectively. This option can be used to manually override these defaults. -*-t, --type *:: +*-t, --type ''*:: device type + Type of the tunnels to create. Use tap for Ethernet tunnels, tun for IP tunnels. -*-n, --ifconfig /*:: +*-n, --ifconfig '/'*:: The local IP address and prefix length. The remote tunnel endpoint has to use a different IP address in the same subnet. - **;; the local IP address for the tun/tap device - **;; the prefix length of the network + '';; the local IP address for the tun/tap device + '';; the prefix length of the network -*-x, --post-up-script