etherape(1)

1etherape(1)                 General Commands Manual                etherape(1)
2
3
4

NAME

6       etherape - graphical network traffic browser
7

SYNOPSIS

9       etherape [ -d ] [ -f filter ] [ --final-export outfile ] [ --glade-file
10       interfacefile ] [ -i interface ] [ -l maxnodes ] [ -m operating mode  ]
11       [ --max-delay delay ] [ --min-delay delay ] [ -n ] [ -P column file ] [
12       -q ] [ -r inputfile ] [ -s ] [ --signal-export outfile ] [ -Z user ]
13
14

DESCRIPTION

16       EtherApe is a network traffic browser.  It  displays  network  activity
17       graphically.  It  uses GNOME libraries as its user interface, and libp‐
18       cap, a packet capture and filtering library.
19

OPTIONS

21       These options can be supplied to the command:
22
23       -d, --diagram-only
24              don't display any node text identification
25
26       -f, --filter <capture filter>
27              set capture filter
28
29       --final-export <export file name>
30              when replaying, export to named file at end of replay
31
32       --glade-file <filename>
33              loads interface definitions from the specified  GtkBuilder  file
34              instead of the default one.
35
36       -i, --interface <interface name>
37              set interface to listen to
38
39       -l, --node-limit <number>
40              sets the maximum number of node visible
41
42       -m, --mode <link|ip|tcp>
43              set mode of operation (default is ip)
44
45       --max-delay <delay in ms>
46              caps  timestamps  to the provided delay when replaying a capture
47              file.
48
49       --min-delay <delay in ms>
50              provides a minimum to inter-packet delay when replaying  a  cap‐
51              ture file.
52
53       -n, --numeric
54              don't convert addresses to names, disables name resolution.
55
56       -P, --positionfile with list of nodes and columns
57              Activate column positioning with the named file.  Manually posi‐
58              tion nodes in virtual columns using the named file content.  See
59              Column Positioning.
60
61       -q     disables informational messages.
62
63       -r, --replay-file <file name>
64              sets input file to replay
65
66       -s     Place nodes using an alternate algorithm.  Deprecated.
67
68       --signal-export <export file name>
69              if  specified,  enables signal USR1 handling. On receiving USR1,
70              EtherApe will dump its state to the named XML file.
71
72              Beware! the file will be overwritten without asking!
73
74       -Z, --relinquish-privileges <user>
75              run everything but privileged  packet-capture  operations  under
76              the user ID and group ID of the given user.
77
78       -?, --help
79              show a brief help message
80

COLUMN POSITIONING

82       With option -P|--position EtherApe reads a file specifying positions of
83       some nodes. The input file takes the format of:
84         node.mydomain.com        1
85         router1.mydomain.com     2
86         router2.mydomain.com     2
87         172.16.2.[0-9]*          1
88         .*.mydomain.com          1
89         ff02:.*                  2
90         fe80:.*                  1
91
92       The first column is a regex of either the FQDN or the IP address.
93
94       The second column is a number indicating the  "column"  that  the  node
95       will  be positioned in the display with column 1 being on the far left.
96       Up to 1000 columns are permitted.
97
98       Instead of being arranged in a circle the nodes are displayed  in  col‐
99       umns.   This  is  quite  useful for arranging nodes so that you can see
100       nodes on the "inside" of your network on the left and the public inter‐
101       net nodes (anything not specified in the config file) on the right.
102
103       The  input file above will cause 3 columns to display.  Nodes with FQDN
104       containing mydomain.com, those in the 172.16.2.0/24  subnet,  and  link
105       local IPv6 addresses will be in the left column.  2 "routers", and IPv6
106       multicast will be in the center column and everything else will  be  in
107       the right column.
108
109       Column locations are determined by the first match while searching from
110       the top of the input.  Overlapping regex's can be used with the  under‐
111       standing  that the first match will determine the location.  The broad‐
112       est regex's should be near the bottom of the position specification.
113

SIGNALS

115       USR1   on receipt of signal USR1, and if enabled with  --signal-export,
116              EtherApe will dump its state to the chosen xml file.
117
118              Beware! the file will be overwritten without asking!
119

ENVIRONMENT VARIABLES

121       APE_DEBUG=normal|info|debug
122              controls  debug  output verbosity. Debug information are printed
123              on standard output.
124

FILES

126       Etherape will use /etc/ethers if there is one to convert MAC  addresses
127       to  names and /etc/services to associate TCP/UDP port numbers to proto‐
128       col names.
129
130
131

AUTHORS

137       Juan Toledo <toledo@users.sourceforge.net>
138
139       Riccardo Ghetta <bchiara@users.sourceforge.net>
140
141
142
143
144                             EtherApe Manual Page                  etherape(1)