From d8ea66ff1fc68ca9ea672727b0274663df6f4866 Mon Sep 17 00:00:00 2001 From: Guus Sliepen Date: Thu, 16 Jan 2014 14:46:44 +0100 Subject: [PATCH] Update the documentation of the tinc command. --- doc/tinc.8.in | 34 ++++++++++++++++++++++++++++------ doc/tinc.texi | 10 ++++++++-- 2 files changed, 36 insertions(+), 8 deletions(-) diff --git a/doc/tinc.8.in b/doc/tinc.8.in index ebf9df19..374ad42f 100644 --- a/doc/tinc.8.in +++ b/doc/tinc.8.in @@ -1,4 +1,4 @@ -.Dd 2013-01-15 +.Dd 2014-01-16 .Dt TINCCTL 8 .\" Manual page created by: .\" Scott Lamb @@ -13,14 +13,36 @@ .Op Fl -pidfile Ns = Ns Ar FILENAME .Op Fl -help .Op Fl -version -.Ar COMMAND +.Op Ar COMMAND .Sh DESCRIPTION This is the control program of tinc, a secure virtual private network (VPN) project. .Nm -communicates with -.Xr tincd 8 -to alter and inspect the running VPN's state. +can start and stop +.Xr tincd 8 , +and can to alter and inspect the state of a running VPN. +It can also be used to change the configuration, +or to import or export host configuration files from other nodes. + +If +.Nm +is started with a +.Ar COMMAND , +this command is immediately executed, after which +.Nm +exits. +If no +.Ar COMMAND +is given, +.Nm +will act as a shell; +it will display a prompt, and commands can be entered on the prompt. +If +.Nm +is compiled with libreadline, history and command completion are available on the prompt. +One can also pipe a script containing commands through +.Nm . +In that case, lines starting with a # symbol will be ignored. .Sh OPTIONS .Bl -tag -width indent .It Fl n, -net Ns = Ns Ar NETNAME @@ -197,7 +219,7 @@ tinc -n vpn pcap | tcpdump -r - tinc -n vpn top .Pp .Ed -Example of configuring tinc using +Examples of changing the configuration using .Nm : .Bd -literal -offset indent tinc -n vpn init foo diff --git a/doc/tinc.texi b/doc/tinc.texi index 3495fce6..b207a93f 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -2153,13 +2153,19 @@ Be sure to include the following information in your bugreport: @node Controlling tinc @chapter Controlling tinc -You can control and inspect a running tincd through the tinc +You can start, stop, control and inspect a running tincd through the tinc command. A quick example: @example tinc -n @var{netname} reload @end example +If tinc is started without a command, it will act as a shell; it will display a +prompt, and commands can be entered on the prompt. If tinc is compiled with +libreadline, history and command completion are available on the prompt. One +can also pipe a script containing commands through tinc. In that case, lines +starting with a # symbol will be ignored. + @menu * tinc runtime options:: * tinc environment variables:: @@ -2359,7 +2365,7 @@ tinc -n vpn pcap | tcpdump -r - tinc -n vpn top @end example -Example of configuring tinc using the tinc command: +Examples of changing the configuration using tinc: @example tinc -n vpn init foo -- 2.20.1