.Dd 2002-03-25
.Dt TINCD 8
.\" Manual page created by:
-.\" Ivo Timmermans <itimmermans@bigfoot.com>
-.\" Guus Sliepen <guus@sliepen.warande.net>
+.\" Ivo Timmermans <ivo@o2w.nl>
+.\" Guus Sliepen <guus@sliepen.eu.org>
.Sh NAME
.Nm tincd
.Nd tinc VPN daemon
.Sh SYNOPSIS
.Nm
-.Op Fl cdDkKn
-.Op Fl -bypass-security
+.Op Fl cdDkKnL
.Op Fl -config Ns = Ns Ar DIR
-.Op Fl -debug Ns = Ns Ar LEVEL
+.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 -mlock
+.Op Fl -logfile Ns Op = Ns Ar FILE
+.Op Fl -pidfile Ns = Ns Ar FILE
+.Op Fl -bypass-security
.Op Fl -help
-.Op Fl -kill Ns = Ns Ar SIGNAL
-.Op Fl -net Ns = Ns Ar NETNAME
-.Op Fl -no-detach
.Op Fl -version
.Sh DESCRIPTION
This is the daemon of tinc, a secure virtual private network (VPN) project.
it will detach from the controlling terminal and continue in the background,
accepting and setting up connections to other tinc daemons
that are part of the virtual private network.
+Under Windows (not Cygwin) tinc will install itself as a service,
+which will be restarted automatically after reboots.
.Sh OPTIONS
.Bl -tag -width indent
-.It Fl -bypass-security
-Disables encryption and authentication.
-Only useful for debugging.
.It Fl c, -config Ns = Ns Ar DIR
-Read configuration options from
-.Ar DIR .
+Read configuration files from
+.Ar DIR
+instead of
+.Pa @sysconfdir@/tinc/ .
+.It Fl D, -no-detach
+Don't fork and detach.
+This will also disable the automatic restart mechanism for fatal errors.
+If not mentioned otherwise, this will show log messages on the standard error output.
.It Fl d, -debug Ns Op = Ns Ar LEVEL
Increase debug level or set it to
.Ar LEVEL
(see below).
-.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.
-.It Fl -help
-Display short list of options.
.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 D, -no-detach
-Don't fork and detach.
-This will also disable the automatic restart mechanism for fatal errors.
+.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.
+.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 -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
+.Ar FILE
+instead of
+.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 -help
+Display short list of options.
.It Fl -version
Output version information and exit.
.El
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
-Closes all connections, rereads the configuration file and restarts the daemon.
+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 INT
Temporarily increases debug level to 5.
Send this signal again to revert to the original level.
.It 1
This will log all connections that are made with other tinc daemons.
.It 2
-This will log status and error messages from other tinc daemons.
+This will log status and error messages from scripts and other tinc daemons.
.It 3
This will log all requests that are exchanged with other tinc daemons. These include
authentication, key exchange and connection list updates.
.El
.Sh FILES
.Bl -tag -width indent
-.It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
-The configuration file for
-.Nm .
-.It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
-Script which is executed as soon as the virtual network device has been allocated.
-Purpose is to further configure that device.
-.It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
-Script which is executed when
-.Nm
-exits.
-Purpose is to cleanly shut down the virtual network device before it will be deallocated.
-.It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/*
-The directory containing the host configuration files
-used to authenticate other tinc daemons.
-.It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -up
-Script which is executed as soon as host
-.Ar NAME
-becomes reachable.
-.It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/ Ns Ar NAME Ns Pa -down
-Script which is executed as soon as host
-.Ar NAME
-becomes unreachable.
-.It Pa /var/run/tinc. Ns Ar NETNAME Ns Pa .pid
+.It Pa @sysconfdir@/tinc/
+Directory containing the configuration files tinc uses.
+For more information, see
+.Xr tinc.conf 5 .
+.It Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid
The PID of the currently running
.Nm
is stored in this file.
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 itimmermans@bigfoot.com
-.An "Guus Sliepen" Aq guus@sliepen.warande.net
+.An "Ivo Timmermans" Aq ivo@o2w.nl
+.An "Guus Sliepen" Aq guus@sliepen.eu.org
.Pp
And thanks to many others for their contributions to tinc!
projects / tinc / blobdiff