updated manpages
[anytun.git] / src / man / anytun-controld.8.txt
blobe97daac4d3d63b50131ed6bb437ee215f7393321
1 anytun-controld(8)
2 ==================
4 NAME
5 ----
6 anytun-controld - anycast tunneling control daemon
8 SYNOPSIS
9 --------
11 *anytun-controld*
12 [ *-h|--help* ]
13 [ *-f|--file* <path> ]
14 [ *-X|--control-host* < <host>[:port>] | :<port> > ]
15 [ *-D|--nodaemonize* ]
16 [ *-C|--chroot* ]
17 [ *-u|--username* <username> ]
18 [ *-H|--chroot-dir* <path> ]
19 [ *-P|--write-pid* <path> ]
21 DESCRIPTION
22 -----------
24 *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.
26 OPTIONS
27 -------
29 -f|--file <path>
30 ~~~~~~~~~~~~~~~~
32 The path to the config file.
34 -X|--control-host < <host>[:<port>] | :<port> >
35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 The local ip address and or tcp port to bind to. Mind that if an 
38 address is given the port can be omitted in which case port 2323 
39 is used. You can also specify to listen on an specific port but on
40 all interfaces by omitting the address. If you want to specify an
41 ipv6 address and a port you have to use [ and ] to seperate the address
42 from the port, eg.: [::1]:1234. If you want to use the default port 
43 [ and ] can be omitted. default: 127.0.0.1:2323
45 -D|--nodaemonize
46 ~~~~~~~~~~~~~~~~
48 This option instructs *anytun-controld* to run in the foreground
49 instead of becoming a daemon which is the default.
51 -C|--chroot
52 ~~~~~~~~~~~
54 Instruct *anytun* to run in a chroot chail and drop privileges. The 
55 default is not to run in chroot.
57 -u|--username <username>
58 ~~~~~~~~~~~~~~~~~~~~~~~~
60 if chroot change to this user. default: nobody
62 -H|--chroot-dir <directory>
63 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
65 chroot to this directory. default: /var/run/anytun-controld
67 -P|--write-pid <path>
68 ~~~~~~~~~~~~~~~~~~~~~
70 Instruct *anytun-controld* to write it's pid to this file. 
71 The default is not to create a pid file.
74 BUGS
75 ----
76 Most likely there are some bugs in *anytun*. If you find a bug, please let
77 the developers know at satp@anytun.org. Of course, patches are preferred.
79 SEE ALSO
80 --------
81 anytun(8), anytun-config(8), anytun-showtables(8)
83 AUTHORS
84 -------
85 Design of SATP and wizards of this implementation:
87 Othmar Gsenger <otti@anytun.org>
88 Erwin Nindl <nine@anytun.org>
89 Christian Pointner <equinox@anytun.org>
91 Debian packaging:
93 Andreas Hirczy <ahi@itp.tu-graz.ac.at>
95 Manual page:
97 Alexander List <alex@debian.org>
99 RESOURCES
100 ---------
102 Main web site: http://www.anytun.org/
105 COPYING
106 -------
108 Copyright \(C) 2007-2008 Othmar Gsenger, Erwin Nindl and Christian
109 Pointner. This  program  is  free software;  you  can redistribute
110 it and/or modify it under the terms of the GNU General Public License
111 version 2 as published by the Free Software Foundation.