src/man/anytun-controld.8.txt

   1 anytun-controld(8)
   2 ==================
   3
   4 NAME
   5 ----
   6 anytun-controld - anycast tunneling control daemon
   7
   8 SYNOPSIS
   9 --------
  10
  11 *anytun-controld*
  12 [ *-h|--help* ]
  13 [ *-D|--nodaemonize* ]
  14 [ *-u|--username* <username> ]
  15 [ *-g|--groupname* <groupname> ]
  16 [ *-C|--chroot* <path> ]
  17 [ *-P|--write-pid* <filename> ]
  18 [ *-L|--log* <target>:<level>[,<param1>[,<param2>[..]]] ]
  19 [ *-f|--file* <path> ]
  20 [ *-X|--control-host* < <host>[:port>] | :<port> > ]
  21
  22 DESCRIPTION
  23 -----------
  24
  25 *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
  27 OPTIONS
  28 -------
  29
  30 -D|--nodaemonize
  31 ~~~~~~~~~~~~~~~~
  32
  33 This option instructs *anytun* to run in foreground
  34 instead of becoming a daemon which is the default.
  35
  36 -u|--username <username>
  37 ~~~~~~~~~~~~~~~~~~~~~~~~
  38
  39 run as this user. If no group is specified (*-g*) the default group of
  40 the user is used. The default is to not drop privileges.
  41
  42 -g|--groupname <groupname>
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  44
  45 run as this group. If no username is specified (*-u*) this gets ignored.
  46 The default is to not drop privileges.
  47
  48 -C|--chroot <path>
  49 ~~~~~~~~~~~~~~~~~~
  50
  51 Instruct *anytun* to run in a chroot jail. The default is
  52 to not run in chroot.
  53
  54 -P|--write-pid <filename>
  55 ~~~~~~~~~~~~~~~~~~~~~~~~~
  56
  57 Instruct *anytun* to write it's pid to this file. The default is
  58 to not create a pid file.
  59
  60 -L|--log <target>:<level>[,<param1>[,<param2>[..]]]
  61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62
  63 add log target to logging system. This can be invoked several times
  64 in order to log to different targets at the same time. Every target
  65 hast its own log level which is a number between 0 and 5. Where 0 means
  66 disabling log and 5 means debug messages are enabled.
  67
  68 The following targets are supported:
  69
  70 * *syslog* - log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
  71 * *file* - log to file, parameters <level>[,<path>]
  72 * *stdout* - log to standard output, parameters <level>
  73 * *stderr* - log to standard error, parameters <level>
  74
  75 The file target can be used more the once with different levels.
  76 If no target is provided at the command line a single target with the
  77 following config is added:
  78
  79 *syslog:3,uanytun,daemon*
  80
  81 -f|--file <path>
  82 ~~~~~~~~~~~~~~~~
  83
  84 The path to the file which holds the sync information.
  85
  86 -X|--control-host < <host>[:<port>] | :<port> >
  87 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88
  89 The local ip address and or tcp port to bind to. Mind that if an
  90 address is given the port can be omitted in which case port 2323
  91 is used. You can also specify to listen on an specific port but on
  92 all interfaces by omitting the address. If you want to specify an
  93 ipv6 address and a port you have to use [ and ] to seperate the address
  94 from the port, eg.: [::1]:1234. If you want to use the default port
  95 [ and ] can be omitted. default: 127.0.0.1:2323
  96
  97
  98 BUGS
  99 ----
 100 Most likely there are some bugs in *anytun*. If you find a bug, please let
 101 the developers know at satp@anytun.org. Of course, patches are preferred.
 102
 103 SEE ALSO
 104 --------
 105 anytun(8), anytun-config(8), anytun-showtables(8)
 106
 107 AUTHORS
 108 -------
 109 Design of SATP and wizards of this implementation:
 110
 111 Othmar Gsenger <otti@anytun.org>
 112 Erwin Nindl <nine@anytun.org>
 113 Christian Pointner <equinox@anytun.org>
 114
 115 Debian packaging:
 116
 117 Andreas Hirczy <ahi@itp.tu-graz.ac.at>
 118
 119 Manual page:
 120
 121 Alexander List <alex@debian.org>
 122
 123 RESOURCES
 124 ---------
 125
 126 Main web site: http://www.anytun.org/
 127
 128
 129 COPYING
 130 -------
 131
 132 Copyright \(C) 2007-2008 Othmar Gsenger, Erwin Nindl and Christian
 133 Pointner. This  program  is  free software;  you  can redistribute
 134 it and/or modify it under the terms of the GNU General Public License
 135 version 2 as published by the Free Software Foundation.
 136