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

Document that --force should precede commands.

Browse source
This commit is contained in:
Guus Sliepen 2015-02-16 08:26:49 +01:00
parent 85000a30ca
commit 833a8a048b
3 changed files with 16 additions and 9 deletions

9
doc/tinc.8.in
View file

@ -11,6 +11,7 @@
.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 -pidfile Ns = Ns Ar FILENAME .Op Fl -pidfile Ns = Ns Ar FILENAME
.Op Fl -force
.Op Fl -help .Op Fl -help
.Op Fl -version .Op Fl -version
.Op Ar COMMAND .Op Ar COMMAND
@ -54,6 +55,8 @@ Use the cookie from
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 .pid. .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
.It Fl -force
Force some commands to work despite warnings.
.It Fl -help .It Fl -help
Display short list of options. Display short list of options.
.It Fl -version .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. Export the host configuration file of the local node to standard output.
.It export-all .It export-all
Export all host configuration files to standard output. Export all host configuration files to standard output.
.It import Op Fl -force .It import
Import host configuration data generated by the Import host configuration data generated by the
.Nm .Nm
export command from standard input. export command from standard input.
Already existing host configuration files are not overwritten unless the option Already existing host configuration files are not overwritten unless the option
.Fl -force .Fl -force
is used. is used.
.It exchange Op Fl -force .It exchange
The same as export followed by import. The same as export followed by import.
.It exchange-all Op Fl -force .It exchange-all
The same as export-all followed by import. The same as export-all followed by import.
.It invite Ar name .It invite Ar name
Prepares an invitation for a new node with the given Prepares an invitation for a new node with the given

9
doc/tinc.texi
View file

@ -2247,6 +2247,9 @@ 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}.pid}. @file{@value{localstatedir}/run/tinc.@var{netname}.pid}.
@item --force
Force some commands to work despite warnings.
@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.
@ -2314,16 +2317,16 @@ Export the host configuration file of the local node to standard output.
Export all host configuration files to standard output. Export all host configuration files to standard output.
@cindex import @cindex import
@item import [--force] @item import
Import host configuration file(s) generated by the tinc export command from standard input. 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. Already existing host configuration files are not overwritten unless the option --force is used.
@cindex exchange @cindex exchange
@item exchange [--force] @item exchange
The same as export followed by import. The same as export followed by import.
@cindex exchange-all @cindex exchange-all
@item exchange-all [--force] @item exchange-all
The same as export-all followed by import. The same as export-all followed by import.
@cindex invite @cindex invite

7
src/tincctl.c
View file

@ -106,6 +106,7 @@ static void usage(bool status) {
" -c, --config=DIR Read configuration options from DIR.\n" " -c, --config=DIR Read configuration options from DIR.\n"
" -n, --net=NETNAME Connect to net NETNAME.\n" " -n, --net=NETNAME Connect to net NETNAME.\n"
" --pidfile=FILENAME Read control cookie from FILENAME.\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" " --help Display this help and exit.\n"
" --version Output version information and exit.\n" " --version Output version information and exit.\n"
"\n" "\n"
@ -145,9 +146,9 @@ static void usage(bool status) {
" log [level] Dump log output [up to the specified level]\n" " log [level] Dump log output [up to the specified level]\n"
" export Export host configuration of local node to standard output\n" " export Export host configuration of local node to standard output\n"
" export-all Export all host configuration files 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" " import Import host configuration file(s) from standard input\n"
" exchange [--force] Same as export followed by import\n" " exchange Same as export followed by import\n"
" exchange-all [--force] Same as export-all followed by import\n" " exchange-all Same as export-all followed by import\n"
" invite NODE [...] Generate an invitation for NODE\n" " invite NODE [...] Generate an invitation for NODE\n"
" join INVITATION Join a VPN using an INVITIATION\n" " join INVITATION Join a VPN using an INVITIATION\n"
" network [NETNAME] List all known networks, or switch to the one named NETNAME.\n" " network [NETNAME] List all known networks, or switch to the one named NETNAME.\n"