Re-add support for SIGALRM.

[tinc] / doc / tincd.8.in

diff --git a/doc/tincd.8.in b/doc/tincd.8.in
index 9995b4c..ea72204 100644 (file)
--- a/doc/tincd.8.in
+++ b/doc/tincd.8.in
@@ -1,4 +1,4 @@
-.Dd 2009-05-18
+.Dd 2011-06-25

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


@@ -53,6 +53,14 @@ Increase debug level or set it to
 .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 .

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


@@ -62,21 +70,24 @@ 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 -controlsocket Ns = Ns Ar FILENAME
-Open control socket at
-.Ar FILENAME .
+.It Fl -controlcookie Ns = Ns Ar FILENAME
+Store a cookie in
+.Ar FILENAME
+which allows
+.Xr tincctl 8
+to authenticate.

 If
 .Ar FILE
 is omitted, the default is
 If
 .Ar FILE
 is omitted, the default is

-.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .control.
+.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .cookie.

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

-.It Fl -user Ns = Ns Ar USER
+.It Fl U, -user Ns = Ns Ar USER

 setuid to the specified
 .Ar USER
 after initialization.
 setuid to the specified
 .Ar USER
 after initialization.


@@ -87,12 +98,28 @@ Output version information and exit.
 .El
 .Sh SIGNALS
 .Bl -tag -width indent
 .El
 .Sh SIGNALS
 .Bl -tag -width indent

+.It ALRM
+Forces
+.Nm
+to try to connect to all uplinks immediately.
+Usually
+.Nm
+attempts to do this itself,
+but increases the time it waits between the attempts each time it failed,
+and if
+.Nm
+didn't succeed to connect to an uplink the first time after it started,
+it defaults to the maximum time of 15 minutes.

 .It HUP
 Partially rereads configuration files.
 Connections to hosts whose host config file are removed are closed.
 New outgoing connections specified in
 .Pa tinc.conf
 will be made.
 .It HUP
 Partially rereads configuration files.
 Connections to hosts whose host config file are removed are closed.
 New outgoing connections specified in
 .Pa tinc.conf
 will be made.

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