From: Guus Sliepen <guus@tinc-vpn.org>
Date: Mon, 16 Feb 2015 07:26:49 +0000 (+0100)
Subject: Document that --force should precede commands.
X-Git-Tag: release-1.1pre12~202
X-Git-Url: https://git.tinc-vpn.org/git/browse?a=commitdiff_plain;h=833a8a048b22612cd12d703d55a71448b7179b4a;p=tinc

Document that --force should precede commands.
---

diff --git a/doc/tinc.8.in b/doc/tinc.8.in
index 02f1b9a7..b9bd2d41 100644
--- a/doc/tinc.8.in
+++ b/doc/tinc.8.in
@@ -11,6 +11,7 @@
 .Op Fl -config Ns = Ns Ar DIR
 .Op Fl -net Ns = Ns Ar NETNAME
 .Op Fl -pidfile Ns = Ns Ar FILENAME
+.Op Fl -force
 .Op Fl -help
 .Op Fl -version
 .Op Ar COMMAND
@@ -54,6 +55,8 @@ Use the cookie from
 to authenticate with a running tinc daemon.
 If unspecified, the default is
 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
+.It Fl -force
+Force some commands to work despite warnings.
 .It Fl -help
 Display short list of options.
 .It Fl -version
@@ -102,16 +105,16 @@ You do not need to specify the full path to the file.
 Export the host configuration file of the local node to standard output.
 .It export-all
 Export all host configuration files to standard output.
-.It import Op Fl -force
+.It import
 Import host configuration data generated by the
 .Nm
 export command from standard input.
 Already existing host configuration files are not overwritten unless the option
 .Fl -force
 is used.
-.It exchange Op Fl -force
+.It exchange
 The same as export followed by import.
-.It exchange-all Op Fl -force
+.It exchange-all
 The same as export-all followed by import.
 .It invite Ar name
 Prepares an invitation for a new node with the given
diff --git a/doc/tinc.texi b/doc/tinc.texi
index 442da2f9..581da6ea 100644
--- a/doc/tinc.texi
+++ b/doc/tinc.texi
@@ -2247,6 +2247,9 @@ 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}.pid}.
 
+@item --force
+Force some commands to work despite warnings.
+
 @item --help
 Display a short reminder of runtime options and commands, then terminate.
 
@@ -2314,16 +2317,16 @@ Export the host configuration file of the local node to standard output.
 Export all host configuration files to standard output.
 
 @cindex import
-@item import [--force]
+@item import
 Import host configuration file(s) generated by the tinc export command from standard input.
 Already existing host configuration files are not overwritten unless the option --force is used.
 
 @cindex exchange
-@item exchange [--force]
+@item exchange
 The same as export followed by import.
 
 @cindex exchange-all
-@item exchange-all [--force]
+@item exchange-all
 The same as export-all followed by import.
 
 @cindex invite
diff --git a/src/tincctl.c b/src/tincctl.c
index d46a378b..b36de76d 100644
--- a/src/tincctl.c
+++ b/src/tincctl.c
@@ -106,6 +106,7 @@ static void usage(bool status) {
 				"  -c, --config=DIR        Read configuration options from DIR.\n"
 				"  -n, --net=NETNAME       Connect to net NETNAME.\n"
 				"      --pidfile=FILENAME  Read control cookie from FILENAME.\n"
+				"      --force             Force some commands to work despite warnings.\n"
 				"      --help              Display this help and exit.\n"
 				"      --version           Output version information and exit.\n"
 				"\n"
@@ -145,9 +146,9 @@ static void usage(bool status) {
 				"  log [level]                Dump log output [up to the specified level]\n"
 				"  export                     Export host configuration of local node to standard output\n"
 				"  export-all                 Export all host configuration files to standard output\n"
-				"  import [--force]           Import host configuration file(s) from standard input\n"
-				"  exchange [--force]         Same as export followed by import\n"
-				"  exchange-all [--force]     Same as export-all followed by import\n"
+				"  import                     Import host configuration file(s) from standard input\n"
+				"  exchange                   Same as export followed by import\n"
+				"  exchange-all               Same as export-all followed by import\n"
 				"  invite NODE [...]          Generate an invitation for NODE\n"
 				"  join INVITATION            Join a VPN using an INVITIATION\n"
 				"  network [NETNAME]          List all known networks, or switch to the one named NETNAME.\n"