tinc-vpn.org Git - tinc/blob - doc/tinc.8.in

   1 .Dd 2013-01-15
   2 .Dt TINCCTL 8
   3 .\" Manual page created by:
   4 .\" Scott Lamb
   5 .Sh NAME
   6 .Nm tinc
   7 .Nd tinc VPN control
   8 .Sh SYNOPSIS
   9 .Nm
  10 .Op Fl cn
  11 .Op Fl -config Ns = Ns Ar DIR
  12 .Op Fl -net Ns = Ns Ar NETNAME
  13 .Op Fl -pidfile Ns = Ns Ar FILENAME
  14 .Op Fl -help
  15 .Op Fl -version
  16 .Ar COMMAND
  17 .Sh DESCRIPTION
  18 This is the control program of tinc, a secure virtual private network (VPN)
  19 project.
  20 .Nm
  21 communicates with
  22 .Xr tincd 8
  23 to alter and inspect the running VPN's state.
  24 .Sh OPTIONS
  25 .Bl -tag -width indent
  26 .It Fl n, -net Ns = Ns Ar NETNAME
  27 Communicate with tincd(8) connected with
  28 .Ar NETNAME .
  29 .It Fl -pidfile Ns = Ns Ar FILENAME
  30 Use the cookie from
  31 .Ar FILENAME
  32 to authenticate with a running tinc daemon.
  33 If unspecified, the default is
  34 .Pa @localstatedir@/run/tinc. Ns Ar NETNAME Ns Pa .pid.
  35 .It Fl -help
  36 Display short list of options.
  37 .It Fl -version
  38 Output version information and exit.
  39 .El
  40 .Sh ENVIRONMENT VARIABLES
  41 .Bl -tag -width indent
  42 .It Ev NETNAME
  43 If no netname is specified on the command line with the
  44 .Fl n
  45 option, the value of this environment variable is used.
  46 .El
  47 .Sh COMMANDS
  48 .Bl -tag -width indent
  49 .It init Op Ar name
  50 Create initial configuration files and RSA and ECDSA keypairs with default length.
  51 If no
  52 .Ar name
  53 for this node is given, it will be asked for.
  54 .It get Ar variable
  55 Print the current value of configuration variable
  56 .Ar variable .
  57 If more than one variable with the same name exists,
  58 the value of each of them will be printed on a separate line.
  59 .It set Ar variable Ar value
  60 Set configuration variable
  61 .Ar variable
  62 to the given
  63 .Ar value .
  64 All previously existing configuration variables with the same name are removed.
  65 To set a variable for a specific host, use the notation
  66 .Ar host Ns Li . Ns Ar variable .
  67 .It add Ar variable Ar value
  68 As above, but without removing any previously existing configuration variables.
  69 .It del Ar variable Op Ar value
  70 Remove configuration variables with the same name and
  71 .Ar value .
  72 If no
  73 .Ar value
  74 is given, all configuration variables with the same name will be removed.
  75 .It edit Ar filename
  76 Start an editor for the given configuration file.
  77 You do not need to specify the full path to the file.
  78 .It export
  79 Export the host configuration file of the local node to standard output.
  80 .It export-all
  81 Export all host configuration files to standard output.
  82 .It import Op Fl -force
  83 Import host configuration data generated by the
  84 .Nm
  85 export command from standard input.
  86 Already existing host configuration files are not overwritten unless the option
  87 .Fl -force
  88 is used.
  89 .It exchange Op Fl -force
  90 The same as export followed by import.
  91 .It exchange-all Op Fl -force
  92 The same as export-all followed by import.
  93 .It start Op tincd options
  94 Start
  95 .Xr tincd 8 ,
  96 optionally with the given extra options.
  97 .It stop
  98 Stop
  99 .Xr tincd 8 .
 100 .It restart
 101 Restart
 102 .Xr tincd 8 .
 103 .It reload
 104 Partially rereads configuration files. Connections to hosts whose host
 105 config files are removed are closed. New outgoing connections specified
 106 in
 107 .Xr tinc.conf 5
 108 will be made.
 109 .It pid
 110 Shows the PID of the currently running
 111 .Xr tincd 8 .
 112 .It generate-keys Op bits
 113 Generate both RSA and ECDSA keypairs (see below) and exit.
 114 .It generate-ecdsa-keys
 115 Generate public/private ECDSA keypair and exit.
 116 .It generate-rsa-keys Op bits
 117 Generate public/private RSA keypair and exit.
 118 If
 119 .Ar bits
 120 is omitted, the default length will be 2048 bits.
 121 When saving keys to existing files, tinc will not delete the old keys;
 122 you have to remove them manually.
 123 .It dump [reachable] nodes
 124 Dump a list of all known nodes in the VPN.
 125 If the keyword reachable is used, only lists reachable nodes.
 126 .It dump edges
 127 Dump a list of all known connections in the VPN.
 128 .It dump subnets
 129 Dump a list of all known subnets in the VPN.
 130 .It dump connections
 131 Dump a list of all meta connections with ourself.
 132 .It dump graph | digraph
 133 Dump a graph of the VPN in
 134 .Xr dotty 1
 135 format.
 136 Nodes are colored according to their reachability:
 137 red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable.
 138 Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet.
 139 .It info Ar node | subnet | address
 140 Show information about a particular node, subnet or address.
 141 If an address is given, any matching subnet will be shown.
 142 .It purge
 143 Purges all information remembered about unreachable nodes.
 144 .It debug Ar N
 145 Sets debug level to
 146 .Ar N .
 147 .It log Op Ar N
 148 Capture log messages from a running tinc daemon.
 149 An optional debug level can be given that will be applied only for log messages sent to
 150 .Nm tinc .
 151 .It retry
 152 Forces
 153 .Xr tincd 8
 154 to try to connect to all uplinks immediately.
 155 Usually
 156 .Xr tincd 8
 157 attempts to do this itself,
 158 but increases the time it waits between the attempts each time it failed,
 159 and if
 160 .Xr tincd 8
 161 didn't succeed to connect to an uplink the first time after it started,
 162 it defaults to the maximum time of 15 minutes.
 163 .It disconnect Ar NODE
 164 Closes the meta connection with the given
 165 .Ar NODE .
 166 .It top
 167 If
 168 .Nm
 169 is compiled with libcurses support, this will display live traffic statistics
 170 for all the known nodes, similar to the UNIX
 171 .Xr top 1
 172 command.
 173 See below for more information.
 174 .It pcap
 175 Dump VPN traffic going through the local tinc node in
 176 .Xr pcap-savefile 5
 177 format to standard output,
 178 from where it can be redirected to a file or piped through a program that can parse it directly,
 179 such as
 180 .Xr tcpdump 8 .
 181 .El
 182 .Sh EXAMPLES
 183 Examples of some commands:
 184 .Bd -literal -offset indent
 185 tinc -n vpn dump graph | circo -Txlib
 186 tinc -n vpn pcap | tcpdump -r -
 187 tinc -n vpn top
 188 .Pp
 189 .Ed
 190 Example of configuring tinc using
 191 .Nm :
 192 .Bd -literal -offset indent
 193 tinc -n vpn init foo
 194 tinc -n vpn add Subnet 192.168.1.0/24
 195 tinc -n vpn add bar.Address bar.example.com
 196 tinc -n vpn add ConnectTo bar
 197 tinc -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@example.com
 198 .Ed
 199 .Sh TOP
 200 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
 201 It displays a list of all the known nodes in the left-most column,
 202 and the amount of bytes and packets read from and sent to each node in the other columns.
 203 By default, the information is updated every second.
 204 The behaviour of the top command can be changed using the following keys:
 205 .Bl -tag
 206 .It Ic s
 207 Change the interval between updates.
 208 After pressing the
 209 .Ic s
 210 key, enter the desired interval in seconds, followed by enter.
 211 Fractional seconds are honored.
 212 Intervals lower than 0.1 seconds are not allowed.
 213 .It Ic c
 214 Toggle between displaying current traffic rates (in packets and bytes per second)
 215 and cumulative traffic (total packets and bytes since the tinc daemon started).
 216 .It Ic n
 217 Sort the list of nodes by name.
 218 .It Ic i
 219 Sort the list of nodes by incoming amount of bytes.
 220 .It Ic I
 221 Sort the list of nodes by incoming amount of packets.
 222 .It Ic o
 223 Sort the list of nodes by outgoing amount of bytes.
 224 .It Ic O
 225 Sort the list of nodes by outgoing amount of packets.
 226 .It Ic t
 227 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
 228 .It Ic T
 229 Sort the list of nodes by sum of incoming and outgoing amount of packets.
 230 .It Ic b
 231 Show amount of traffic in bytes.
 232 .It Ic k
 233 Show amount of traffic in kilobytes.
 234 .It Ic M
 235 Show amount of traffic in megabytes.
 236 .It Ic G
 237 Show amount of traffic in gigabytes.
 238 .It Ic q
 239 Quit.
 240 .El
 241 .Sh BUGS
 242 If you find any bugs, report them to tinc@tinc-vpn.org.
 243 .Sh SEE ALSO
 244 .Xr tincd 8 ,
 245 .Xr tinc.conf 5 ,
 246 .Xr dotty 1 ,
 247 .Xr pcap-savefile 5 ,
 248 .Xr tcpdump 8 ,
 249 .Xr top 1 ,
 250 .Pa http://www.tinc-vpn.org/ ,
 251 .Pa http://www.cabal.org/ .
 252 .Pp
 253 The full documentation for tinc is maintained as a Texinfo manual.
 254 If the info and tinc programs are properly installed at your site,
 255 the command
 256 .Ic info tinc
 257 should give you access to the complete manual.
 258 .Pp
 259 tinc comes with ABSOLUTELY NO WARRANTY.
 260 This is free software, and you are welcome to redistribute it under certain conditions;
 261 see the file COPYING for details.
 262 .Sh AUTHORS
 263 .An "Ivo Timmermans"
 264 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 265 .Pp
 266 And thanks to many others for their contributions to tinc!