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

   1 .Dd 2012-10-14
   2 .Dt TINCCTL 8
   3 .\" Manual page created by:
   4 .\" Scott Lamb
   5 .Sh NAME
   6 .Nm tincctl
   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 config Oo get Oc 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 config Oo set Oc 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 config add Ar variable Ar value
  68 As above, but without removing any previously existing configuration variables.
  69 .It config 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 start Op tincd options
  90 Start
  91 .Xr tincd 8 ,
  92 optionally with the given extra options.
  93 .It stop
  94 Stop
  95 .Xr tincd 8 .
  96 .It restart
  97 Restart
  98 .Xr tincd 8 .
  99 .It reload
 100 Partially rereads configuration files. Connections to hosts whose host
 101 config files are removed are closed. New outgoing connections specified
 102 in
 103 .Xr tinc.conf 5
 104 will be made.
 105 .It pid
 106 Shows the PID of the currently running
 107 .Xr tincd 8 .
 108 .It generate-keys Op bits
 109 Generate both RSA and ECDSA keypairs (see below) and exit.
 110 .It generate-ecdsa-keys
 111 Generate public/private ECDSA keypair and exit.
 112 .It generate-rsa-keys Op bits
 113 Generate public/private RSA keypair and exit.
 114 If
 115 .Ar bits
 116 is omitted, the default length will be 2048 bits.
 117 When saving keys to existing files, tinc will not delete the old keys;
 118 you have to remove them manually.
 119 .It dump [reachable] nodes
 120 Dump a list of all known nodes in the VPN.
 121 If the keyword reachable is used, only lists reachable nodes.
 122 .It dump edges
 123 Dump a list of all known connections in the VPN.
 124 .It dump subnets
 125 Dump a list of all known subnets in the VPN.
 126 .It dump connections
 127 Dump a list of all meta connections with ourself.
 128 .It dump graph | digraph
 129 Dump a graph of the VPN in
 130 .Xr dotty 1
 131 format.
 132 Nodes are colored according to their reachability:
 133 red nodes are unreachable, orange nodes are indirectly reachable, green nodes are directly reachable.
 134 Black nodes are either directly or indirectly reachable, but direct reachability has not been tried yet.
 135 .It info Ar node | subnet | address
 136 Show information about a particular node, subnet or address.
 137 If an address is given, any matching subnet will be shown.
 138 .It purge
 139 Purges all information remembered about unreachable nodes.
 140 .It debug Ar N
 141 Sets debug level to
 142 .Ar N .
 143 .It log Op Ar N
 144 Capture log messages from a running tinc daemon.
 145 An optional debug level can be given that will be applied only for log messages sent to
 146 .Nm tincctl .
 147 .It retry
 148 Forces
 149 .Xr tincd 8
 150 to try to connect to all uplinks immediately.
 151 Usually
 152 .Xr tincd 8
 153 attempts to do this itself,
 154 but increases the time it waits between the attempts each time it failed,
 155 and if
 156 .Xr tincd 8
 157 didn't succeed to connect to an uplink the first time after it started,
 158 it defaults to the maximum time of 15 minutes.
 159 .It disconnect Ar NODE
 160 Closes the meta connection with the given
 161 .Ar NODE .
 162 .It top
 163 If
 164 .Nm
 165 is compiled with libcurses support, this will display live traffic statistics
 166 for all the known nodes, similar to the UNIX
 167 .Xr top 1
 168 command.
 169 See below for more information.
 170 .It pcap
 171 Dump VPN traffic going through the local tinc node in
 172 .Xr pcap-savefile 5
 173 format to standard output,
 174 from where it can be redirected to a file or piped through a program that can parse it directly,
 175 such as
 176 .Xr tcpdump 8 .
 177 .El
 178 .Sh EXAMPLES
 179 Examples of some commands:
 180 .Bd -literal -offset indent
 181 tincctl -n vpn dump graph | circo -Txlib
 182 tincctl -n vpn pcap | tcpdump -r -
 183 tincctl -n vpn top
 184 .Pp
 185 .Ed
 186 Example of configuring tinc using
 187 .Nm :
 188 .Bd -literal -offset indent
 189 tincctl -n vpn init foo
 190 tincctl -n vpn config Subnet 192.168.1.0/24
 191 tincctl -n vpn config bar.Address bar.example.com
 192 tincctl -n vpn config ConnectTo bar
 193 tincctl -n vpn export | gpg --clearsign | mail -s "My config" vpnmaster@example.com
 194 .Ed
 195 .Sh TOP
 196 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
 197 It displays a list of all the known nodes in the left-most column,
 198 and the amount of bytes and packets read from and sent to each node in the other columns.
 199 By default, the information is updated every second.
 200 The behaviour of the top command can be changed using the following keys:
 201 .Bl -tag
 202 .It Ic s
 203 Change the interval between updates.
 204 After pressing the
 205 .Ic s
 206 key, enter the desired interval in seconds, followed by enter.
 207 Fractional seconds are honored.
 208 Intervals lower than 0.1 seconds are not allowed.
 209 .It Ic c
 210 Toggle between displaying current traffic rates (in packets and bytes per second)
 211 and cumulative traffic (total packets and bytes since the tinc daemon started).
 212 .It Ic n
 213 Sort the list of nodes by name.
 214 .It Ic i
 215 Sort the list of nodes by incoming amount of bytes.
 216 .It Ic I
 217 Sort the list of nodes by incoming amount of packets.
 218 .It Ic o
 219 Sort the list of nodes by outgoing amount of bytes.
 220 .It Ic O
 221 Sort the list of nodes by outgoing amount of packets.
 222 .It Ic t
 223 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
 224 .It Ic T
 225 Sort the list of nodes by sum of incoming and outgoing amount of packets.
 226 .It Ic b
 227 Show amount of traffic in bytes.
 228 .It Ic k
 229 Show amount of traffic in kilobytes.
 230 .It Ic M
 231 Show amount of traffic in megabytes.
 232 .It Ic G
 233 Show amount of traffic in gigabytes.
 234 .It Ic q
 235 Quit.
 236 .El
 237 .Sh BUGS
 238 If you find any bugs, report them to tinc@tinc-vpn.org.
 239 .Sh SEE ALSO
 240 .Xr tincd 8 ,
 241 .Xr tinc.conf 5 ,
 242 .Xr dotty 1 ,
 243 .Xr pcap-savefile 5 ,
 244 .Xr tcpdump 8 ,
 245 .Xr top 1 ,
 246 .Pa http://www.tinc-vpn.org/ ,
 247 .Pa http://www.cabal.org/ .
 248 .Pp
 249 The full documentation for tinc is maintained as a Texinfo manual.
 250 If the info and tinc programs are properly installed at your site,
 251 the command
 252 .Ic info tinc
 253 should give you access to the complete manual.
 254 .Pp
 255 tinc comes with ABSOLUTELY NO WARRANTY.
 256 This is free software, and you are welcome to redistribute it under certain conditions;
 257 see the file COPYING for details.
 258 .Sh AUTHORS
 259 .An "Ivo Timmermans"
 260 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 261 .Pp
 262 And thanks to many others for their contributions to tinc!