Debian Codegraph @

upstream/debian-unstable/man8/iptraf-ng.8

raw
1 .TH IPTRAF-NG 8 "IPTraf-ng Help Page"
2 .SH NAME
3 iptraf \- Interactive Colorful IP LAN Monitor
4 .SH SYNOPSIS
5 .BR iptraf-ng " { [ " \-f " ] [ { " \-i
6 .IR iface " | "
7 .BR \-g " | " \-d
8 .IR iface " | "
9 .BR \-s
10 .IR iface " | "
11 .BR \-z
12 .IR iface " | "
13 .BR \-l
14 .IR iface " } [ "
15 .BR \-t
16 .IR timeout " ] [ "
17 .BR \-B " [ "
18 .BR \-L
19 .IR logfile " ] ] ] | [ "
20 .BR \-h " ] }"
21 .br
22 .SH DESCRIPTION
23 .B iptraf-ng
24 is an ncurses-based IP LAN monitor that generates various network statistics including TCP info, UDP counts, ICMP and OSPF information, Ethernet load info, node stats, IP checksum errors, and others.
25 .PP
26 If the
27 .B iptraf-ng
28 command is issued without any command-line options, the program comes up in interactive mode, with the various facilities accessed through the main menu.
29
30 .SH OPTIONS
31 These options can also be supplied to the command:
32 .TP
33 .BI "\-i " iface
34 immediately start the IP traffic monitor on the specified interface, or
35 all interfaces if "\-i all" is specified
36 .TP
37 .B "\-g"
38 immediately start the general interface statistics
39 .TP
40 .BI "\-d " iface
41 allows you to immediately start the detailed on the indicated interface (iface)
42 .TP
43 .BI "\-s " iface
44 allows you to immediately monitor TCP and UDP traffic on the specified interface (iface)
45 .TP
46 .BI "\-z " iface
47 shows packet counts by size on the specified interface
48 .TP
49 .BI "\-l " iface
50 start the LAN station monitor on the specified interface, or all LAN
51 interfaces if "\-l all" is specified
52 .TP
53 .BI "\-t " timeout
54 tells IPTraf-ng to run the specified facility for only
55 .I timeout
56 minutes. This option is used only with one of the above parameters.
57 .TP
58 .B "\-B"
59 redirect standard output to /dev/null, closes standard input, and forks
60 the program into the background. Can be used only with one of the
61 facility invocation parameters above. Send the backgrounded process a
62 USR2 signal to terminate.
63 .TP
64 .B "\-L logfile"
65 allows you to specify an alternate log file name. The default log file
66 name is based on either the interface selected (detailed interface
67 statistics, TCP/UDP service statistics, packet size breakdown), or the
68 instance of the facility (IP traffic monitor, LAN station monitor). If a
69 path is not specified, the log file is placed in
70 .B /var/log/iptraf-ng
71 .TP
72 .B "\-f"
73 clears all locks and counters, causing this instance of IPTraf-ng to think
74 it's the first one running. This should only be used to recover from
75 an abnormal termination or system crash.
76 .TP
77 .B "\-h"
78 shows a command summary
79 .SH SIGNALS
80
81 SIGUSR1 - rotates log files while program is running
82 SIGUSR2 - terminates an IPTraf-ng process running in the background.
83
84 .SH FILES
85 /var/log/iptraf-ng/*.log - log file
86 /var/lib/iptraf-ng/* - important IPTraf-ng data files
87
88 .SH SEE ALSO
89 Documentation/* - complete documentation written by the author
90
91 .SH AUTHOR
92 Gerard Paul Java ([email protected])
93
94 .SH MANUAL AUTHOR
95 Frederic Peters ([email protected]), using iptraf-ng \-h
96 General manual page modifications by Gerard Paul Java ([email protected]),
97 Phil Cameron ([email protected])
98