X-Git-Url: https://tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=doc%2Ftincd.8.in;h=22c54a718e29edf85fa5578347d49042adfc155c;hp=a8ef2fb836c7ca9ffa041cdf301a1d08321cabfd;hb=413faffca356b25cf69ddf0a718730d46f9941bc;hpb=67766d65f06854ee894d784f638c5c9cd2b50bca diff --git a/doc/tincd.8.in b/doc/tincd.8.in index a8ef2fb8..22c54a71 100644 --- a/doc/tincd.8.in +++ b/doc/tincd.8.in @@ -1,4 +1,4 @@ -.Dd 2011-01-02 +.Dd 2013-01-14 .Dt TINCD 8 .\" Manual page created by: .\" Ivo Timmermans @@ -8,16 +8,15 @@ .Nd tinc VPN daemon .Sh SYNOPSIS .Nm -.Op Fl cdDkKnLRU +.Op Fl cdDKnsoLRU .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 -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 -pidfile Ns = Ns Ar FILE +.Op Fl -syslog .Op Fl -bypass-security .Op Fl -chroot .Op Fl -user Ns = Ns Ar USER @@ -53,14 +52,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). -.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 . @@ -72,28 +63,44 @@ for .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 , +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 -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 -instead of +is omitted, the default is .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. @@ -101,10 +108,12 @@ Only useful for debugging. 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 @@ -130,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. @@ -185,8 +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 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.