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