doc/anytun-controld.8

   1 '\" t
   2 .\"     Title: anytun-controld
   3 .\"    Author: [see the "AUTHORS" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/16/2010
   6 .\"    Manual: anytun-controld user manual
   7 .\"    Source: anytun 0.3.3
   8 .\"  Language: English
   9 .\"
  10 .TH "ANYTUN\-CONTROLD" "8" "02/16/2010" "anytun 0.3.3" "anytun-controld user manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 anytun-controld \- anycast tunneling control daemon
  23 .SH "SYNOPSIS"
  24 .sp
  25 .nf
  26 \fBanytun\-controld\fR
  27   [ \fB\-h|\-\-help\fR ]
  28   [ \fB\-D|\-\-nodaemonize\fR ]
  29   [ \fB\-u|\-\-username\fR <username> ]
  30   [ \fB\-g|\-\-groupname\fR <groupname> ]
  31   [ \fB\-C|\-\-chroot\fR <path> ]
  32   [ \fB\-P|\-\-write\-pid\fR <filename> ]
  33   [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ]
  34   [ \fB\-U|\-\-debug\fR ]
  35   [ \fB\-f|\-\-file\fR <path> ]
  36   [ \fB\-X|\-\-control\-host\fR < <host>[:port>] | :<port> > ]
  37 .fi
  38 .SH "DESCRIPTION"
  39 .sp
  40 \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\&.
  41 .SH "OPTIONS"
  42 .PP
  43 \fB\-D, \-\-nodaemonize\fR
  44 .RS 4
  45 This option instructs
  46 \fBanytun\-controld\fR
  47 to run in foreground instead of becoming a daemon which is the default\&.
  48 .RE
  49 .PP
  50 \fB\-u, \-\-username \fR\fB\fI<username>\fR\fR
  51 .RS 4
  52 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\&.
  53 .RE
  54 .PP
  55 \fB\-g, \-\-groupname \fR\fB\fI<groupname>\fR\fR
  56 .RS 4
  57 run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&.
  58 .RE
  59 .PP
  60 \fB\-C, \-\-chroot \fR\fB\fI<path>\fR\fR
  61 .RS 4
  62 Instruct
  63 \fBanytun\-controld\fR
  64 to run in a chroot jail\&. The default is to not run in chroot\&.
  65 .RE
  66 .PP
  67 \fB\-P, \-\-write\-pid \fR\fB\fI<filename>\fR\fR
  68 .RS 4
  69 Instruct
  70 \fBanytun\-controld\fR
  71 to write it\(cqs pid to this file\&. The default is to not create a pid file\&.
  72 .RE
  73 .PP
  74 \fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR
  75 .RS 4
  76 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\&.
  77
  78 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
  79 \fIsyslog:3,anytun\-controld,daemon\fR
  80 is added\&.
  81
  82 The following targets are supported:
  83 .PP
  84 \fIsyslog\fR
  85 .RS 4
  86 log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
  87 .RE
  88 .PP
  89 \fIfile\fR
  90 .RS 4
  91 log to file, parameters <level>[,<path>]
  92 .RE
  93 .PP
  94 \fIstdout\fR
  95 .RS 4
  96 log to standard output, parameters <level>
  97 .RE
  98 .PP
  99 \fIstderr\fR
 100 .RS 4
 101 log to standard error, parameters <level>
 102 .RE
 103 .RE
 104 .PP
 105 \fB\-U, \-\-debug\fR
 106 .RS 4
 107 This option instructs
 108 \fBAnytun\fR
 109 to run in debug mode\&. It implicits
 110 \fB\-D\fR
 111 (don\(cqt daemonize) and adds a log target with the configuration
 112 \fIstdout:5\fR
 113 (logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
 114 .RE
 115 .PP
 116 \fB\-f, \-\-file \fR\fB\fI<path>\fR\fR
 117 .RS 4
 118 The path to the file which holds the sync information\&.
 119 .RE
 120 .PP
 121 \fB\-X, \-\-control\-host \fR\fB\fI<hostname|ip>[:<port>]\fR\fR
 122 .RS 4
 123 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\&.
 124 .RE
 125 .SH "BUGS"
 126 .sp
 127 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\&.
 128 .SH "SEE ALSO"
 129 .sp
 130 anytun(8), anytun\-config(8), anytun\-showtables(8)
 131 .SH "AUTHORS"
 132 .sp
 133 Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Pointner <equinox@anytun\&.org>
 134 .SH "RESOURCES"
 135 .sp
 136 Main web site: http://www\&.anytun\&.org/
 137 .SH "COPYING"
 138 .sp
 139 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\&.