From 6fa4295768f930a6d1c4a6077a34e7db36dff14e Mon Sep 17 00:00:00 2001
From: Christian Pointner <equinox@anytun.org>
Date: Sat, 28 Feb 2009 09:10:03 +0000
Subject: updated manpages

---
 src/man/anytun-controld.8.txt | 92 +++++++++++++++++++++++++++----------------
 1 file changed, 58 insertions(+), 34 deletions(-)

(limited to 'src/man/anytun-controld.8.txt')

diff --git a/src/man/anytun-controld.8.txt b/src/man/anytun-controld.8.txt
index e97daac..2b1c7a1 100644
--- a/src/man/anytun-controld.8.txt
+++ b/src/man/anytun-controld.8.txt
@@ -10,13 +10,14 @@ SYNOPSIS
 
 *anytun-controld*
 [ *-h|--help* ]
-[ *-f|--file* <path> ]
-[ *-X|--control-host* < <host>[:port>] | :<port> > ]
 [ *-D|--nodaemonize* ]
-[ *-C|--chroot* ]
 [ *-u|--username* <username> ]
-[ *-H|--chroot-dir* <path> ]
-[ *-P|--write-pid* <path> ]
+[ *-g|--groupname* <groupname> ]
+[ *-C|--chroot* <path> ]
+[ *-P|--write-pid* <filename> ]
+[ *-L|--log* <target>:<level>[,<param1>[,<param2>[..]]] ]
+[ *-f|--file* <path> ]
+[ *-X|--control-host* < <host>[:port>] | :<port> > ]
 
 DESCRIPTION
 -----------
@@ -26,49 +27,72 @@ DESCRIPTION
 OPTIONS
 -------
 
--f|--file <path>
+-D|--nodaemonize
 ~~~~~~~~~~~~~~~~
 
-The path to the config file.
+This option instructs *anytun* to run in foreground
+instead of becoming a daemon which is the default.
 
--X|--control-host < <host>[:<port>] | :<port> >
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-u|--username <username>
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-The local ip address and or tcp port to bind to. Mind that if an 
-address is given the port can be omitted in which case port 2323 
-is used. You can also specify to listen on an specific port but on
-all interfaces by omitting the address. If you want to specify an
-ipv6 address and a port you have to use [ and ] to seperate the address
-from the port, eg.: [::1]:1234. If you want to use the default port 
-[ and ] can be omitted. default: 127.0.0.1:2323
+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.
 
--D|--nodaemonize
-~~~~~~~~~~~~~~~~
+-g|--groupname <groupname>
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This option instructs *anytun-controld* to run in the foreground
-instead of becoming a daemon which is the default.
+run as this group. If no username is specified (*-u*) this gets ignored.
+The default is to not drop privileges.
 
--C|--chroot
-~~~~~~~~~~~
+-C|--chroot <path>
+~~~~~~~~~~~~~~~~~~
 
-Instruct *anytun* to run in a chroot chail and drop privileges. The 
-default is not to run in chroot.
+Instruct *anytun* to run in a chroot jail. The default is 
+to not run in chroot.
 
--u|--username <username>
-~~~~~~~~~~~~~~~~~~~~~~~~
+-P|--write-pid <filename>
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Instruct *anytun* to write it's pid to this file. The default is 
+to not create a pid file.
+
+-L|--log <target>:<level>[,<param1>[,<param2>[..]]]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-if chroot change to this user. default: nobody
+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.
 
--H|--chroot-dir <directory>
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The following targets are supported:
+
+* *syslog* - log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
+* *file* - log to file, parameters <level>[,<path>]
+* *stdout* - log to standard output, parameters <level>
+* *stderr* - log to standard error, parameters <level> 
+
+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 
+following config is added:
+
+*syslog:3,uanytun,daemon*
+
+-f|--file <path>
+~~~~~~~~~~~~~~~~
 
-chroot to this directory. default: /var/run/anytun-controld
+The path to the file which holds the sync information.
 
--P|--write-pid <path>
-~~~~~~~~~~~~~~~~~~~~~
+-X|--control-host < <host>[:<port>] | :<port> >
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Instruct *anytun-controld* to write it's pid to this file. 
-The default is not to create a pid file.
+The local ip address and or tcp port to bind to. Mind that if an 
+address is given the port can be omitted in which case port 2323 
+is used. You can also specify to listen on an specific port but on
+all interfaces by omitting the address. If you want to specify an
+ipv6 address and a port you have to use [ and ] to seperate the address
+from the port, eg.: [::1]:1234. If you want to use the default port 
+[ and ] can be omitted. default: 127.0.0.1:2323
 
 
 BUGS
-- 
cgit v1.2.3