Update the documentation of the tinc command.
This commit is contained in:
parent
8af6d64fd9
commit
d8ea66ff1f
2 changed files with 36 additions and 8 deletions
|
@ -1,4 +1,4 @@
|
||||||
.Dd 2013-01-15
|
.Dd 2014-01-16
|
||||||
.Dt TINCCTL 8
|
.Dt TINCCTL 8
|
||||||
.\" Manual page created by:
|
.\" Manual page created by:
|
||||||
.\" Scott Lamb
|
.\" Scott Lamb
|
||||||
|
@ -13,14 +13,36 @@
|
||||||
.Op Fl -pidfile Ns = Ns Ar FILENAME
|
.Op Fl -pidfile Ns = Ns Ar FILENAME
|
||||||
.Op Fl -help
|
.Op Fl -help
|
||||||
.Op Fl -version
|
.Op Fl -version
|
||||||
.Ar COMMAND
|
.Op Ar COMMAND
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
This is the control program of tinc, a secure virtual private network (VPN)
|
This is the control program of tinc, a secure virtual private network (VPN)
|
||||||
project.
|
project.
|
||||||
.Nm
|
.Nm
|
||||||
communicates with
|
can start and stop
|
||||||
.Xr tincd 8
|
.Xr tincd 8 ,
|
||||||
to alter and inspect the running VPN's state.
|
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
|
.Sh OPTIONS
|
||||||
.Bl -tag -width indent
|
.Bl -tag -width indent
|
||||||
.It Fl n, -net Ns = Ns Ar NETNAME
|
.It Fl n, -net Ns = Ns Ar NETNAME
|
||||||
|
@ -197,7 +219,7 @@ tinc -n vpn pcap | tcpdump -r -
|
||||||
tinc -n vpn top
|
tinc -n vpn top
|
||||||
.Pp
|
.Pp
|
||||||
.Ed
|
.Ed
|
||||||
Example of configuring tinc using
|
Examples of changing the configuration using
|
||||||
.Nm :
|
.Nm :
|
||||||
.Bd -literal -offset indent
|
.Bd -literal -offset indent
|
||||||
tinc -n vpn init foo
|
tinc -n vpn init foo
|
||||||
|
|
|
@ -2153,13 +2153,19 @@ Be sure to include the following information in your bugreport:
|
||||||
@node Controlling tinc
|
@node Controlling tinc
|
||||||
@chapter 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:
|
command. A quick example:
|
||||||
|
|
||||||
@example
|
@example
|
||||||
tinc -n @var{netname} reload
|
tinc -n @var{netname} reload
|
||||||
@end example
|
@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
|
@menu
|
||||||
* tinc runtime options::
|
* tinc runtime options::
|
||||||
* tinc environment variables::
|
* tinc environment variables::
|
||||||
|
@ -2359,7 +2365,7 @@ tinc -n vpn pcap | tcpdump -r -
|
||||||
tinc -n vpn top
|
tinc -n vpn top
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
Example of configuring tinc using the tinc command:
|
Examples of changing the configuration using tinc:
|
||||||
|
|
||||||
@example
|
@example
|
||||||
tinc -n vpn init foo
|
tinc -n vpn init foo
|
||||||
|
|
Loading…
Reference in a new issue