Add "network" command to list or switch networks.

[tinc] / doc / tinc.8.in

diff --git a/doc/tinc.8.in b/doc/tinc.8.in
index fba373e..74f182a 100644 (file)
--- 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
 .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
 .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
 .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
 .Sh OPTIONS
 .Bl -tag -width indent
 .It Fl n, -net Ns = Ns Ar NETNAME


@@ -90,6 +112,15 @@ is used.
 The same as export followed by import.
 .It exchange-all Op Fl -force
 The same as export-all followed by import.
 The same as export followed by import.
 .It exchange-all Op Fl -force
 The same as export-all followed by import.

+.It invite Ar name
+Prepares an invitation for a new node with the given
+.Ar name ,
+and prints a short invitation URL that can be used with the join command.
+.It join Op Ar URL
+Join an existing VPN using an invitation URL created using the invite command.
+If no
+.Ar URL
+is given, it will be read from standard input.

 .It start Op tincd options
 Start
 .Xr tincd 8 ,
 .It start Op tincd options
 Start
 .Xr tincd 8 ,


@@ -97,9 +128,10 @@ optionally with the given extra options.
 .It stop
 Stop
 .Xr tincd 8 .
 .It stop
 Stop
 .Xr tincd 8 .

-.It restart
+.It restart Op tincd options

 Restart
 Restart

-.Xr tincd 8 .
+.Xr tincd 8 ,
+optionally with the given extra options.

 .It reload
 Partially rereads configuration files. Connections to hosts whose host
 config files are removed are closed. New outgoing connections specified
 .It reload
 Partially rereads configuration files. Connections to hosts whose host
 config files are removed are closed. New outgoing connections specified


@@ -178,6 +210,11 @@ format to standard output,
 from where it can be redirected to a file or piped through a program that can parse it directly,
 such as
 .Xr tcpdump 8 .
 from where it can be redirected to a file or piped through a program that can parse it directly,
 such as
 .Xr tcpdump 8 .

+.It network Op Ar netname
+If
+.Ar netname
+is given, switch to that network.
+Otherwise, display a list of all networks for which configuration files exist.

 .El
 .Sh EXAMPLES
 Examples of some commands:
 .El
 .Sh EXAMPLES
 Examples of some commands:


@@ -187,7 +224,7 @@ tinc -n vpn pcap | tcpdump -r -
 tinc -n vpn top
 .Pp
 .Ed
 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
 .Nm :
 .Bd -literal -offset indent
 tinc -n vpn init foo