From: Guus Sliepen <guus@tinc-vpn.org>
Date: Tue, 21 Feb 2012 12:13:40 +0000 (+0100)
Subject: Document the command line flag -o and provide --option as well.
X-Git-Tag: release-1.0.17~14
X-Git-Url: https://tinc-vpn.org/git/browse?a=commitdiff_plain;h=46506b7aaf6c6a8a85561c38fdb9c95eae21aa75;p=tinc

Document the command line flag -o and provide --option as well.
---

diff --git a/doc/tinc.texi b/doc/tinc.texi
index 9befcfd6..b6d0c216 100644
--- a/doc/tinc.texi
+++ b/doc/tinc.texi
@@ -1621,6 +1621,12 @@ Generate public/private keypair of @var{bits} length. If @var{bits} is not speci
 but will default to the configuration directory (you can use the -c or -n option
 in combination with -K). After that, tinc will quit.
 
+@item -o, --option=[@var{HOST}.]@var{KEY}=@var{VALUE}
+Without specifying a @var{HOST}, this will set server configuration variable @var{KEY} to @var{VALUE}.
+If specified as @var{HOST}.@var{KEY}=@var{VALUE},
+this will set the host configuration variable @var{KEY} of the host named @var{HOST} to @var{VALUE}.
+This option can be used more than once to specify multiple configuration variables.
+
 @item -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.
diff --git a/doc/tincd.8.in b/doc/tincd.8.in
index 5ea08c01..b117e8a9 100644
--- a/doc/tincd.8.in
+++ b/doc/tincd.8.in
@@ -8,13 +8,14 @@
 .Nd tinc VPN daemon
 .Sh SYNOPSIS
 .Nm
-.Op Fl cdDkKnLRU
+.Op Fl cdDkKnoLRU
 .Op Fl -config Ns = Ns Ar DIR
 .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 -option Ns = Ns Ar [HOST.]KEY=VALUE
 .Op Fl -mlock
 .Op Fl -logfile Ns Op = Ns Ar FILE
 .Op Fl -pidfile Ns = Ns Ar FILE
@@ -79,6 +80,22 @@ If
 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 Fl o, -option Ns = Ns Ar [HOST.]KEY=VALUE
+Without specifying a
+.Ar HOST ,
+this will set server configuration variable
+.Ar KEY 
+to
+.Ar VALUE .
+If specified as
+.Ar HOST.KEY=VALUE ,
+this will set the host configuration variable 
+.Ar KEY
+of the host named
+.Ar HOST
+to
+.Ar VALUE .
+This option can be used more than once to specify multiple configuration variables.
 .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.
diff --git a/src/tincd.c b/src/tincd.c
index c5f4c103..a1be971a 100644
--- a/src/tincd.c
+++ b/src/tincd.c
@@ -114,6 +114,7 @@ static struct option const long_options[] = {
 	{"user", required_argument, NULL, 'U'},
 	{"logfile", optional_argument, NULL, 4},
 	{"pidfile", required_argument, NULL, 5},
+	{"option", required_argument, NULL, 'o'},
 	{NULL, 0, NULL, 0}
 };
 
@@ -129,20 +130,20 @@ static void usage(bool status) {
 				program_name);
 	else {
 		printf("Usage: %s [option]...\n\n", program_name);
-		printf("  -c, --config=DIR           Read configuration options from DIR.\n"
-				"  -D, --no-detach            Don't fork and detach.\n"
-				"  -d, --debug[=LEVEL]        Increase debug level or set it to LEVEL.\n"
-				"  -k, --kill[=SIGNAL]        Attempt to kill a running tincd and exit.\n"
-				"  -n, --net=NETNAME          Connect to net NETNAME.\n"
-				"  -K, --generate-keys[=BITS] Generate public/private RSA keypair.\n"
-				"  -L, --mlock                Lock tinc into main memory.\n"
-				"      --logfile[=FILENAME]   Write log entries to a logfile.\n"
-				"      --pidfile=FILENAME     Write PID to FILENAME.\n"
-				"  -o [HOST.]KEY=VALUE        Set global/host configuration value.\n"
-				"  -R, --chroot               chroot to NET dir at startup.\n"
-				"  -U, --user=USER            setuid to given USER at startup.\n"
-				"      --help                 Display this help and exit.\n"
-				"      --version              Output version information and exit.\n\n");
+		printf("  -c, --config=DIR               Read configuration options from DIR.\n"
+				"  -D, --no-detach                Don't fork and detach.\n"
+				"  -d, --debug[=LEVEL]            Increase debug level or set it to LEVEL.\n"
+				"  -k, --kill[=SIGNAL]            Attempt to kill a running tincd and exit.\n"
+				"  -n, --net=NETNAME              Connect to net NETNAME.\n"
+				"  -K, --generate-keys[=BITS]     Generate public/private RSA keypair.\n"
+				"  -L, --mlock                    Lock tinc into main memory.\n"
+				"      --logfile[=FILENAME]       Write log entries to a logfile.\n"
+				"      --pidfile=FILENAME         Write PID to FILENAME.\n"
+				"  -o, --option=[HOST.]KEY=VALUE  Set global/host configuration value.\n"
+				"  -R, --chroot                   chroot to NET dir at startup.\n"
+				"  -U, --user=USER                setuid to given USER at startup.\n"
+				"      --help                     Display this help and exit.\n"
+				"      --version                  Output version information and exit.\n\n");
 		printf("Report bugs to tinc@tinc-vpn.org.\n");
 	}
 }