Merge branch 'master' of git://tinc-vpn.org/tinc into 1.1

[tinc] / doc / tincd.8.in

diff --git a/doc/tincd.8.in b/doc/tincd.8.in
index b117e8a..24b4da4 100644 (file)
--- a/doc/tincd.8.in
+++ b/doc/tincd.8.in
@@ -1,4 +1,4 @@
-.Dd 2011-01-02
+.Dd 2011-06-25

 .Dt TINCD 8
 .\" Manual page created by:
 .\" Ivo Timmermans
 .Dt TINCD 8
 .\" Manual page created by:
 .\" Ivo Timmermans


@@ -8,17 +8,14 @@
 .Nd tinc VPN daemon
 .Sh SYNOPSIS
 .Nm
 .Nd tinc VPN daemon
 .Sh SYNOPSIS
 .Nm

-.Op Fl cdDkKnoLRU
+.Op Fl cdDKnoLRU

 .Op Fl -config Ns = Ns Ar DIR
 .Op Fl -no-detach
 .Op Fl -debug Ns Op = Ns Ar LEVEL
 .Op Fl -config Ns = Ns Ar DIR
 .Op Fl -no-detach
 .Op Fl -debug Ns Op = Ns Ar LEVEL

-.Op Fl -kill Ns Op = Ns Ar SIGNAL

 .Op Fl -net Ns = Ns Ar NETNAME
 .Op Fl -net Ns = Ns Ar NETNAME

-.Op Fl -generate-keys Ns Op = Ns Ar BITS

 .Op Fl -option Ns = Ns Ar [HOST.]KEY=VALUE
 .Op Fl -mlock
 .Op Fl -logfile Ns Op = Ns Ar FILE
 .Op Fl -option Ns = Ns Ar [HOST.]KEY=VALUE
 .Op Fl -mlock
 .Op Fl -logfile Ns Op = Ns Ar FILE

-.Op Fl -pidfile Ns = Ns Ar FILE

 .Op Fl -bypass-security
 .Op Fl -chroot
 .Op Fl -user Ns = Ns Ar USER
 .Op Fl -bypass-security
 .Op Fl -chroot
 .Op Fl -user Ns = Ns Ar USER


@@ -54,14 +51,6 @@ If not mentioned otherwise, this will show log messages on the standard error ou
 Increase debug level or set it to
 .Ar LEVEL
 (see below).
 Increase debug level or set it to
 .Ar LEVEL
 (see below).

-.It Fl k, -kill Ns Op = Ns Ar SIGNAL
-Attempt to kill a running
-.Nm
-(optionally with the specified
-.Ar SIGNAL
-instead of SIGTERM) and exit.
-Under Windows (not Cygwin) the optional argument is ignored,
-the service will always be stopped and removed.

 .It Fl n, -net Ns = Ns Ar NETNAME
 Connect to net
 .Ar NETNAME .
 .It Fl n, -net Ns = Ns Ar NETNAME
 Connect to net
 .Ar NETNAME .


@@ -73,13 +62,6 @@ for
 .Ar NETNAME
 is the same as not specifying any
 .Ar NETNAME .
 .Ar NETNAME
 is the same as not specifying any
 .Ar NETNAME .

-.It Fl K, -generate-keys Ns Op = Ns Ar BITS
-Generate public/private RSA keypair and exit.
-If
-.Ar BITS
-is omitted, the default length will be 2048 bits.
-When saving keys to existing files, tinc will not delete the old keys,
-you have to remove them manually.

 .It Fl o, -option Ns = Ns Ar [HOST.]KEY=VALUE
 Without specifying a
 .Ar HOST ,
 .It Fl o, -option Ns = Ns Ar [HOST.]KEY=VALUE
 Without specifying a
 .Ar HOST ,


@@ -105,12 +87,16 @@ If
 .Ar FILE
 is omitted, the default is
 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
 .Ar FILE
 is omitted, the default is
 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.

-.It Fl -pidfile Ns = Ns Ar FILE
-Write PID to
+.It Fl -pidfile Ns = Ns Ar FILENAME
+Store a cookie in
+.Ar FILENAME
+which allows
+.Xr tincctl 8
+to authenticate.
+If

 .Ar FILE
 .Ar FILE

-instead of
+is omitted, the default is

 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.

-Under Windows this option will be ignored.

 .It Fl -bypass-security
 Disables encryption and authentication of the meta protocol.
 Only useful for debugging.
 .It Fl -bypass-security
 Disables encryption and authentication of the meta protocol.
 Only useful for debugging.


@@ -151,15 +137,6 @@ If the
 .Fl -logfile
 option is used, this will also close and reopen the log file,
 useful when log rotation is used.
 .Fl -logfile
 option is used, this will also close and reopen the log file,
 useful when log rotation is used.

-.It INT
-Temporarily increases debug level to 5.
-Send this signal again to revert to the original level.
-.It USR1
-Dumps the connection list to syslog.
-.It USR2
-Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
-.It WINCH
-Purges all information remembered about unreachable nodes.

 .El
 .Sh DEBUG LEVELS
 The tinc daemon can send a lot of messages to the syslog.
 .El
 .Sh DEBUG LEVELS
 The tinc daemon can send a lot of messages to the syslog.


@@ -206,6 +183,7 @@ If you find any bugs, report them to tinc@tinc-vpn.org.
 .Sh TODO
 A lot, especially security auditing.
 .Sh SEE ALSO
 .Sh TODO
 A lot, especially security auditing.
 .Sh SEE ALSO

+.Xr tincctl 8 ,

 .Xr tinc.conf 5 ,
 .Pa http://www.tinc-vpn.org/ ,
 .Pa http://www.cabal.org/ .
 .Xr tinc.conf 5 ,
 .Pa http://www.tinc-vpn.org/ ,
 .Pa http://www.cabal.org/ .