summaryrefslogtreecommitdiff
path: root/doc/anytun-controld.8.txt
blob: 0d3e0b8a4670bd7885db002f509788f32bbd5094 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
anytun-controld(8)
==================

NAME
----
anytun-controld - anycast tunneling control daemon

SYNOPSIS
--------

....
anytun-controld
  [ -h|--help ]
  [ -D|--nodaemonize ]
  [ -u|--username <username> ]
  [ -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
-----------

*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.

OPTIONS
-------

*-D, --nodaemonize*::
   This option instructs *anytun-controld* to run in foreground
   instead of becoming a daemon which is the default.

*-u, --username <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 <groupname>*::
   run as this group. If no username is specified (*-u*) this gets ignored.
   The default is to not drop privileges.

*-C, --chroot <path>*::
   Instruct *anytun-controld* to run in a chroot jail. The default is 
   to not run in chroot.

*-P, --write-pid <filename>*::
   Instruct *anytun-controld* to write it's pid to this file. The default is 
   to not create a pid file.

*-L, --log <target>:<level>[,<param1>[,<param2>[..]]]*::
   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-controld,daemon* is added. +
   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> 

*-f, --file <path>*::
   The path to the file which holds the sync information.

*-X, --control-host <hostname|ip>[:<port>]*::
   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
   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.


BUGS
----
Most likely there are some bugs in *Anytun*. If you find a bug, please let
the developers know at satp@anytun.org. Of course, patches are preferred.

SEE ALSO
--------
anytun(8), anytun-config(8), anytun-showtables(8)

AUTHORS
-------

Othmar Gsenger <otti@anytun.org>
Erwin Nindl <nine@anytun.org>
Christian Pointner <equinox@anytun.org>


RESOURCES
---------

Main web site: http://www.anytun.org/


COPYING
-------

Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian
Pointner. This  program is  free software: you can redistribute it 
and/or modify it under the terms of the GNU General Public License 
as published by the Free Software Foundation, either version 3 of 
the License, or any later version.