Imported Upstream version 0.3.2
[anytun.git] / src / man / anytun-controld.8.txt
1 anytun-controld(8)
2 ==================
3
4 NAME
5 ----
6 anytun-controld - anycast tunneling control daemon
7
8 SYNOPSIS
9 --------
10
11 ....
12 anytun-controld
13   [ -h|--help ]
14   [ -D|--nodaemonize ]
15   [ -u|--username <username> ]
16   [ -g|--groupname <groupname> ]
17   [ -C|--chroot <path> ]
18   [ -P|--write-pid <filename> ]
19   [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ]
20   [ -f|--file <path> ]
21   [ -X|--control-host < <host>[:port>] | :<port> > ]
22 ....
23
24 DESCRIPTION
25 -----------
26
27 *anytun-controld* configures the multi-connection support for *Anytun*. It reads a connection/routing table and outputs it via a tcp socket to all connected *Anytun* servers. When the control daemon is restarted with a new connection/routing table all *Anytun* servers automatically load the new configuration. Please make sure to protect that information as it contains the connection keys.
28
29 OPTIONS
30 -------
31
32 *-D, --nodaemonize*::
33    This option instructs *anytun-controld* to run in foreground
34    instead of becoming a daemon which is the default.
35
36 *-u, --username <username>*::
37    run as this user. If no group is specified (*-g*) the default group of 
38    the user is used. The default is to not drop privileges.
39
40 *-g, --groupname <groupname>*::
41    run as this group. If no username is specified (*-u*) this gets ignored.
42    The default is to not drop privileges.
43
44 *-C, --chroot <path>*::
45    Instruct *anytun-controld* to run in a chroot jail. The default is 
46    to not run in chroot.
47
48 *-P, --write-pid <filename>*::
49    Instruct *anytun-controld* to write it's pid to this file. The default is 
50    to not create a pid file.
51
52 *-L, --log <target>:<level>[,<param1>[,<param2>[..]]]*::
53    add log target to logging system. This can be invoked several times
54    in order to log to different targets at the same time. Every target 
55    hast its own log level which is a number between 0 and 5. Where 0 means
56    disabling log and 5 means debug messages are enabled. +
57    The file target can be used more the once with different levels.
58    If no target is provided at the command line a single target with the 
59    config *syslog:3,anytun-controld,daemon* is added. +
60    The following targets are supported:
61
62    *syslog*;; log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
63    *file*;; log to file, parameters <level>[,<path>]
64    *stdout*;; log to standard output, parameters <level>
65    *stderr*;; log to standard error, parameters <level> 
66
67 *-f, --file <path>*::
68    The path to the file which holds the sync information.
69
70 *-X, --control-host <hostname|ip>[:<port>]*::
71    fetch the config from this host. The default is not to use a control
72    host and therefore this is empty. Mind that the port can be omitted 
73    in which case port 2323 is used. If you want to specify an
74    ipv6 address and a port you have to use [ and ] to seperate the address
75    from the port, eg.: [::1]:1234. If you want to use the default port 
76    [ and ] can be omitted.
77
78
79 BUGS
80 ----
81 Most likely there are some bugs in *Anytun*. If you find a bug, please let
82 the developers know at satp@anytun.org. Of course, patches are preferred.
83
84 SEE ALSO
85 --------
86 anytun(8), anytun-config(8), anytun-showtables(8)
87
88 AUTHORS
89 -------
90
91 Othmar Gsenger <otti@anytun.org>
92 Erwin Nindl <nine@anytun.org>
93 Christian Pointner <equinox@anytun.org>
94
95
96 RESOURCES
97 ---------
98
99 Main web site: http://www.anytun.org/
100
101
102 COPYING
103 -------
104
105 Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian
106 Pointner. This  program is  free software: you can redistribute it 
107 and/or modify it under the terms of the GNU General Public License 
108 as published by the Free Software Foundation, either version 3 of 
109 the License, or any later version.
110