From: Guus Sliepen <guus@tinc-vpn.org>
Date: Sun, 26 Jun 2011 10:59:11 +0000 (+0200)
Subject: Update documentation to mention pidfiles instead of controlcookies.
X-Git-Tag: import-tinc-1.1~463
X-Git-Url: https://git.meshlink.io/?a=commitdiff_plain;h=e73052b05444679d922dbdf3d0c507873110957e;p=meshlink

Update documentation to mention pidfiles instead of controlcookies.
---

diff --git a/doc/tinc.texi b/doc/tinc.texi
index 15704a1f..53346b8f 100644
--- a/doc/tinc.texi
+++ b/doc/tinc.texi
@@ -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}.
 @xref{Multiple networks}.
 
-@item --controlcookie=@var{filename}
+@item --pidfile=@var{filename}
 Store a cookie in @var{filename} which allows tincctl to authenticate.
 If unspecified, the default is
-@file{@value{localstatedir}/run/tinc.@var{netname}.cookie}.
+@file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
 
 @item -L, --mlock
 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}
 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.
 If unspecified, the default is
-@file{@value{localstatedir}/run/tinc.@var{netname}.cookie}.
+@file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
 
 @item --help
 Display a short reminder of runtime options and commands, then terminate.
diff --git a/doc/tincctl.8.in b/doc/tincctl.8.in
index ef0584e1..bcccc597 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,12 +26,12 @@ 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
diff --git a/doc/tincd.8.in b/doc/tincd.8.in
index ea722042..bb4aa48c 100644
--- a/doc/tincd.8.in
+++ b/doc/tincd.8.in
@@ -70,7 +70,7 @@ If
 .Ar FILE
 is omitted, the default is
 .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
 .Ar FILENAME
 which allows
@@ -79,7 +79,7 @@ to authenticate.
 If
 .Ar FILE
 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
 Disables encryption and authentication of the meta protocol.
 Only useful for debugging.