Import NMU for version 0.3.6-0.1
[anytun.git] / doc / anytun-controld.8
1 '\" t
2 .\"     Title: anytun-controld
3 .\"    Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5 .\"      Date: 07/08/2016
6 .\"    Manual: \ \&
7 .\"    Source: \ \&
8 .\"  Language: English
9 .\"
10 .TH "ANYTUN\-CONTROLD" "8" "07/08/2016" "\ \&" "\ \&"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 anytun-controld \- anycast tunneling control daemon
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fBanytun\-controld\fR
36   [ \fB\-h|\-\-help\fR ]
37   [ \fB\-D|\-\-nodaemonize\fR ]
38   [ \fB\-u|\-\-username\fR <username> ]
39   [ \fB\-g|\-\-groupname\fR <groupname> ]
40   [ \fB\-C|\-\-chroot\fR <path> ]
41   [ \fB\-P|\-\-write\-pid\fR <filename> ]
42   [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ]
43   [ \fB\-U|\-\-debug\fR ]
44   [ \fB\-f|\-\-file\fR <path> ]
45   [ \fB\-X|\-\-control\-host\fR < <host>[:port>] | :<port> > ]
46 .fi
47 .SH "DESCRIPTION"
48 .sp
49 \fBanytun\-controld\fR configures the multi\-connection support for \fBAnytun\fR\&. It reads a connection/routing table and outputs it via a tcp socket to all connected \fBAnytun\fR servers\&. When the control daemon is restarted with a new connection/routing table all \fBAnytun\fR servers automatically load the new configuration\&. Please make sure to protect that information as it contains the connection keys\&.
50 .SH "OPTIONS"
51 .PP
52 \fB\-D, \-\-nodaemonize\fR
53 .RS 4
54 This option instructs
55 \fBanytun\-controld\fR
56 to run in foreground instead of becoming a daemon which is the default\&.
57 .RE
58 .PP
59 \fB\-u, \-\-username \fR\fB\fI<username>\fR\fR
60 .RS 4
61 run as this user\&. If no group is specified (\fB\-g\fR) the default group of the user is used\&. The default is to not drop privileges\&.
62 .RE
63 .PP
64 \fB\-g, \-\-groupname \fR\fB\fI<groupname>\fR\fR
65 .RS 4
66 run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&.
67 .RE
68 .PP
69 \fB\-C, \-\-chroot \fR\fB\fI<path>\fR\fR
70 .RS 4
71 Instruct
72 \fBanytun\-controld\fR
73 to run in a chroot jail\&. The default is to not run in chroot\&.
74 .RE
75 .PP
76 \fB\-P, \-\-write\-pid \fR\fB\fI<filename>\fR\fR
77 .RS 4
78 Instruct
79 \fBanytun\-controld\fR
80 to write it\(cqs pid to this file\&. The default is to not create a pid file\&.
81 .RE
82 .PP
83 \fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR
84 .RS 4
85 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\&.
86
87 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
88 \fIsyslog:3,anytun\-controld,daemon\fR
89 is added\&.
90
91 The following targets are supported:
92 .PP
93 \fIsyslog\fR
94 .RS 4
95 log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
96 .RE
97 .PP
98 \fIfile\fR
99 .RS 4
100 log to file, parameters <level>[,<path>]
101 .RE
102 .PP
103 \fIstdout\fR
104 .RS 4
105 log to standard output, parameters <level>
106 .RE
107 .PP
108 \fIstderr\fR
109 .RS 4
110 log to standard error, parameters <level>
111 .RE
112 .RE
113 .PP
114 \fB\-U, \-\-debug\fR
115 .RS 4
116 This option instructs
117 \fBAnytun\fR
118 to run in debug mode\&. It implicits
119 \fB\-D\fR
120 (don\(cqt daemonize) and adds a log target with the configuration
121 \fIstdout:5\fR
122 (logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
123 .RE
124 .PP
125 \fB\-f, \-\-file \fR\fB\fI<path>\fR\fR
126 .RS 4
127 The path to the file which holds the sync information\&.
128 .RE
129 .PP
130 \fB\-X, \-\-control\-host \fR\fB\fI<hostname|ip>[:<port>]\fR\fR
131 .RS 4
132 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 separate the address from the port, eg\&.: [::1]:1234\&. If you want to use the default port [ and ] can be omitted\&.
133 .RE
134 .SH "BUGS"
135 .sp
136 Most likely there are some bugs in \fBAnytun\fR\&. If you find a bug, please let the developers know at satp@anytun\&.org\&. Of course, patches are preferred\&.
137 .SH "SEE ALSO"
138 .sp
139 anytun(8), anytun\-config(8), anytun\-showtables(8)
140 .SH "AUTHORS"
141 .sp
142 Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Pointner <equinox@anytun\&.org>
143 .SH "RESOURCES"
144 .sp
145 Main web site: http://www\&.anytun\&.org/
146 .SH "COPYING"
147 .sp
148 Copyright (C) 2007\-2014 Markus Grüneis, 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\&.