doc/anytun-controld.8.txt

   1 anytun-controld(8)
   2 ==================
   3
   4 NAME
   5 ----
   6
   7 anytun-controld - anycast tunneling control daemon
   8
   9 SYNOPSIS
  10 --------
  11
  12 ....
  13 anytun-controld
  14   [ -h|--help ]
  15   [ -D|--nodaemonize ]
  16   [ -u|--username <username> ]
  17   [ -g|--groupname <groupname> ]
  18   [ -C|--chroot <path> ]
  19   [ -P|--write-pid <filename> ]
  20   [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]] ]
  21   [ -U|--debug ]
  22   [ -f|--file <path> ]
  23   [ -X|--control-host < <host>[:port>] | :<port> > ]
  24 ....
  25
  26 DESCRIPTION
  27 -----------
  28
  29 *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.
  30
  31 OPTIONS
  32 -------
  33
  34 *-D, --nodaemonize*::
  35    This option instructs *anytun-controld* to run in foreground
  36    instead of becoming a daemon which is the default.
  37
  38 *-u, --username '<username>'*::
  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    run as this group. If no username is specified (*-u*) this gets ignored.
  44    The default is to not drop privileges.
  45
  46 *-C, --chroot '<path>'*::
  47    Instruct *anytun-controld* to run in a chroot jail. The default is
  48    to not run in chroot.
  49
  50 *-P, --write-pid '<filename>'*::
  51    Instruct *anytun-controld* to write it's pid to this file. The default is
  52    to not create a pid file.
  53
  54 *-L, --log '<target>:<level>[,<param1>[,<param2>[..]]]'*::
  55    add log target to logging system. This can be invoked several times
  56    in order to log to different targets at the same time. Every target
  57    hast its own log level which is a number between 0 and 5. Where 0 means
  58    disabling log and 5 means debug messages are enabled. +
  59    The file target can be used more the once with different levels.
  60    If no target is provided at the command line a single target with the
  61    config 'syslog:3,anytun-controld,daemon' is added. +
  62    The following targets are supported:
  63
  64    'syslog';; log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
  65    'file';; log to file, parameters <level>[,<path>]
  66    'stdout';; log to standard output, parameters <level>
  67    'stderr';; log to standard error, parameters <level>
  68
  69 *-U, --debug*::
  70    This option instructs *Anytun* to run in debug mode. It implicits *-D*
  71    (don't daemonize) and adds a log target with the configuration
  72    'stdout:5' (logging with maximum level). In future releases there might
  73    be additional output when this option is supplied.
  74
  75 *-f, --file '<path>'*::
  76    The path to the file which holds the sync information.
  77
  78 *-X, --control-host '<hostname|ip>[:<port>]'*::
  79    fetch the config from this host. The default is not to use a control
  80    host and therefore this is empty. Mind that the port can be omitted
  81    in which case port 2323 is used. If you want to specify an
  82    ipv6 address and a port you have to use [ and ] to separate the address
  83    from the port, eg.: [::1]:1234. If you want to use the default port
  84    [ and ] can be omitted.
  85
  86
  87 BUGS
  88 ----
  89 Most likely there are some bugs in *Anytun*. If you find a bug, please let
  90 the developers know at satp@anytun.org. Of course, patches are preferred.
  91
  92 SEE ALSO
  93 --------
  94 anytun(8), anytun-config(8), anytun-showtables(8)
  95
  96 AUTHORS
  97 -------
  98
  99 Othmar Gsenger <otti@anytun.org>
 100 Erwin Nindl <nine@anytun.org>
 101 Christian Pointner <equinox@anytun.org>
 102
 103
 104 RESOURCES
 105 ---------
 106
 107 Main web site: http://www.anytun.org/
 108
 109
 110 COPYING
 111 -------
 112
 113 Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian
 114 Pointner. This  program is  free software: you can redistribute it
 115 and/or modify it under the terms of the GNU General Public License
 116 as published by the Free Software Foundation, either version 3 of
 117 the License, or any later version.
 118