manpage: display the actual package version
[darkstat.git] / darkstat.8.in
1 .\"
2 .\" darkstat 3
3 .\" Copyright 2001-2010, Emil Mikulic.
4 .\"
5 .\" You may use, modify and redistribute this file under the terms of the
6 .\" GNU General Public License version 2. (see COPYING.GPL)
7 .\"
8 .TH darkstat 8 "March 2010" "@PACKAGE_STRING@"
9 .SH NAME
10 darkstat \- network statistics gatherer
11 .\"
12 .SH SYNOPSIS
13 .B darkstat
14 [
15 .BI \-i " interface"
16 ] [
17 .BI \-r " file"
18 ] [
19 .BI \-\-snaplen " bytes"
20 ] [
21 .BI \-\-pppoe
22 ] [
23 .BI \-\-syslog
24 ] [
25 .BI \-\-verbose
26 ] [
27 .BI \-\-no\-daemon
28 ] [
29 .BI \-\-no\-promisc
30 ] [
31 .BI \-\-no\-dns
32 ] [
33 .BI \-\-no\-macs
34 ] [
35 .BI \-\-no\-lastseen
36 ] [
37 .BI \-p " port"
38 ] [
39 .BI \-b " bindaddr"
40 ] [
41 .BI \-f " filter"
42 ] [
43 .BI \-l " network/netmask"
44 ] [
45 .BI \-\-chroot " dir"
46 ] [
47 .BI \-\-user " username"
48 ] [
49 .BI \-\-daylog " filename"
50 ] [
51 .BI \-\-import " filename"
52 ] [
53 .BI \-\-export " filename"
54 ] [
55 .BI \-\-pidfile " filename"
56 ] [
57 .BI \-\-hosts\-max " count"
58 ] [
59 .BI \-\-hosts\-keep " count"
60 ] [
61 .BI \-\-ports\-max " count"
62 ] [
63 .BI \-\-ports\-keep " count"
64 ] [
65 .BI \-\-highest\-port " port"
66 ] [
67 .BI \-\-wait " secs"
68 ] [
69 .BI \-\-hexdump
70 ]
71 .\"
72 .SH DESCRIPTION
73 .I darkstat
74 is a packet sniffer that runs as a background process,
75 gathers all sorts of statistics about network usage,
76 and serves them over HTTP.
77
78 All settings are passed on the commandline.
79 .\"
80 .SH OPTIONS
81 .\"
82 .TP
83 .BI \-i " interface"
84 Capture traffic on the specified network interface.
85 This is the only mandatory commandline argument.
86 .\"
87 .TP
88 .BI \-r " file"
89 Instead of capturing live traffic, read it from a
90 .BR pcap (3)
91 capture file.
92 This is only useful for development and benchmarking.
93 The
94 .BI \-r
95 and
96 .BI \-i
97 arguments are mutually exclusive.
98 .\"
99 .TP
100 .BI \-\-snaplen " bytes"
101 How many bytes to capture from the start of each packet.
102 You should not need to specify this;
103 \fIdarkstat\fR will calculate it automatically.
104 .\"
105 .TP
106 .BI \-\-pppoe
107 Don't use this.
108
109 Instead, capture on the tunnel interface that your PPPoE software
110 provides, for example \fBtun0\fR on \fIFreeBSD\fR, \fBpppoe0\fR on
111 \fIOpenBSD\fR or \fINetBSD\fR.
112
113 If you really must, you can capture on an Ethernet interface and pass
114 this argument to have \fIdarkstat\fR decode PPPoE frames and ignore
115 everything else.
116 Make sure you also specify your local address with the \fB\-l\fR
117 argument!
118 .\"
119 .TP
120 .BI \-\-syslog
121 Errors, warnings, and verbose messages will go to \fBsyslog\fR (facility
122 daemon, priority debug) instead of \fBstderr\fR.
123
124 On some systems, these messages end up in \fB/var/log/debug\fR
125 by default.
126 .\"
127 .TP
128 .BI \-\-verbose
129 Produce more verbose debugging messages.
130 .\"
131 .TP
132 .BI \-\-no\-daemon
133 Do not detach from the controlling terminal;
134 stay in the foreground.
135 .\"
136 .TP
137 .BI \-\-no\-promisc
138 Do not use promiscuous mode to capture.
139 Note that an interface may already be in promiscuous mode, or may later
140 enter promiscuous mode, due to circumstances beyond \fIdarkstat\fR's control.
141 If this is a problem, use \fB\-f\fR to specify an appropriate
142 .BR bpf (4)
143 filter.
144 .\"
145 .TP
146 .BI \-\-no\-dns
147 Do not resolve IPs to host names.
148 This can significantly reduce memory footprint on small systems
149 as an extra process is created for DNS resolution.
150 .\"
151 .TP
152 .BI \-\-no\-macs
153 Do not display MAC addresses in the hosts table.
154 .\"
155 .TP
156 .BI \-\-no\-lastseen
157 Do not display the last seen time in the hosts table.
158 .\"
159 .TP
160 .BI \-p " port"
161 Bind the web interface to the specified port.
162 The default is 667.
163 .\"
164 .TP
165 .BI \-b " bindaddr"
166 Bind the web interface to the specified address.
167 The default is to listen on all interfaces.
168 .\"
169 .TP
170 .BI \-f " filter"
171 Use the specified filter expression when capturing traffic.
172 The filter syntax is beyond the scope of this manual page;
173 please refer to the
174 .BR tcpdump (1)
175 documentation.
176 .\"
177 .TP
178 .BI \-l " network/netmask"
179 Define a "local network" according to the network and netmask addresses.
180 All traffic entering or leaving this network will be graphed, as opposed
181 to the default behaviour of only graphing traffic to and from the local
182 host.
183 .RS
184
185 The rule is that if \fBip_addr & netmask == network\fR,
186 then that address is considered local.
187 See the usage example below.
188 .RE
189 .\"
190 .TP
191 .BI \-\-chroot " dir"
192 Force \fIdarkstat\fR to \fBchroot()\fR into the specified directory.
193 Without this argument, a default directory will be used, which is
194 determined at build time.
195 Usually \fI/var/empty\fR or \fI/var/lib/empty\fR.
196 .RS
197
198 For security reasons, this directory should be empty, and the user that
199 \fIdarkstat\fR is running as should not have write access to it.
200
201 However, if you wish to use \fB\-\-daylog\fR or \fB\-\-export\fR,
202 \fIdarkstat\fR will need write access to the chroot.
203 If you are uncomfortable with the security implications, don't
204 use any functionality that requires write access.
205 .RE
206 .\"
207 .TP
208 .BI \-\-user " username"
209 Force \fIdarkstat\fR to drop privileges to the \fBuid\fR and \fBgid\fR of
210 the specified user.
211 Without this argument, a default value will be used, which is set at
212 build time.
213 Usually \fBnobody\fR.
214 .RS
215
216 For security reasons, this should not be \fBroot\fR.
217 .RE
218 .\"
219 .TP
220 .BI \-\-daylog " filename"
221 .RS
222 Log daily traffic statistics into the named file, relative to the
223 chroot directory.
224 If you wish to use \fB\-\-daylog\fR, you must first specify a
225 \fB\-\-chroot\fR directory, and it must be writeable by the
226 \fIdarkstat\fR user.
227 A writeable chroot has security implications; if you are uncomfortable
228 with this, do not use the \fB\-\-daylog\fR functionality.
229
230 If the daylog argument is not specified, no logging is performed.
231
232 The daylog format is:
233
234 localtime|time_t|bytes_in|bytes_out|pkts_in|pkts_outs
235
236 Lines starting with a # are comments stating when logging started and
237 stopped.
238 .RE
239 .\"
240 .TP
241 .BI \-\-import " filename"
242 Upon starting, import a \fIdarkstat\fR database from the named file,
243 relative to the chroot directory.
244 If you wish to use \fB\-\-import\fR, you must first specify a
245 \fB\-\-chroot\fR directory.
246 If the import is unsuccessful, \fIdarkstat\fR will start with an empty
247 database.
248 .\"
249 .TP
250 .BI \-\-export " filename"
251 On shutdown, and upon receiving SIGUSR1, export the in-memory database
252 to the named file, relative to the chroot directory.
253 If you wish to use \fB\-\-export\fR, you must first specify a
254 \fB\-\-chroot\fR directory, and it must be writeable by the
255 \fIdarkstat\fR user.
256 A writeable chroot has security implications - if you are uncomfortable
257 with this, do not use the \fB\-\-export\fR functionality.
258 .\"
259 .TP
260 .BI \-\-pidfile " filename"
261 .RS
262 Creates a file containing the process ID of \fIdarkstat\fR.
263 This file will be unlinked upon clean shutdown.
264 As with all pidfiles, if \fIdarkstat\fR dies uncleanly, a stale pidfile
265 can be left over.
266
267 For example, start \fIdarkstat\fR with:
268 .IP
269 darkstat \-i fxp0 \-\-chroot /var/run/darkstat \-\-pidfile darkstat.pid
270 .PP
271 And stop with:
272 .IP
273 kill `cat /var/run/darkstat/darkstat.pid`
274 .PP
275 By default,
276 .BR kill (1)
277 will send SIGTERM, which will cause \fIdarkstat\fR to shut down cleanly.
278 .RE
279 .\"
280 .TP
281 .BI \-\-hosts\-max " count"
282 The maximum number of hosts that will be kept in the hosts table.
283 This is used to limit how much accounting data will be kept in memory.
284 The number of
285 .BI \-\-hosts\-max
286 must be greater than
287 .BI \-\-hosts\-keep
288 .\"
289 .TP
290 .BI \-\-hosts\-keep " count"
291 When the hosts table hits
292 .BI \-\-hosts\-max
293 and traffic is seen from a new host, we clean out the hosts table,
294 keeping only the top
295 .BI \-\-hosts\-keep
296 number of hosts, sorted by total traffic.
297 .\"
298 .TP
299 .BI \-\-ports\-max " count"
300 The maximum number of ports that will be tracked for each host.
301 This is used to limit how much accounting data will be kept in memory.
302 The number of
303 .BI \-\-ports\-max
304 must be greater than
305 .BI \-\-ports\-keep
306 .\"
307 .TP
308 .BI \-\-ports\-keep " count"
309 When a ports table fills up, this many ports are kept and the rest are
310 discarded.
311 .\"
312 .TP
313 .BI \-\-highest\-port " port"
314 Ports that are numerically higher than this will not appear in the
315 per-host ports tables, although their traffic will still be accounted
316 for.
317 This can be used to hide ephemeral ports.
318 By default, all ports are tracked.
319 .\"
320 .TP
321 .BI \-\-wait " secs"
322 Don't use this.
323 It's a hack to help victims of \fINetworkManager\fR and similar systems.
324 .RS
325
326 You should start \fIdarkstat\fR after the capture interface has come up.
327 If you can't, specifying the \fB\-\-wait\fR option will make \fIdarkstat\fR
328 sleep up to the specified number of seconds for the interface to become ready.
329 Zero means wait indefinitely.
330 .RE
331 .\"
332 .TP
333 .BI \-\-hexdump
334 Show hex dumps of received traffic.
335 This is only for debugging, and implies \fB\-\-verbose\fR and
336 \fB\-\-no\-daemon\fR.
337 .\"
338 .\" --------------------------------------------------------------------
339 .SH USAGE EXAMPLES
340 To gather statistics on the
341 .I fxp0
342 interface:
343 .IP
344 darkstat \-i fxp0
345 .PP
346 .\"
347 We want to account for traffic on the Internet-facing interface,
348 but only serve web pages to our private local network where we have the
349 IP address 192.168.0.1:
350 .IP
351 darkstat \-i fxp0 \-b 192.168.0.1
352 .PP
353 .\"
354 We want to serve web pages on the standard HTTP port:
355 .IP
356 darkstat \-i fxp0 \-p 80
357 .PP
358 .\"
359 We are on Optus (cable) and don't want to account for the constant ARP
360 traffic we are receiving:
361 .IP
362 darkstat \-i fxp0 \-f "not arp"
363 .PP
364 .\"
365 We only want to account for SSH traffic:
366 .IP
367 darkstat \-i fxp0 \-f "port 22"
368 .PP
369 .\"
370 We don't want to account for traffic between internal IPs:
371 .IP
372 darkstat \-i fxp0 \-f "not (src net 192.168.0 and dst net 192.168.0)"
373 .PP
374 .\"
375 (For a full reference on filter syntax, refer to the
376 .BR tcpdump (1)
377 manpage)
378 .PP
379 .\"
380 We have a network consisting of a gateway server (192.168.1.1) and a few
381 workstations (192.168.1.2, 192.168.1.3, etc.) and we want to graph all
382 traffic entering and leaving the local network, not just the gateway
383 server (which is running \fIdarkstat\fR):
384 .IP
385 darkstat \-i fxp0 \-l 192.168.1.0/255.255.255.0
386 .PP
387 .\"
388 On some systems, we can't capture on a "decoded" interface but
389 only on \fInas0\fR which returns PPPoE encapsulated packets.
390 Do PPPoE decoding, and override the local IP manually since it
391 cannot be automatically detected.
392 Note the /32 netmask:
393 .IP
394 darkstat \-i nas0 \-\-pppoe \-l 192.168.1.1/255.255.255.255
395 .\"
396 .SH SIGNALS
397 To shut
398 .I darkstat
399 down cleanly, send a SIGTERM or SIGINT signal to the
400 .I darkstat
401 parent process.
402 .PP
403 Sending the SIGUSR1 signal will cause \fIdarkstat\fR to empty out its
404 in-memory database.
405 If an \fB\-\-export\fR file was set, it will first save the database to
406 file.
407 .PP
408 .\"
409 .SH FREQUENTLY ASKED QUESTIONS
410 .SS How many bytes does each bar on the graph represent?
411 Hover your mouse cursor over a bar and you should get a tooltip
412 saying exactly how many bytes in and out the bar represents.
413 .\"
414 .SS Why aren't there labels / tics / a scale on the graphs?
415 Because implementing them is hard.
416 And doing so \fIcorrectly\fR, and in a way that works across all
417 browsers, looks pretty much impossible.
418
419 I might attempt it some day.
420 In the meantime, patches would be gladly accepted.
421 .\"
422 .SS Why are the graphs blank?  All the bars are zero.
423 The graphs only show traffic in/out of the local host, which is
424 determined by getting the IP address of the interface you're sniffing
425 on.
426
427 You can use the \fB\-l\fR argument to override the local address for
428 accounting purposes.
429 You can also use it to do accounting for a whole subnet by specifying
430 an appropriate netmask.
431 .\"
432 .SH SEE ALSO
433 .BR tcpdump (1)
434 .\"
435 .SH HISTORY
436 .I darkstat
437 was written in 2001, largely as a result of a certain Australian
438 cable Internet provider introducing a 3GB monthly traffic limit.
439 .\"
440 .SH AUTHORS
441 Emil Mikulic and others. (see the AUTHORS file)
442 .\"
443 .SH WEBSITE
444 http://dmr.ath.cx/net/darkstat/