X-Git-Url: https://tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=doc%2Ftincd.8.in;h=22c54a718e29edf85fa5578347d49042adfc155c;hp=37a134e0e0a4b028fb2eedabc4edf02f1f1ade05;hb=413faffca356b25cf69ddf0a718730d46f9941bc;hpb=6c453769fd16125ec18e8e6d102a3eaa09d370c7 diff --git a/doc/tincd.8.in b/doc/tincd.8.in index 37a134e0..22c54a71 100644 --- a/doc/tincd.8.in +++ b/doc/tincd.8.in @@ -1,4 +1,4 @@ -.Dd 2002-03-25 +.Dd 2013-01-14 .Dt TINCD 8 .\" Manual page created by: .\" Ivo Timmermans @@ -8,14 +8,18 @@ .Nd tinc VPN daemon .Sh SYNOPSIS .Nm -.Op Fl cdDKnL +.Op Fl cdDKnsoLRU .Op Fl -config Ns = Ns Ar DIR .Op Fl -no-detach .Op Fl -debug Ns Op = Ns Ar LEVEL .Op Fl -net Ns = Ns Ar NETNAME +.Op Fl -option Ns = Ns Ar [HOST.]KEY=VALUE .Op Fl -mlock .Op Fl -logfile Ns Op = Ns Ar FILE +.Op Fl -syslog .Op Fl -bypass-security +.Op Fl -chroot +.Op Fl -user Ns = Ns Ar USER .Op Fl -help .Op Fl -version .Sh DESCRIPTION @@ -51,25 +55,65 @@ Increase debug level or set it to .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 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. +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 -controlsocket Ns = Ns Ar FILENAME -Open control socket at -.Ar FILENAME . +.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 is omitted, the default is -.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .control. +.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid. .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 @@ -95,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. -.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. @@ -150,9 +189,9 @@ If you find any bugs, report them to tinc@tinc-vpn.org. .Sh TODO A lot, especially security auditing. .Sh SEE ALSO -.Xr tincctl 8 , +.Xr tinc 8 , .Xr tinc.conf 5 , -.Pa http://www.tinc-vpn.org/ , +.Pa https://www.tinc-vpn.org/ , .Pa http://www.cabal.org/ . .Pp The full documentation for tinc is maintained as a Texinfo manual.