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

   1 .Dd 2011-06-25
   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 .zZ
  49 .Bl -tag -width indent
  50 .It init Op Ar name
  51 Create initial configuration files and RSA and ECDSA keypairs with default length.
  52 If no
  53 .Ar name
  54 for this node is given, it will be asked for.
  55 .It config Oo set Oc Ar variable Ar value
  56 Set configuration variable
  57 .Ar variable
  58 to the given
  59 .Ar value .
  60 All previously existing configuration variables with the same name are removed.
  61 To set a variable for a specific host, use the notation
  62 .Ar host Ns Li . Ns Ar variable .
  63 .It config add Ar variable Ar value
  64 As above, but without removing any previously existing configuration variables.
  65 .It config del Ar variable Op Ar value
  66 Remove configuration variables with the same name and
  67 .Ar value .
  68 If no
  69 .Ar value
  70 is given, all configuration variables with the same name will be removed.
  71 .It edit Ar filename
  72 Start an editor for the given configuration file.
  73 You do not need to specify the full path to the file.
  74 .It start
  75 Start
  76 .Xr tincd 8 .
  77 .It stop
  78 Stop
  79 .Xr tincd 8 .
  80 .It restart
  81 Restart
  82 .Xr tincd 8 .
  83 .It reload
  84 Partially rereads configuration files. Connections to hosts whose host
  85 config files are removed are closed. New outgoing connections specified
  86 in
  87 .Xr tinc.conf 5
  88 will be made.
  89 .It pid
  90 Shows the PID of the currently running
  91 .Xr tincd 8 .
  92 .It generate-keys Op bits
  93 Generate both RSA and ECDSA keypairs (see below) and exit.
  94 .It generate-ecdsa-keys
  95 Generate public/private ECDSA keypair and exit.
  96 .It generate-rsa-keys Op bits
  97 Generate public/private RSA keypair and exit.
  98 If
  99 .Ar bits
 100 is omitted, the default length will be 2048 bits.
 101 When saving keys to existing files, tinc will not delete the old keys;
 102 you have to remove them manually.
 103 .It dump nodes
 104 Dump a list of all known nodes in the VPN.
 105 .It dump edges
 106 Dump a list of all known connections in the VPN.
 107 .It dump subnets
 108 Dump a list of all known subnets in the VPN.
 109 .It dump connections
 110 Dump a list of all meta connections with ourself.
 111 .It dump graph
 112 Dump a graph of the VPN in
 113 .Xr dotty 1
 114 format.
 115 .It purge
 116 Purges all information remembered about unreachable nodes.
 117 .It debug Ar N
 118 Sets debug level to
 119 .Ar N .
 120 .It log Op Ar N
 121 Capture log messages from a running tinc daemon.
 122 An optional debug level can be given that will be applied only for log messages sent to
 123 .Nm tincctl .
 124 .It retry
 125 Forces
 126 .Xr tincd 8
 127 to try to connect to all uplinks immediately.
 128 Usually
 129 .Xr tincd 8
 130 attempts to do this itself,
 131 but increases the time it waits between the attempts each time it failed,
 132 and if
 133 .Xr tincd 8
 134 didn't succeed to connect to an uplink the first time after it started,
 135 it defaults to the maximum time of 15 minutes.
 136 .It disconnect Ar NODE
 137 Closes the meta connection with the given
 138 .Ar NODE .
 139 .It top
 140 If
 141 .Nm
 142 is compiled with libcurses support, this will display live traffic statistics
 143 for all the known nodes, similar to the UNIX
 144 .Xr top 1
 145 command.
 146 See below for more information.
 147 .It pcap
 148 Dump VPN traffic going through the local tinc node in
 149 .Xr pcap-savefile 5
 150 format to standard output,
 151 from where it can be redirected to a file or piped through a program that can parse it directly,
 152 such as
 153 .Xr tcpdump 8 .
 154 .El
 155 .Sh EXAMPLES
 156 Examples of some commands:
 157 .Bd -literal -offset indent
 158 tincctl -n vpn dump graph | circo -Txlib
 159 tincctl -n vpn pcap | tcpdump -r -
 160 tincctl -n vpn top
 161 .Pp
 162 .Ed
 163 Example of configuring tinc using
 164 .Nm :
 165 .Bd -literal -offset indent
 166 tincctl -n vpn init foo
 167 tincctl -n vpn config Subnet 192.168.1.0/24
 168 tincctl -n vpn config bar.Address bar.example.com
 169 tincctl -n vpn config ConnectTo bar
 170 .Sh TOP
 171 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
 172 It displays a list of all the known nodes in the left-most column,
 173 and the amount of bytes and packets read from and sent to each node in the other columns.
 174 By default, the information is updated every second.
 175 The behaviour of the top command can be changed using the following keys:
 176 .Bl -tag
 177 .It Ic s
 178 Change the interval between updates.
 179 After pressing the
 180 .Ic s
 181 key, enter the desired interval in seconds, followed by enter.
 182 Fractional seconds are honored.
 183 Intervals lower than 0.1 seconds are not allowed.
 184 .It Ic c
 185 Toggle between displaying current traffic rates (in packets and bytes per second)
 186 and cummulative traffic (total packets and bytes since the tinc daemon started).
 187 .It Ic n
 188 Sort the list of nodes by name.
 189 .It Ic i
 190 Sort the list of nodes by incoming amount of bytes.
 191 .It Ic I
 192 Sort the list of nodes by incoming amount of packets.
 193 .It Ic o
 194 Sort the list of nodes by outgoing amount of bytes.
 195 .It Ic O
 196 Sort the list of nodes by outgoing amount of packets.
 197 .It Ic t
 198 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
 199 .It Ic T
 200 Sort the list of nodes by sum of incoming and outgoing amount of packets.
 201 .It Ic b
 202 Show amount of traffic in bytes.
 203 .It Ic k
 204 Show amount of traffic in kilobytes.
 205 .It Ic M
 206 Show amount of traffic in megabytes.
 207 .It Ic G
 208 Show amount of traffic in gigabytes.
 209 .It Ic q
 210 Quit.
 211 .El
 212 .Sh BUGS
 213 If you find any bugs, report them to tinc@tinc-vpn.org.
 214 .Sh SEE ALSO
 215 .Xr tincd 8 ,
 216 .Xr tinc.conf 5 ,
 217 .Xr dotty 1 ,
 218 .Xr pcap-savefile 7 ,
 219 .Xr tcpdump 8 ,
 220 .Xr top 1 ,
 221 .Pa http://www.tinc-vpn.org/ ,
 222 .Pa http://www.cabal.org/ .
 223 .Pp
 224 The full documentation for tinc is maintained as a Texinfo manual.
 225 If the info and tinc programs are properly installed at your site,
 226 the command
 227 .Ic info tinc
 228 should give you access to the complete manual.
 229 .Pp
 230 tinc comes with ABSOLUTELY NO WARRANTY.
 231 This is free software, and you are welcome to redistribute it under certain conditions;
 232 see the file COPYING for details.
 233 .Sh AUTHORS
 234 .An "Ivo Timmermans"
 235 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 236 .Pp
 237 And thanks to many others for their contributions to tinc!