j3d1/tinc
1
0
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

Update documentation to mention pidfiles instead of controlcookies.

Browse source
This commit is contained in:
Guus Sliepen 2011-06-26 12:59:11 +02:00
parent 8c953b1bfe
commit e73052b054
3 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/tinc.texi
View file

@ -1580,10 +1580,10 @@ This will let tinc read all configuration files from
Specifying . for @var{netname} is the same as not specifying any @var{netname}. Specifying . for @var{netname} is the same as not specifying any @var{netname}.
@xref{Multiple networks}. @xref{Multiple networks}.
@item --controlcookie=@var{filename} @item --pidfile=@var{filename}
Store a cookie in @var{filename} which allows tincctl to authenticate. Store a cookie in @var{filename} which allows tincctl to authenticate.
If unspecified, the default is If unspecified, the default is
@file{@value{localstatedir}/run/tinc.@var{netname}.cookie}. @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
@item -L, --mlock @item -L, --mlock
Lock tinc into main memory. Lock tinc into main memory.
@ -1872,10 +1872,10 @@ Read configuration options from the directory @var{path}. The default is
@item -n, --net=@var{netname} @item -n, --net=@var{netname}
Use configuration for net @var{netname}. @xref{Multiple networks}. Use configuration for net @var{netname}. @xref{Multiple networks}.
@item --controlcookie=@var{filename} @item --pidfile=@var{filename}
Use the cookie from @var{filename} to authenticate with a running tinc daemon. Use the cookie from @var{filename} to authenticate with a running tinc daemon.
If unspecified, the default is If unspecified, the default is
@file{@value{localstatedir}/run/tinc.@var{netname}.cookie}. @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
@item --help @item --help
Display a short reminder of runtime options and commands, then terminate. Display a short reminder of runtime options and commands, then terminate.

6
doc/tincctl.8.in
View file

@ -10,7 +10,7 @@
.Op Fl cn .Op Fl cn
.Op Fl -config Ns = Ns Ar DIR .Op Fl -config Ns = Ns Ar DIR
.Op Fl -net Ns = Ns Ar NETNAME .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 -help
.Op Fl -version .Op Fl -version
.Ar COMMAND .Ar COMMAND
@ -26,12 +26,12 @@ to alter and inspect the running VPN's state.
.It Fl n, -net Ns = Ns Ar NETNAME .It Fl n, -net Ns = Ns Ar NETNAME
Communicate with tincd(8) connected with Communicate with tincd(8) connected with
.Ar NETNAME . .Ar NETNAME .
.It Fl -controlcookie Ns = Ns Ar FILENAME .It Fl -pidfile Ns = Ns Ar FILENAME
Use the cookie from Use the cookie from
.Ar FILENAME .Ar FILENAME
to authenticate with a running tinc daemon. to authenticate with a running tinc daemon.
If unspecified, the default is 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 .It Fl -help
Display short list of options. Display short list of options.
.It Fl -version .It Fl -version

4
doc/tincd.8.in
View file

@ -70,7 +70,7 @@ If
.Ar FILE .Ar FILE
is omitted, the default is is omitted, the default is
.Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log. .Pa @localstatedir@/log/tinc. Ns Ar NETNAME Ns Pa .log.
.It Fl -controlcookie Ns = Ns Ar FILENAME .It Fl -pidfile Ns = Ns Ar FILENAME
Store a cookie in Store a cookie in
.Ar FILENAME .Ar FILENAME
which allows which allows
@ -79,7 +79,7 @@ to authenticate.
If If
.Ar FILE .Ar FILE
is omitted, the default is is omitted, 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 -bypass-security .It Fl -bypass-security
Disables encryption and authentication of the meta protocol. Disables encryption and authentication of the meta protocol.
Only useful for debugging. Only useful for debugging.