Update links in the documentation.

[tinc] / doc / tincd.8.in

diff --git a/doc/tincd.8.in b/doc/tincd.8.in
index e7789f0..22c54a7 100644 (file)
--- a/doc/tincd.8.in
+++ b/doc/tincd.8.in
@@ -1,24 +1,25 @@
-.Dd 2002-03-25
+.Dd 2013-01-14

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

-.\" Ivo Timmermans <ivo@o2w.nl>
-.\" Guus Sliepen <guus@sliepen.eu.org>
+.\" Ivo Timmermans
+.\" Guus Sliepen <guus@tinc-vpn.org>

 .Sh NAME
 .Nm tincd
 .Nd tinc VPN daemon
 .Sh SYNOPSIS
 .Nm
 .Sh NAME
 .Nm tincd
 .Nd tinc VPN daemon
 .Sh SYNOPSIS
 .Nm

-.Op Fl cdDkKnL
+.Op Fl cdDKnsoLRU

 .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 -mlock
 .Op Fl -logfile Ns Op = Ns Ar FILE

-.Op Fl -pidfile Ns = Ns Ar FILE
+.Op Fl -syslog

 .Op Fl -bypass-security
 .Op Fl -bypass-security

+.Op Fl -chroot
+.Op Fl -user Ns = Ns Ar USER

 .Op Fl -help
 .Op Fl -version
 .Sh DESCRIPTION
 .Op Fl -help
 .Op Fl -version
 .Sh DESCRIPTION


@@ -51,42 +52,68 @@ 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 .

-.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 1024 bits.
-When saving keys to existing files, tinc will not delete the old keys,
-you have to remove them manually.
+This will let tinc read all configuration files from
+.Pa @sysconfdir@/tinc/ Ar NETNAME .
+Specifying
+.Li .
+for
+.Ar NETNAME
+is the same as not specifying any
+.Ar NETNAME .
+.It Fl o, -option Ns = Ns Ar [HOST.]KEY=VALUE
+Without specifying a
+.Ar HOST ,
+this will set server configuration variable
+.Ar KEY 
+to
+.Ar VALUE .
+If specified as
+.Ar HOST.KEY=VALUE ,
+this will set the host configuration variable 
+.Ar KEY
+of the host named
+.Ar HOST
+to
+.Ar VALUE .
+This option can be used more than once to specify multiple configuration variables.

 .It Fl L, -mlock
 Lock tinc into main memory.
 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.
 .It Fl L, -mlock
 Lock tinc into main memory.
 This will prevent sensitive data like shared private keys to be written to the system swap files/partitions.

+This option is not supported on all platforms.

 .It Fl -logfile Ns Op = Ns Ar FILE
 Write log entries to a file instead of to the system logging facility.
 If
 .Ar FILE
 is omitted, the default is
 .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
 .It Fl -logfile Ns Op = Ns Ar FILE
 Write log entries to a file instead of to the system logging facility.
 If
 .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 s, -syslog
+When this option is is set, tinc uses syslog instead of stderr in --no-detach mode.
+.It Fl -pidfile Ns = Ns Ar FILENAME
+Store a cookie in
+.Ar FILENAME
+which allows
+.Xr tinc 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.

+.It Fl R, -chroot
+With this option tinc chroots into the directory where network
+config is located (@sysconfdir@/tinc/NETNAME if -n option is used,
+or to the directory specified with -c option) after initialization.
+This option is not supported on all platforms.
+.It Fl U, -user Ns = Ns Ar USER
+setuid to the specified
+.Ar USER
+after initialization.
+This option is not supported on all platforms.

 .It Fl -help
 Display short list of options.
 .It Fl -version
 .It Fl -help
 Display short list of options.
 .It Fl -version


@@ -112,15 +139,10 @@ Connections to hosts whose host config file are removed are closed.
 New outgoing connections specified in
 .Pa tinc.conf
 will be made.
 New outgoing connections specified in
 .Pa tinc.conf
 will be made.

-.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.
+If the
+.Fl -logfile
+option is used, this will also close and reopen the log file,
+useful when log rotation is used.

 .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.


@@ -163,12 +185,13 @@ option may not work correctly.
 .Pp
 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
 .Pp
 .Pp
 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
 .Pp

-If you find any bugs, report them to tinc@nl.linux.org.
+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 tinc 8 ,

 .Xr tinc.conf 5 ,
 .Xr tinc.conf 5 ,

-.Pa http://tinc.nl.linux.org/ ,
+.Pa https://www.tinc-vpn.org/ ,

 .Pa http://www.cabal.org/ .
 .Pp
 The full documentation for tinc is maintained as a Texinfo manual.
 .Pa http://www.cabal.org/ .
 .Pp
 The full documentation for tinc is maintained as a Texinfo manual.


@@ -181,7 +204,7 @@ tinc comes with ABSOLUTELY NO WARRANTY.
 This is free software, and you are welcome to redistribute it under certain conditions;
 see the file COPYING for details.
 .Sh AUTHORS
 This is free software, and you are welcome to redistribute it under certain conditions;
 see the file COPYING for details.
 .Sh AUTHORS

-.An "Ivo Timmermans" Aq ivo@o2w.nl
-.An "Guus Sliepen" Aq guus@sliepen.eu.org
+.An "Ivo Timmermans"
+.An "Guus Sliepen" Aq guus@tinc-vpn.org

 .Pp
 And thanks to many others for their contributions to tinc!
 .Pp
 And thanks to many others for their contributions to tinc!