X-Git-Url: https://tinc-vpn.org/git/browse?a=blobdiff_plain;f=doc%2Ftincctl.8.in;h=0c86e3d5cf5e72929ccabc0c048962a5a08cf25b;hb=268c8545aaf83b7433f43402f5c77e39e20006ef;hp=ef0584e1e8427d7c1085554c8b2efeaa75e092bb;hpb=8c953b1bfef3c6ebee7c537c2c2f144807d0311a;p=tinc diff --git a/doc/tincctl.8.in b/doc/tincctl.8.in index ef0584e1..0c86e3d5 100644 --- a/doc/tincctl.8.in +++ b/doc/tincctl.8.in @@ -10,7 +10,7 @@ .Op Fl cn .Op Fl -config Ns = Ns Ar DIR .Op Fl -net Ns = Ns Ar NETNAME -.Op Fl -controlcookie Ns = Ns Ar FILENAME +.Op Fl -pidfile Ns = Ns Ar FILENAME .Op Fl -help .Op Fl -version .Ar COMMAND @@ -26,17 +26,24 @@ to alter and inspect the running VPN's state. .It Fl n, -net Ns = Ns Ar NETNAME Communicate with tincd(8) connected with .Ar NETNAME . -.It Fl -controlcookie Ns = Ns Ar FILENAME +.It Fl -pidfile Ns = Ns Ar FILENAME Use the cookie from .Ar FILENAME to authenticate with a running tinc daemon. If unspecified, the default is -.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .cookie. +.Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid. .It Fl -help Display short list of options. .It Fl -version Output version information and exit. .El +.Sh ENVIRONMENT VARIABLES +.Bl -tag -width indent +.It Ev NETNAME +If no netname is specified on the command line with the +.Fl n +option, the value of this environment variable is used. +.El .Sh COMMANDS .zZ .Bl -tag -width indent @@ -59,10 +66,14 @@ will be made. Shows the PID of the currently running .Xr tincd 8 . .It generate-keys Op bits +Generate both RSA and ECDSA keypairs (see below) and exit. +.It generate-ecdsa-keys +Generate public/private ECDSA keypair and exit. +.It generate-rsa-keys Op bits Generate public/private RSA keypair and exit. If .Ar bits -is omitted, the default length will be 1024 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 dump nodes @@ -82,6 +93,10 @@ Purges all information remembered about unreachable nodes. .It debug Ar N Sets debug level to .Ar N . +.It log Op Ar N +Capture log messages from a running tinc daemon. +An optional debug level can be given that will be applied only for log messages sent to +.Nm tincctl . .It retry Forces .Xr tincd 8