debian/anytun-controld.8

   1 '\" t
   2 .\"     Title: anytun-controld
   3 .\"    Author: [see the "AUTHORS" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 12/14/2009
   6 .\"    Manual: anytun-controld user manual
   7 .\"    Source: anytun 0.3.2
   8 .\"  Language: English
   9 .\"
  10 .TH "ANYTUN\-CONTROLD" "8" "12/14/2009" "anytun 0.3.2" "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\-f|\-\-file\fR <path> ]
  35   [ \fB\-X|\-\-control\-host\fR < <host>[:port>] | :<port> > ]
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 \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\&.
  40 .SH "OPTIONS"
  41 .PP
  42 \fB\-D, \-\-nodaemonize\fR
  43 .RS 4
  44 This option instructs
  45 \fBanytun\-controld\fR
  46 to run in foreground instead of becoming a daemon which is the default\&.
  47 .RE
  48 .PP
  49 \fB\-u, \-\-username <username>\fR
  50 .RS 4
  51 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\&.
  52 .RE
  53 .PP
  54 \fB\-g, \-\-groupname <groupname>\fR
  55 .RS 4
  56 run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&.
  57 .RE
  58 .PP
  59 \fB\-C, \-\-chroot <path>\fR
  60 .RS 4
  61 Instruct
  62 \fBanytun\-controld\fR
  63 to run in a chroot jail\&. The default is to not run in chroot\&.
  64 .RE
  65 .PP
  66 \fB\-P, \-\-write\-pid <filename>\fR
  67 .RS 4
  68 Instruct
  69 \fBanytun\-controld\fR
  70 to write it\(cqs pid to this file\&. The default is to not create a pid file\&.
  71 .RE
  72 .PP
  73 \fB\-L, \-\-log <target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR
  74 .RS 4
  75 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\&.
  76
  77 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
  78 \fBsyslog:3,anytun\-controld,daemon\fR
  79 is added\&.
  80
  81 The following targets are supported:
  82 .PP
  83 \fBsyslog\fR
  84 .RS 4
  85 log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
  86 .RE
  87 .PP
  88 \fBfile\fR
  89 .RS 4
  90 log to file, parameters <level>[,<path>]
  91 .RE
  92 .PP
  93 \fBstdout\fR
  94 .RS 4
  95 log to standard output, parameters <level>
  96 .RE
  97 .PP
  98 \fBstderr\fR
  99 .RS 4
 100 log to standard error, parameters <level>
 101 .RE
 102 .RE
 103 .PP
 104 \fB\-f, \-\-file <path>\fR
 105 .RS 4
 106 The path to the file which holds the sync information\&.
 107 .RE
 108 .PP
 109 \fB\-X, \-\-control\-host <hostname|ip>[:<port>]\fR
 110 .RS 4
 111 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 seperate the address from the port, eg\&.: [::1]:1234\&. If you want to use the default port [ and ] can be omitted\&.
 112 .RE
 113 .SH "BUGS"
 114 .sp
 115 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\&.
 116 .SH "SEE ALSO"
 117 .sp
 118 anytun(8), anytun\-config(8), anytun\-showtables(8)
 119 .SH "AUTHORS"
 120 .sp
 121 Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Pointner <equinox@anytun\&.org>
 122 .SH "RESOURCES"
 123 .sp
 124 Main web site: http://www\&.anytun\&.org/
 125 .SH "COPYING"
 126 .sp
 127 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\&.