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 -controlcookie 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 -controlcookie 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 .cookie.
  35 .It Fl -help
  36 Display short list of options.
  37 .It Fl -version
  38 Output version information and exit.
  39 .El
  40 .Sh COMMANDS
  41 .zZ
  42 .Bl -tag -width indent
  43 .It start
  44 Start
  45 .Xr tincd 8 .
  46 .It stop
  47 Stop
  48 .Xr tincd 8 .
  49 .It restart
  50 Restart
  51 .Xr tincd 8 .
  52 .It reload
  53 Partially rereads configuration files. Connections to hosts whose host
  54 config files are removed are closed. New outgoing connections specified
  55 in
  56 .Xr tinc.conf 5
  57 will be made.
  58 .It pid
  59 Shows the PID of the currently running
  60 .Xr tincd 8 .
  61 .It generate-keys Op bits
  62 Generate public/private RSA keypair and exit.
  63 If
  64 .Ar bits
  65 is omitted, the default length will be 1024 bits.
  66 When saving keys to existing files, tinc will not delete the old keys;
  67 you have to remove them manually.
  68 .It dump nodes
  69 Dump a list of all known nodes in the VPN.
  70 .It dump edges
  71 Dump a list of all known connections in the VPN.
  72 .It dump subnets
  73 Dump a list of all known subnets in the VPN.
  74 .It dump connections
  75 Dump a list of all meta connections with ourself.
  76 .It dump graph
  77 Dump a graph of the VPN in
  78 .Xr dotty 1
  79 format.
  80 .It purge
  81 Purges all information remembered about unreachable nodes.
  82 .It debug Ar N
  83 Sets debug level to
  84 .Ar N .
  85 .It retry
  86 Forces
  87 .Xr tincd 8
  88 to try to connect to all uplinks immediately.
  89 Usually
  90 .Xr tincd 8
  91 attempts to do this itself,
  92 but increases the time it waits between the attempts each time it failed,
  93 and if
  94 .Xr tincd 8
  95 didn't succeed to connect to an uplink the first time after it started,
  96 it defaults to the maximum time of 15 minutes.
  97 .It disconnect Ar NODE
  98 Closes the meta connection with the given
  99 .Ar NODE .
 100 .It top
 101 If
 102 .Nm
 103 is compiled with libcurses support, this will display live traffic statistics
 104 for all the known nodes, similar to the UNIX
 105 .Xr top 1
 106 command.
 107 See below for more information.
 108 .It pcap
 109 Dump VPN traffic going through the local tinc node in
 110 .Xr pcap-savefile 5
 111 format to standard output,
 112 from where it can be redirected to a file or piped through a program that can parse it directly,
 113 such as
 114 .Xr tcpdump 8 .
 115 .El
 116 .Sh EXAMPLES
 117 Examples of some commands:
 118 .Bd -literal -offset indent
 119 tincctl -n vpn dump graph | circo -Txlib
 120 tincctl -n vpn pcap | tcpdump -r -
 121 tincctl -n vpn top
 122 .Ed
 123 .Sh TOP
 124 The top command connects to a running tinc daemon and repeatedly queries its per-node traffic counters.
 125 It displays a list of all the known nodes in the left-most column,
 126 and the amount of bytes and packets read from and sent to each node in the other columns.
 127 By default, the information is updated every second.
 128 The behaviour of the top command can be changed using the following keys:
 129 .Bl -tag
 130 .It Ic s
 131 Change the interval between updates.
 132 After pressing the
 133 .Ic s
 134 key, enter the desired interval in seconds, followed by enter.
 135 Fractional seconds are honored.
 136 Intervals lower than 0.1 seconds are not allowed.
 137 .It Ic c
 138 Toggle between displaying current traffic rates (in packets and bytes per second)
 139 and cummulative traffic (total packets and bytes since the tinc daemon started).
 140 .It Ic n
 141 Sort the list of nodes by name.
 142 .It Ic i
 143 Sort the list of nodes by incoming amount of bytes.
 144 .It Ic I
 145 Sort the list of nodes by incoming amount of packets.
 146 .It Ic o
 147 Sort the list of nodes by outgoing amount of bytes.
 148 .It Ic O
 149 Sort the list of nodes by outgoing amount of packets.
 150 .It Ic t
 151 Sort the list of nodes by sum of incoming and outgoing amount of bytes.
 152 .It Ic T
 153 Sort the list of nodes by sum of incoming and outgoing amount of packets.
 154 .It Ic b
 155 Show amount of traffic in bytes.
 156 .It Ic k
 157 Show amount of traffic in kilobytes.
 158 .It Ic M
 159 Show amount of traffic in megabytes.
 160 .It Ic G
 161 Show amount of traffic in gigabytes.
 162 .It Ic q , ESC
 163 Quit.
 164 .El
 165 .Sh BUGS
 166 If you find any bugs, report them to tinc@tinc-vpn.org.
 167 .Sh SEE ALSO
 168 .Xr tincd 8 ,
 169 .Xr tinc.conf 5 ,
 170 .Xr dotty 1 ,
 171 .Xr pcap-savefile 7 ,
 172 .Xr tcpdump 8 ,
 173 .Xr top 1 ,
 174 .Pa http://www.tinc-vpn.org/ ,
 175 .Pa http://www.cabal.org/ .
 176 .Pp
 177 The full documentation for tinc is maintained as a Texinfo manual.
 178 If the info and tinc programs are properly installed at your site,
 179 the command
 180 .Ic info tinc
 181 should give you access to the complete manual.
 182 .Pp
 183 tinc comes with ABSOLUTELY NO WARRANTY.
 184 This is free software, and you are welcome to redistribute it under certain conditions;
 185 see the file COPYING for details.
 186 .Sh AUTHORS
 187 .An "Ivo Timmermans"
 188 .An "Guus Sliepen" Aq guus@tinc-vpn.org
 189 .Pp
 190 And thanks to many others for their contributions to tinc!