1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
|
<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<article id="index">
<articleinfo>
<title>EtherApe Manual</title>
<copyright>
<year>2001</year>
<year>2002</year>
<year>2003</year>
<year>2004</year>
<year>2005</year>
<year>2006</year>
<holder>Juan
Toledo</holder><holder>Riccardo Ghetta</holder></copyright>
<!--
translators: uncomment this:
<copyright>
<year>2002</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
<revhistory>
<revision>
<revnumber>Etherape Manual V0.2</revnumber>
<date>January 2006</date>
<revdescription>
<para role="author">
Riccardo Ghetta
<email>bchiara@users.sf.net</email>
</para>
</revdescription>
</revision>
<revision>
<revnumber>Etherape Manual V0.1</revnumber>
<date>2001</date>
<revdescription>
<para role="author">
Juan Toledo
<email>toledo@users.sf.net</email>
</para>
</revdescription>
</revision>
</revhistory>
<legalnotice id="legalnotice">
<para>Permission is granted to copy, distribute and/or modify
this document under the terms of the <ulink url="gnome-help:fdl"
type="help"><citetitle>GNU Free Documentation
License</citetitle></ulink>, Version 1.1 or any later version
published by the Free Software Foundation with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy
of the license can be found <ulink url="gnome-help:fdl"
type="help">here</ulink>.</para>
<para>Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and those trademarks are
made aware to the members of the GNOME Documentation Project, the
names have been printed in caps or initial caps.</para>
</legalnotice>
<releaseinfo>This is version 0.2 of EtherApe manual.</releaseinfo>
</articleinfo>
<sect1 id="etherape-introduction">
<title>Introduction</title>
<para><application>EtherApe</application> is a graphical network
monitor for Unix modeled after etherman. Featuring ether, ip and
tcp modes, it displays network activity graphically. Hosts and
links change in size with traffic. Protocols are color coded. It
supports ethernet, fddi, ppp and slip devices. It can filter
traffic to be shown, and can read traffic from a file as well as
live from the network.</para>
<para><application>EtherApe</application> is also a tool for
gathering network statistics, and the data can be presented in a
number of different ways.</para>
<para>To run <application>EtherApe</application>, select
<menuchoice><guisubmenu>Applications</guisubmenu>
<guimenuitem>EtherApe</guimenuitem></menuchoice> from the <guimenu>
Main Menu</guimenu>, or type <command>etherape</command> on the
command line.</para>
</sect1>
<sect1 id="etherape-usage">
<title>Using EtherApe</title>
<para><application>EtherApe</application> can be used to have an
overview of traffic conditions in your network. It is a great tool
to easily pinpoint who is consuming the most bandwith, or to check
which computers are actually talking to some others.</para>
<sect2 id="quickstart">
<title>Quick Start</title>
<para>Most of the time you will want to run <application>
EtherApe</application> with root permissions in order to monitor
a live network. If you are not the administrator of the machine
running <application>EtherApe</application>, you will ony be
able to analyze previously generated capture files, generated by
someone else.</para>
<para>
Starting
<application>EtherApe</application>
opens the
<interface>Main window</interface> (see <link linkend="mainwindow-fig">screenshot</link>).</para>
<para>By default, <application>EtherApe</application> will try to
open the default network interface for capture in IP mode, and
will display a diagram of network traffic right away.</para>
<para>Every computer currently taking part in a conversation in
the network will be represented as a circle (a node) in the
diagram, with its name displayed on top of it. The fact that two
computers are communicating with each other is represented with a
line between those two nodes (a link).</para>
<para>You will notice that both nodes and links vary with time in
color and size. Size is used to represent the amount of traffic:
The bigger a node is, the more traffic it is dumping into the
network. The wider a link is, the more data is flowing in that
particular between those two nodes.</para>
<para>Color, on the other hand, is used to represent the protocol
being used the most by a link or a node. You will find a legend
for what a particular color means in the left side of the
<interface>main window</interface>.</para>
<para>Look closely and you will notice that in fact links are not
lines between nodes. Rather, every direction of communication is
represented by a triangle. Packets go from the shorter side to
the opposite vertex. Since computers usally talk back, there will
usually be two such triangles between two nodes, the base of each
representing how much each node is contributing to the
conversation.</para>
<para>You don't need to know much more if you just want to
have a simple look at your network. Nevertheless, there are many
settings that you can use to configure what exactly will appear
in the diagram, and you will have to understand how this settings
affect the program to have a proper comprehension of the meaning
of the display.</para>
<para>Besides, EtherApe offers you the possibility of displaying
stastistics for many of the elements involved. Read on to learn
how.</para>
<figure id="mainwindow-fig">
<title>EtherApe Main Window</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/appmain.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/appmain.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Etherape Main Window screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect2>
<sect2 id="toolbar">
<title>Toolbar</title>
<para>The
<link linkend="figure-usage-toolbar">toolbar</link>
provides access to several commonly used routines.
<variablelist>
<varlistentry>
<term>Start</term>
<listitem>
<para>Starts capturing on the selected live
interface.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Pause</term>
<listitem>
<para>Pauses capture, freezing both the diagram and any
detail window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Stop</term>
<listitem>
<para>Stops the capture, clearing diagram and all traffic
statistics. Closes also all detail windows .</para>
<warning>
<para>Everytime a capture is stopped, all statistics
gathered up to that time will be deleted from memory.
Think about it when you have left EtherApe running for
several hours.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term>Preferences</term>
<listitem>
<para>
Opens the <link linkend="etherape-prefs">Preferences</link> dialog.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Protocols</term>
<listitem>
<para>
Opens the <link linkend="protodlg">Protocols</link> detail window.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<figure id="figure-usage-toolbar">
<title>EtherApe Toolbar</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/eth_toolbar.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/eth_toolbar.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Etherape toolbar screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect2>
<sect2 id="menubar">
<title>Menus</title>
<para>The menu bar, located at the top of the <interface>Main
Window</interface>, contains the following menus:</para>
<variablelist>
<varlistentry>
<term><guimenu>File</guimenu></term>
<listitem>
<para>
This menu contains:
<itemizedlist>
<listitem>
<para><menuchoice><shortcut>
<keycap>Ctrl-O</keycap></shortcut>
<guimenuitem>Open</guimenuitem></menuchoice> opens an
external capture file. If you want to capture on a
live interface, see the
<link linkend="capture">
<interface>Capture</interface>
</link> menu.</para>
</listitem>
<listitem>
<para>
<menuchoice><guimenuitem>Preferences</guimenuitem></menuchoice>
opens the <link linkend="etherape-prefs">Preferences</link> dialog.</para>
</listitem>
<listitem>
<para>
<menuchoice>
<guimenuitem>Quit</guimenuitem>
</menuchoice>
quits the application.</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term id="capture"><guimenu>Capture</guimenu></term>
<listitem>
<para>
This menu contains:
<itemizedlist>
<listitem>
<para><menuchoice>
<guimenuitem>Mode</guimenuitem></menuchoice> opens a
submenu governing the capture mode.</para>
</listitem>
<listitem>
<para><menuchoice>
<guimenuitem>Interfaces</guimenuitem></menuchoice>
opens a submenu to select the capture
interface.</para>
</listitem>
<listitem>
<para><menuchoice>
<guimenuitem>Start</guimenuitem></menuchoice>
begins capturing on the selected live interface.</para>
</listitem>
<listitem>
<para><menuchoice>
<guimenuitem>Pause</guimenuitem></menuchoice>
temporarily halts the capture, freezing both the diagram and any detail
window.</para>
</listitem>
<listitem>
<para>
<menuchoice><guimenuitem>
Stop</guimenuitem></menuchoice>
terminates the capture, clearing diagram and traffic
statistics. Closes also all detail windows .
<warning>
<para>Everytime a capture is stopped, all
statistics gathered up to that time will be
deleted from memory. Think about it when you have
left EtherApe running for several hours.</para>
</warning>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>View</guimenu></term>
<listitem>
<para>
This menu contains:
<itemizedlist>
<listitem>
<para><guimenuitem>Protocols</guimenuitem> opens
the <link linkend="protodlg"><interface>Protocols
dialog</interface></link>, which allows you see
global traffic statistics per protocol.</para>
</listitem>
<listitem>
<para><guimenuitem>Toolbar</guimenuitem>
toggles the toolbar.</para>
<para><guimenuitem>Legend</guimenuitem>
toggles the protocol legend.</para>
<para><guimenuitem>Statusbar</guimenuitem>
toggles the Status bar.</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Help</guimenu></term>
<listitem>
<para>
This menu contains:
<itemizedlist>
<listitem>
<para><guimenuitem>About</guimenuitem> This opens the
<interface>About</interface> dialog which shows basic
information about <application>
EtherApe</application>, such as the author's
name.</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 id="nodedlg">
<title>Node detail dialog</title>
<para>Double-clicking on a node opens a detail dialog wich shows realtime traffic statistics
for the chosen node.</para>
<para>Averaged realtime traffic is shown in the "Istantaneous"
row, while the "Accumulated" one displays long term
statistics.</para>
<para>A protocol table depicting data on all protocol
traversing the chosen node is also displayed. See the <link
linkend="protodlg">Protocol</link> detail dialog entry for
additional information.</para>
<note><para>Only active protocols matching the "Protocol Stack Level" preference settings will be displayed.</para></note>
<figure id="figure-node-dlg">
<title>Node detail dialog</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/node_info.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/node_info.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Node detail dialog screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect1>
<sect1 id="linkdlg">
<title>Link detail dialog</title>
<para>Double-clicking on a link opens a detail dialog wich shows realtime traffic statistics
for the chosen link.</para>
<para>Averaged realtime traffic is shown in the "Istantaneous"
row, while the "Accumulated" one displays long term
statistics.</para>
<para>A protocol table depicting data on all protocol
traversing the chosen link is also displayed. See the <link
linkend="protodlg">Protocol</link> detail dialog entry for
additional information.</para>
<note><para>Only active protocols matching the "Protocol Stack Level" preference settings will be displayed.</para></note>
<figure id="figure-link-dlg">
<title>Link detail dialog</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/link_info.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/link_info.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Link detail dialog screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect1>
<sect1 id="protodlg">
<title id="proto-ref">Protocol detail dialog</title>
<para>The protocol detail dialog shows global traffic statistics
for active (i.e. not expired) protocolos. Expiration is
controlled by the Global Protocol Timeouts preference
section.</para>
<para>Double clicking on a column name orders entries by that
column data or reverses the sorting order. A small arrow after
the chosen column name shows the
sorting order (in the screenshot, entries are ordered by
name).</para>
<para>A column can also be dragged, changing its position in the
table. To disable a column deselect it in the <guilabel>Columns</guilabel> menu.</para>
<note><para>Only those protocols matching the "Protocol Stack Level" preference settings will be displayed.</para></note>
<figure id="figure-proto-dlg">
<title>Protocol detail dialog</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/proto_info.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/proto_info.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Protocol detail dialog screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect1>
<sect1 id="etherape-prefs">
<title id="pref-ref">Settings</title>
<para>To change the application settings, select
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Preferences...</guimenuitem>
</menuchoice>.
The <guilabel>Preferences</guilabel> dialog contains the following
tabbed sections:
</para>
<itemizedlist>
<listitem>
<para>
<link linkend="etherape-prefs-diagram">Diagram</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="etherape-prefs-colors">Colors</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="etherape-prefs-timings">Timings</link>
</para>
</listitem>
</itemizedlist>
<para>After you have made all the changes you want, click on
<guibutton>OK</guibutton> to apply the changes and close the
<interface>Properties</interface> dialog.
The <guibutton>Save</guibutton> saves current settings (to ~/.gnome2/EtherApe).
<!-- To cancel the changes and
return to previous values, click the <guibutton>Close</guibutton>
button.
-->
</para>
<sect2 id="etherape-prefs-diagram">
<title>Diagram</title>
<para>The diagram tab contains many settings related to the traffic display.</para>
<variablelist>
<varlistentry>
<term>
<guilabel>Protocol Stack Level</guilabel> </term>
<listitem>
<para>Use this drop-down list box to specify the
level of the OSI stack to use when displaying protocols.
Select one of the following options:</para>
<itemizedlist>
<listitem>
<para>
<guilabel>Topmost recognized protocol</guilabel> </para>
<para>For every packet, chooses the highest
level protocol detected.</para>
</listitem>
<listitem>
<para>
<guilabel>Level 2 (Eg: ETHII)</guilabel> </para>
<para>Shows only OSI level 2 informations. For example
ETHII or FDDI</para>
</listitem>
<listitem>
<para>
<guilabel>Level 3 (Eg: IP)</guilabel> </para>
<para>Shows only OSI level 3 protocols, like IP or IPX</para>
</listitem>
<listitem>
<para>
<guilabel>Level 4 (Eg: TCP)</guilabel> </para>
<para>Shows only OSI level 4 protocols, tipically
TCP, UDP and ICMP</para>
</listitem>
<listitem>
<para>
<guilabel>Level 5 (Eg: HTTP)</guilabel> </para>
<para>Shows application level protocols, like HTTP,
POP3, etc</para>
</listitem>
</itemizedlist>
<para>Default:
<guilabel>Topmost recognized protocol</guilabel>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Node Size Variable</guilabel> </term>
<listitem>
<para>Use this drop-down list box to specify wich variable
governs node and link sizes. Select one of the following options:</para>
<itemizedlist>
<listitem>
<para>
<guilabel>Instant. traffic (In+Out)</guilabel> </para>
<para>Size depends on the instantaneous traffic on node.</para>
</listitem>
<listitem>
<para>
<guilabel>Instant. traffic (Inbound)</guilabel> </para>
<para>Size depends only on instantenous inbound traffic.</para>
</listitem>
<listitem>
<para>
<guilabel>Instant. traffic (Outbound)</guilabel> </para>
<para>Size depends only on instantaneous outbound traffic.</para>
</listitem>
<listitem>
<para>
<guilabel>Accum. traffic (In+Out)</guilabel> </para>
<para>Size depends on the total traffic accumulated on node.</para>
</listitem>
<listitem>
<para>
<guilabel>Accum. traffic (Inbound)</guilabel> </para>
<para>Size depends only on accumulated inbound traffic.</para>
</listitem>
<listitem>
<para>
<guilabel>Accum. traffic (Outbound)</guilabel> </para>
<para>Size depends only on accumulated outbound traffic.</para>
</listitem>
</itemizedlist>
<para>Default:
<guilabel>Instant. traffic (Outbound)</guilabel>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Size Mode</guilabel> </term>
<listitem>
<para>Use this drop-down list box to specify how to weight
the value of the <guilabel>Node Size Variable</guilabel>.
Select one of the following options:</para>
<itemizedlist>
<listitem>
<para>
<guilabel>Linear</guilabel></para>
<para>Uses directly the input value.</para>
</listitem>
<listitem>
<para>
<guilabel>Logarithmic</guilabel></para>
<para>Uses the decimal logarithm of input variable.</para>
</listitem>
<listitem>
<para>
<guilabel>Quadratic</guilabel></para>
<para>Uses the square root of input variable.</para>
</listitem>
</itemizedlist>
<para>Default:
<guilabel>Linear</guilabel>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Node Radius Multiplier</guilabel> </term>
<listitem>
<para>This slider specifies the scaling multiplier to apply to node sizes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Link Radius Multiplier</guilabel> </term>
<listitem>
<para>This slider specifies the scaling multiplier to apply to link sizes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Capture filter</guilabel> </term>
<listitem>
<para>This drop-down combo box specifies the capture
filter to use using the standard pcap syntax.
</para>
<para>Default: ip</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Font</guilabel> </term>
<listitem>
<para>Opens the font selection dialog to select the main
application font.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Hide node names</guilabel> </term>
<listitem>
<para>If checked, doesn't show the node names.
</para>
<para>Default: unchecked.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Group unknown ports</guilabel> </term>
<listitem>
<para>If checked, all traffic belonging to ports not
specified in the services file is accumulated under
"UDP-unknown" and "TCP-unknown".
</para>
<para>Default: checked.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Name resolution</guilabel> </term>
<listitem>
<para>If checked, enables name resolution. If unchecked,
show only numeric addresses (like the -b command line option).
</para>
<para>Default: unchecked.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Node Anti Aliasing</guilabel> </term>
<listitem>
<para>Enables node antialiasing. On slower computers, it
could be unchecked to save a few CPU cycles.
</para>
<para>Default: checked.</para>
</listitem>
</varlistentry>
</variablelist>
<figure id="figure-pref-diagram">
<title>Diagram preferences tab</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/pref_diagram_dlg.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/pref_diagram_dlg.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Diagram preferences tab screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect2>
<sect2 id="etherape-prefs-colors">
<title>Colors</title>
<para>The colors tab assigns colors to protocols.</para>
<variablelist>
<varlistentry>
<term>
<guilabel>Color-Protocol matching table</guilabel> </term>
<listitem>
<para>This list box lists available colors and optionally maps a specified color to a protocol.</para>
<para>The <guilabel>Color</guilabel> column shows the color and its RGB hexadecimal id (#rrggbb)</para>
<para>A color could appear in more rows, to allow protocol grouping by color (e.g. show FTP and FTP-PASSIVE as cyan).</para>
<warning><para>EtherApe will use only the colors specified in this list. If the list is empty, all diagrams will be gray.</para></warning>
<para>The mapping of colors to protocols works as follows:</para>
<itemizedlist>
<listitem>
<para>A protocol wich name appears in a <guilabel>Protocol</guilabel> column, will be drawn in the corresponding row color. As an example, in the dialog <link linkend="figure-pref-colors">screenshot</link>, all DOMAIN traffic is drawn in blue.</para>
</listitem>
<listitem>
<para>A protocol not appearing in the list will have a color assigned casually from the list. If the <guilabel>Cycle assigned colors</guilabel> checkbox is selected, all listed colors will be considered. Otherwise, only those without an assigned protocol will be used.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Add color</guilabel> </term>
<listitem>
<para>Adds a new row to the list. A dialog will open to select the actual color value.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Remove color</guilabel> </term>
<listitem>
<para>Removes the selected row from the list.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Edit protocols</guilabel> </term>
<listitem>
<para>Opens a <link linkend="protocol-edit-dlg">dialog</link> where the current row protocol can be edited</para>
<figure id="protocol-edit-dlg">
<title>Protocol edit dialog</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/protocol_edit_dlg.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/protocol_edit_dlg.eps" format="EPS"/>
</imageobject>
</mediaobject>
</screenshot>
</figure>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Fade colors</guilabel> </term>
<listitem>
<para>When checked, colors fade to black when there is no traffic.
</para>
<para>Default: checked</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Cycle assigned colors</guilabel> </term>
<listitem>
<para>If checked, unmapped protocol can use all colors.
</para>
<para>Default: unchecked</para>
</listitem>
</varlistentry>
</variablelist>
<figure id="figure-pref-colors">
<title>Colors preferences tab</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/pref_colors_dlg.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/pref_colors_dlg.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Colors preferences tab screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect2>
<sect2 id="etherape-prefs-timings">
<title>Timings</title>
<para>The timings tab contains all time-related settings of EtherApe.</para>
<variablelist>
<varlistentry>
<term>
<guilabel>Diagram Refresh Period (ms)</guilabel> </term>
<listitem>
<para>Minimum time (in milliseconds) to wait before refreshing the diagram. Smaller values increase the frequency of updates, making the graph smoother, but with increased CPU usage.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Averaging Time (ms)</guilabel> </term>
<listitem>
<para>Traffic average period in milliseconds. Smaller values follow more closely the instantaneous traffic, while higher settings smooth the diagram. Averages need packet data, so an higher averaging time means also higher memory consumption.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Node Timeouts (ms)</guilabel> </term>
<listitem>
<para>This section aggregates all node timeout settings.</para>
<variablelist>
<varlistentry>
<term><guilabel>Diagram</guilabel></term>
<listitem>
<para>After this time without traffic, the node is removed from diagram. Node data are still held in memory until the <guilabel>Traffic</guilabel> timeout expires, so if new traffic comes accumulated statistics are still valid. Zero disables the timer (i.e. a node never expires).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Traffic</guilabel></term>
<listitem>
<para>After this time without traffic, the node is removed from memory, clearing all statistics. A zero value disables the timeout.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Protocol Info</guilabel></term>
<listitem>
<para>After this time without traffic on a protocol, its statistics are removed from the node. A zero value disables the timeout.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Link Timeouts (ms)</guilabel> </term>
<listitem>
<para>This section aggregates all link timeout settings.</para>
<variablelist>
<varlistentry>
<term><guilabel>Diagram</guilabel></term>
<listitem>
<para>After this time without traffic, the link is removed from diagram. Link data are still held in memory until the <guilabel>Traffic</guilabel> timeout expires, so if new traffic comes accumulated statistics are still valid. Zero disables the timer (i.e. a link never expires).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Traffic</guilabel></term>
<listitem>
<para>After this time without traffic, the link is removed from memory, clearing all statistics. A zero value disables the timeout.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Protocol Info</guilabel></term>
<listitem>
<para>After this time without traffic on a protocol, its statistics are removed from the link. A zero value disables the timeout.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Global Protocol Timeouts (ms)</guilabel> </term>
<listitem>
<para>This section aggregates all timeout settings related to the global protocol statistics.</para>
<variablelist>
<varlistentry>
<term><guilabel>Traffic</guilabel></term>
<listitem>
<para>After this time without traffic, the protocol is removed from memory, clearing all statistics. A zero value disables the timeout.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<figure id="figure-pref-timings">
<title>Timings preferences tab</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/pref_timings_dlg.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="figures/pref_timings_dlg.eps" format="EPS"/>
</imageobject>
<textobject><phrase>Timings preferences tab screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</figure>
</sect2>
</sect1>
<sect1 id="bugs">
<title>Known Bugs and Limitations</title>
<para>As default, only IP traffic is shown. To see other protocols
use ethernet mode (-m ethernet)</para>
<para>Some libpcap versions have a bug for which a filter
"ip" doesn't capture icmp traffic.</para>
<para>Most NFS traffic will show up as UDP_FRAGMENT or just
RPC</para>
</sect1>
<sect1 id="authors">
<title>Authors</title>
<para><application>EtherApe</application> was written by Juan
Toledo ( <email>toledo@users.sourceforge.net</email>). Later
releases by Riccardo Ghetta
(<email>bchiara@users.sourceforge.net</email>).</para>
<para>To find more
information about <application>EtherApe</application>, please visit
the <ulink url="http://etherape.sourceforge.net" type="http">
EtherApe Web page</ulink>. Instructions for submitting bug reports
can be found <ulink
url="http://etherape.sourceforge.net/bug-reporting.html"
type="http">
on-line</ulink>.</para>
</sect1>
<sect1 id="license">
<title>License</title>
<para>This program is free software; you can redistribute it and/or
modify it under the terms of the <ulink url="gnome-help:gpl"
type="help">"> <citetitle>GNU General Public
License</citetitle></ulink> as published by the Free Software
Foundation; either version 2 of the License, or (at your option)
any later version.</para>
<para>This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<citetitle>GNU General Public License</citetitle> for more
details.</para>
<para>
A copy of the
<citetitle>GNU General Public License</citetitle>
is included as an appendix to the
<citetitle>GNOME Users Guide</citetitle>
. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle>
from the Free Software Foundation by visiting
<ulink url="http://www.fsf.org" type="http">their Web site</ulink>
or by writing to
<address>Free Software Foundation, Inc. <street>59 Temple
Place</street> - Suite 330 <city>Boston</city>, <state>MA</state>
<postcode>02111-1307</postcode> <country>USA</country></address>
</para>
</sect1>
</article>
|
