summaryrefslogtreecommitdiff
path: root/doc/anytun-config.8
diff options
context:
space:
mode:
authorChristian Pointner <equinox@anytun.org>2010-02-11 10:57:11 +0000
committerChristian Pointner <equinox@anytun.org>2010-02-11 10:57:11 +0000
commit88f272bac7af8c021f0bd272dbc841441279f5c7 (patch)
tree7e4a85bfbaaffc85ba7e960fc2f9121bead9969c /doc/anytun-config.8
parentupdated ChangeLog (diff)
cleaned up manpages
Diffstat (limited to 'doc/anytun-config.8')
-rw-r--r--doc/anytun-config.848
1 files changed, 24 insertions, 24 deletions
diff --git a/doc/anytun-config.8 b/doc/anytun-config.8
index 4a349c3..5facb41 100644
--- a/doc/anytun-config.8
+++ b/doc/anytun-config.8
@@ -2,12 +2,12 @@
.\" Title: anytun-config
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\" Date: 01/15/2010
+.\" Date: 02/11/2010
.\" Manual: anytun-config user manual
.\" Source: anytun trunk
.\" Language: English
.\"
-.TH "ANYTUN\-CONFIG" "8" "01/15/2010" "anytun trunk" "anytun-config user manual"
+.TH "ANYTUN\-CONFIG" "8" "02/11/2010" "anytun trunk" "anytun-config user manual"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -45,32 +45,32 @@ anytun-config \- anycast tunneling configuration utility
\fBanytun\-config\fR writes routing/connection table entries, that can be read by \fBanytun\-controld\fR\&.
.SH "OPTIONS"
.PP
-\fB\-L, \-\-log <target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR
+\fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR
.RS 4
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\&.
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
-\fBsyslog:3,anytun\-config,daemon\fR
+\fIsyslog:3,anytun\-config,daemon\fR
is added\&.
The following targets are supported:
.PP
-\fBsyslog\fR
+\fIsyslog\fR
.RS 4
log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
.RE
.PP
-\fBfile\fR
+\fIfile\fR
.RS 4
log to file, parameters <level>[,<path>]
.RE
.PP
-\fBstdout\fR
+\fIstdout\fR
.RS 4
log to standard output, parameters <level>
.RE
.PP
-\fBstderr\fR
+\fIstderr\fR
.RS 4
log to standard error, parameters <level>
.RE
@@ -83,16 +83,16 @@ This option instructs
to run in debug mode\&. It implicits
\fB\-D\fR
(don\(cqt daemonize) and adds a log target with the configuration
-\fBstdout:5\fR
+\fIstdout:5\fR
(logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
.RE
.PP
-\fB\-r, \-\-remote\-host <hostname|ip>\fR
+\fB\-r, \-\-remote\-host \fR\fB\fI<hostname|ip>\fR\fR
.RS 4
This option can be used to specify the remote tunnel endpoint\&. In case of anycast tunnel endpoints, the anycast IP address has to be used\&. If you do not specify an address, it is automatically determined after receiving the first data packet\&.
.RE
.PP
-\fB\-o, \-\-remote\-port <port>\fR
+\fB\-o, \-\-remote\-port \fR\fB\fI<port>\fR\fR
.RS 4
The UDP port used for payload data by the remote host (specified with \-p on the remote host)\&. If you do not specify a port, it is automatically determined after receiving the first data packet\&.
.RE
@@ -107,24 +107,24 @@ Resolv to IPv4 addresses only\&. The default is to resolv both IPv4 and IPv6 add
Resolv to IPv6 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
.RE
.PP
-\fB\-R, \-\-route <net>/<prefix length>\fR
+\fB\-R, \-\-route \fR\fB\fI<net>/<prefix length>\fR\fR
.RS 4
add a route to connection\&. This can be invoked several times\&.
.RE
.PP
-\fB\-m, \-\-mux <mux\-id>\fR
+\fB\-m, \-\-mux \fR\fB\fI<mux\-id>\fR\fR
.RS 4
the multiplex id to use\&. default: 0
.RE
.PP
-\fB\-w, \-\-window\-size <window size>\fR
+\fB\-w, \-\-window\-size \fR\fB\fI<window size>\fR\fR
.RS 4
seqence window size
Sometimes, packets arrive out of order on the receiver side\&. This option defines the size of a list of received packets\' sequence numbers\&. If, according to this list, a received packet has been previously received or has been transmitted in the past, and is therefore not in the list anymore, this is interpreted as a replay attack and the packet is dropped\&. A value of 0 deactivates this list and, as a consequence, the replay protection employed by filtering packets according to their secuence number\&. By default the sequence window is disabled and therefore a window size of 0 is used\&.
.RE
.PP
-\fB\-k, \-\-kd\(emprf <kd\-prf type>\fR
+\fB\-k, \-\-kd\(emprf \fR\fB\fI<kd\-prf type>\fR\fR
.RS 4
key derivation pseudo random function
@@ -132,33 +132,33 @@ The pseudo random function which is used for calculating the session keys and se
Possible values:
.PP
-\fBnull\fR
+\fInull\fR
.RS 4
no random function, keys and salt are set to 0\&.\&.00
.RE
.PP
-\fBaes\-ctr\fR
+\fIaes\-ctr\fR
.RS 4
AES in counter mode with 128 Bits, default value
.RE
.PP
-\fBaes\-ctr\-128\fR
+\fIaes\-ctr\-128\fR
.RS 4
AES in counter mode with 128 Bits
.RE
.PP
-\fBaes\-ctr\-192\fR
+\fIaes\-ctr\-192\fR
.RS 4
AES in counter mode with 192 Bits
.RE
.PP
-\fBaes\-ctr\-256\fR
+\fIaes\-ctr\-256\fR
.RS 4
AES in counter mode with 256 Bits
.RE
.RE
.PP
-\fB\-e, \-\-role <role>\fR
+\fB\-e, \-\-role \fR\fB\fI<role>\fR\fR
.RS 4
SATP uses different session keys for inbound and outbound traffic\&. The role parameter is used to determine which keys to use for outbound or inbound packets\&. On both sides of a vpn connection different roles have to be used\&. Possible values are
\fBleft\fR
@@ -179,7 +179,7 @@ as a replacement for
is used\&.
.RE
.PP
-\fB\-E, \-\-passphrase <pass phrase>\fR
+\fB\-E, \-\-passphrase \fR\fB\fI<pass phrase>\fR\fR
.RS 4
This passphrase is used to generate the master key and master salt\&. For the master key the last n bits of the SHA256 digest of the passphrase (where n is the length of the master key in bits) is used\&. The master salt gets generated with the SHA1 digest\&. You may force a specific key and or salt by using
\fB\-\-key\fR
@@ -187,14 +187,14 @@ and
\fB\-\-salt\fR\&.
.RE
.PP
-\fB\-K, \-\-key <master key>\fR
+\fB\-K, \-\-key \fR\fB\fI<master key>\fR\fR
.RS 4
master key to use for key derivation
Master key in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length of 32, 48 or 64 characters (128, 192 or 256 bits)\&.
.RE
.PP
-\fB\-A, \-\-salt <master salt>\fR
+\fB\-A, \-\-salt \fR\fB\fI<master salt>\fR\fR
.RS 4
master salt to use for key derivation