summaryrefslogtreecommitdiff
path: root/src/man/anytun-controld.8.txt
blob: e97daac4d3d63b50131ed6bb437ee215f7393321 (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
111
112
anytun-controld(8)
==================

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

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> ]

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

-f|--file <path>
~~~~~~~~~~~~~~~~

The path to the config file.

-X|--control-host < <host>[:<port>] | :<port> >
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

-D|--nodaemonize
~~~~~~~~~~~~~~~~

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

-C|--chroot
~~~~~~~~~~~

Instruct *anytun* to run in a chroot chail and drop privileges. The 
default is not to run in chroot.

-u|--username <username>
~~~~~~~~~~~~~~~~~~~~~~~~

if chroot change to this user. default: nobody

-H|--chroot-dir <directory>
~~~~~~~~~~~~~~~~~~~~~~~~~~~

chroot to this directory. default: /var/run/anytun-controld

-P|--write-pid <path>
~~~~~~~~~~~~~~~~~~~~~

Instruct *anytun-controld* to write it's pid to this file. 
The default is not to create a pid file.


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
-------
Design of SATP and wizards of this implementation:

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

Debian packaging:

Andreas Hirczy <ahi@itp.tu-graz.ac.at>

Manual page:

Alexander List <alex@debian.org>

RESOURCES
---------

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


COPYING
-------

Copyright \(C) 2007-2008 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
version 2 as published by the Free Software Foundation.