Whoops, I included sys/types in the wrong file.
[darkstat.git] / darkstat.8.in
1 .\"
2 .\" darkstat 3
3 .\" Copyright 2001-2011, 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 "June 2011" "@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, or upon receiving SIGUSR1 or SIGUSR2,
252 export the in-memory database
253 to the named file, relative to the chroot directory.
254 If you wish to use \fB\-\-export\fR, you must first specify a
255 \fB\-\-chroot\fR directory, and it must be writeable by the
256 \fIdarkstat\fR user.
257 A writeable chroot has security implications - if you are uncomfortable
258 with this, do not use the \fB\-\-export\fR functionality.
259 .\"
260 .TP
261 .BI \-\-pidfile " filename"
262 .RS
263 Creates a file containing the process ID of \fIdarkstat\fR.
264 This file will be unlinked upon clean shutdown.
265 As with all pidfiles, if \fIdarkstat\fR dies uncleanly, a stale pidfile
266 can be left over.
267
268 For example, start \fIdarkstat\fR with:
269 .IP
270 darkstat \-i fxp0 \-\-chroot /var/run/darkstat \-\-pidfile darkstat.pid
271 .PP
272 And stop with:
273 .IP
274 kill `cat /var/run/darkstat/darkstat.pid`
275 .PP
276 By default,
277 .BR kill (1)
278 will send SIGTERM, which will cause \fIdarkstat\fR to shut down cleanly.
279 .RE
280 .\"
281 .TP
282 .BI \-\-hosts\-max " count"
283 The maximum number of hosts that will be kept in the hosts table.
284 This is used to limit how much accounting data will be kept in memory.
285 The number of
286 .BI \-\-hosts\-max
287 must be greater than
288 .BI \-\-hosts\-keep
289 .\"
290 .TP
291 .BI \-\-hosts\-keep " count"
292 When the hosts table hits
293 .BI \-\-hosts\-max
294 and traffic is seen from a new host, we clean out the hosts table,
295 keeping only the top
296 .BI \-\-hosts\-keep
297 number of hosts, sorted by total traffic.
298 .\"
299 .TP
300 .BI \-\-ports\-max " count"
301 The maximum number of ports that will be tracked for each host.
302 This is used to limit how much accounting data will be kept in memory.
303 The number of
304 .BI \-\-ports\-max
305 must be greater than
306 .BI \-\-ports\-keep
307 .\"
308 .TP
309 .BI \-\-ports\-keep " count"
310 When a ports table fills up, this many ports are kept and the rest are
311 discarded.
312 .\"
313 .TP
314 .BI \-\-highest\-port " port"
315 Ports that are numerically higher than this will not appear in the
316 per-host ports tables, although their traffic will still be accounted
317 for.
318 This can be used to hide ephemeral ports.
319 By default, all ports are tracked.
320 .\"
321 .TP
322 .BI \-\-wait " secs"
323 Don't use this.
324 It's a hack to help victims of \fINetworkManager\fR and similar systems.
325 .RS
326
327 You should start \fIdarkstat\fR after the capture interface has come up.
328 If you can't, specifying the \fB\-\-wait\fR option will make \fIdarkstat\fR
329 sleep up to the specified number of seconds for the interface to become ready.
330 Zero means wait indefinitely.
331 .RE
332 .\"
333 .TP
334 .BI \-\-hexdump
335 Show hex dumps of received traffic.
336 This is only for debugging, and implies \fB\-\-verbose\fR and
337 \fB\-\-no\-daemon\fR.
338 .\"
339 .\" --------------------------------------------------------------------
340 .SH USAGE EXAMPLES
341 To gather statistics on the
342 .I fxp0
343 interface:
344 .IP
345 darkstat \-i fxp0
346 .PP
347 .\"
348 We want to account for traffic on the Internet-facing interface,
349 but only serve web pages to our private local network where we have the
350 IP address 192.168.0.1:
351 .IP
352 darkstat \-i fxp0 \-b 192.168.0.1
353 .PP
354 .\"
355 We want to serve web pages on the standard HTTP port:
356 .IP
357 darkstat \-i fxp0 \-p 80
358 .PP
359 .\"
360 We are on Optus (cable) and don't want to account for the constant ARP
361 traffic we are receiving:
362 .IP
363 darkstat \-i fxp0 \-f "not arp"
364 .PP
365 .\"
366 We only want to account for SSH traffic:
367 .IP
368 darkstat \-i fxp0 \-f "port 22"
369 .PP
370 .\"
371 We don't want to account for traffic between internal IPs:
372 .IP
373 darkstat \-i fxp0 \-f "not (src net 192.168.0 and dst net 192.168.0)"
374 .PP
375 .\"
376 (For a full reference on filter syntax, refer to the
377 .BR tcpdump (1)
378 manpage)
379 .PP
380 .\"
381 We have a network consisting of a gateway server (192.168.1.1) and a few
382 workstations (192.168.1.2, 192.168.1.3, etc.) and we want to graph all
383 traffic entering and leaving the local network, not just the gateway
384 server (which is running \fIdarkstat\fR):
385 .IP
386 darkstat \-i fxp0 \-l 192.168.1.0/255.255.255.0
387 .PP
388 .\"
389 On some systems, we can't capture on a "decoded" interface but
390 only on \fInas0\fR which returns PPPoE encapsulated packets.
391 Do PPPoE decoding, and override the local IP manually since it
392 cannot be automatically detected.
393 Note the /32 netmask:
394 .IP
395 darkstat \-i nas0 \-\-pppoe \-l 192.168.1.1/255.255.255.255
396 .\"
397 .SH SIGNALS
398 To shut
399 .I darkstat
400 down cleanly, send a SIGTERM or SIGINT signal to the
401 .I darkstat
402 parent process.
403 .PP
404 Sending the SIGUSR1 signal will cause \fIdarkstat\fR to empty out its
405 in-memory database.
406 If an \fB\-\-export\fR file was set, it will first save the database to
407 file.
408 Sending SIGUSR2 will save the database without emptying it.
409 .PP
410 .\"
411 .SH FREQUENTLY ASKED QUESTIONS
412 .SS How many bytes does each bar on the graph represent?
413 Hover your mouse cursor over a bar and you should get a tooltip
414 saying exactly how many bytes in and out the bar represents.
415 .\"
416 .SS Why aren't there labels / tics / a scale on the graphs?
417 Because implementing them is hard.
418 And doing so \fIcorrectly\fR, and in a way that works across all
419 browsers, looks pretty much impossible.
420
421 I might attempt it some day.
422 In the meantime, patches would be gladly accepted.
423 .\"
424 .SS Why are the graphs blank?  All the bars are zero.
425 The graphs only show traffic in/out of the local host, which is
426 determined by getting the IP address of the interface you're sniffing
427 on.
428
429 You can use the \fB\-l\fR argument to override the local address for
430 accounting purposes.
431 You can also use it to do accounting for a whole subnet by specifying
432 an appropriate netmask.
433 .\"
434 .SH SEE ALSO
435 .BR tcpdump (1)
436 .\"
437 .SH HISTORY
438 .I darkstat
439 was written in 2001, largely as a result of a certain Australian
440 cable Internet provider introducing a 3GB monthly traffic limit.
441 .\"
442 .SH AUTHORS
443 Emil Mikulic and others. (see the AUTHORS file)
444 .\"
445 .SH WEBSITE
446 @PACKAGE_URL@