/usr/share/gnome/help/etherape/C/etherape.xml is in etherape 0.9.13-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY appname "EtherApe">
<!ENTITY app "<application>EtherApe</application>">
<!ENTITY appversion "0.9.11">
<!ENTITY manrevision "0.5">
<!ENTITY date "January 2010">
]>
<!--
(Do not remove this comment block.)
Maintained by the GNOME Documentation Project
http://live.gnome.org/DocumentationProject
Template version: 3.0 beta
Template last modified 2006-11-21
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<articleinfo>
<title>&app; Manual</title>
<abstract role="description">
<para>&app; is a graphical network monitor
for Unix modeled after etherman. Featuring link level, 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, slip,
wlan devices plus several encapsulated packet types. It can filter traffic
to be shown, and can read traffic from a file as well as live from the
network.</para>
</abstract>
<copyright>
<year>2001</year>
<year>2002</year>
<year>2003</year>
<year>2004</year>
<year>2005</year>
<year>2006</year>
<year>2007</year>
<year>2008</year>
<year>2009</year>
<year>2010</year>
<year>2011</year>
<year>2012</year>
<holder>Juan Toledo</holder>
<holder>Riccardo Ghetta</holder>
</copyright>
<authorgroup>
<author>
<firstname>Juan</firstname>
<surname>Toledo</surname>
</author>
<author role="maintainer">
<firstname>Riccardo</firstname>
<surname>Ghetta</surname>
</author>
</authorgroup>
<revhistory>
<revision>
<revnumber>&appname; Manual V0.1</revnumber>
<date>2001</date>
<revdescription>
<para role="author">Juan Toledo
<email>toledo@users.sf.net</email></para>
</revdescription>
</revision>
<revision>
<revnumber>&appname; 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>&appname; Manual V0.3</revnumber>
<date>January 2010</date>
<revdescription>
<para role="author">Riccardo Ghetta
<email>bchiara@users.sf.net</email></para>
</revdescription>
</revision>
<revision>
<revnumber>&appname; Manual V0.4</revnumber>
<date>February 2011</date>
<revdescription>
<para role="author">Riccardo Ghetta
<email>bchiara@users.sf.net</email></para>
</revdescription>
</revision>
<revision>
<revnumber>&appname; Manual V0.5</revnumber>
<date>February 2011</date>
<revdescription>
<para role="author">Riccardo Ghetta
<email>bchiara@users.sf.net</email></para>
</revdescription>
</revision>
<revision>
<revnumber>&appname; Manual V0.6</revnumber>
<date>April 2012</date>
<revdescription>
<para role="author">Riccardo Ghetta
<email>bchiara@users.sf.net</email></para>
</revdescription>
</revision>
</revhistory>
<releaseinfo>This manual describes &appname; release &appversion;.</releaseinfo>
</articleinfo>
<sect1 id="etherape-introduction">
<title>Introduction</title>
<para><application>&appname;</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, slip,
wlan devices plus several encapsulated packet types. It can filter traffic
to be shown, and can read traffic from a file as well as live from the
network.</para>
<para><application>&appname;</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>&appname;</application>, select <menuchoice>
<guisubmenu>Applications</guisubmenu>
<guimenuitem>&appname;</guimenuitem>
</menuchoice> from the <guimenu> Main Menu</guimenu>, or type
<command>etherape</command> on the command line.</para>
<para>&app; supports several command line options to simplify monitoring.
Please refer to the &appname; unix manual page, <ulink url="man:etherape" type="man">
&app;(1)</ulink>.</para>
</sect1>
<sect1 id="etherape-usage">
<title>Using &appname;</title>
<para>&app; 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>
<warning>
<para>To monitor a live network you need to run &app; with root permissions.
If you are not the administrator of the machine you will ony be able to analyze
previously generated capture files.</para>
<para>As with any application, running &app; as root can be a security risk if
some malicious traffic can trigger an unwanted behaviour.</para>
<para>While at this time no such bugs are known, exercise a little care.</para>
</warning>
<para>Starting &app; opens the
<interface>Main window</interface> (see <link
linkend="mainwindow-fig">screenshot</link>).</para>
<para>By default, &app; 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 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> or in the <link linkend="protodlg">All Protocols dialog</link>.</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, &appname; offers you the possibility of displaying
stastistics for many of the elements involved. Read on to learn
how.</para>
<figure id="mainwindow-fig">
<title>&appname; 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>&appname; Main Window screenshot</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
</sect2>
<sect2 id="modes">
<title>Modes</title>
<para>Modes control how &app; captures, decodes and
displays network packets.
Node identification also depend on the current mode, thus changing mode requires restarting
the capture.</para>
<para>
<variablelist>
<varlistentry>
<term>Link Layer</term>
<listitem>
<para>Link Layer mode focuses on traffic at link layer (e.g. Ethernet) level.
Nodes are identified by their link layer address, highlighting local paths.</para>
<para>In this mode traffic coming from an external network across a router is shown as originating at the router.
Conversely, packets headed outside are shown as consumed by the router.</para>
<para>To convert MAC addresses to machine names, &app; reads uses the /etc/ethers file.</para>
<para>Default filter: none</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IP</term>
<listitem>
<para>The default mode, focusing on traffic at IP level or above.
Nodes are identified by their IP address, if available.</para>
<para>Unless directly addressed, routers are ignored, showing the final packet destination.</para>
<para>The default filter expression is 'ip or ip6', discarding all non IP packets.
Remove the filter to see non-IP traffic (e.g. ARP queries)</para>
<warning>
<para>Due to pcap limitations, when filtering while
capturing VLAN-tagged packets, your filter must start with
'vlan' (e.g. 'vlan and (ip or ip6)' ) and all traffic
must be tagged, otherwise the filter will not work.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term>TCP</term>
<listitem>
<para>In this mode a node represents an (host, port) pair, with node labels shown as
"name:port".</para>
<para>Since the display becomes quickly crowded, this mode is best suited for analyzing a small number of hosts, perhaps by restricting the capture scope with a filter.</para>
<para>The default filter expression for TCP mode is 'tcp', capturing only
TCP packets. Removing the filter usually doesn't make much sense, but you
can change it to 'tcp or udp' to see both TCP and UDP traffic.
</para>
<warning>
<para>Due to pcap limitations, when filtering while
capturing VLAN-tagged packets, your filter must start
with 'vlan' (e.g. 'vlan and tcp') and all traffic must
be tagged, otherwise the filter will not work.</para>
</warning>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
</sect1>
<sect1 id="toolbar">
<title>Toolbar</title>
<para>The <link linkend="figure-usage-toolbar">toolbar</link> provides
access to several commonly used routines. <variablelist>
<varlistentry>
<term><guimenu>Start</guimenu></term>
<listitem>
<para>Starts capturing on the selected live interface.</para>
</listitem>
</varlistentry>
<varlistentry id="toolbar-next">
<term><guimenu>Next</guimenu></term>
<listitem>
<para>Active only when replaying a capture file, when pressed
fast forwards to the next packet, skipping any delay. Useful
for dealing with long pauses in captured data.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Pause</guimenu></term>
<listitem>
<para>Pauses capture, freezing both the diagram and any detail
window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Stop</guimenu></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 &appname; running for several hours.</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Pref.</guimenu></term>
<listitem>
<para>Opens the <link
linkend="etherape-prefs">Preferences</link> dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Prot.</guimenu></term>
<listitem>
<para>Opens the <link linkend="protodlg">Protocols</link> detail
window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Nodes</guimenu></term>
<listitem>
<para>Opens the <link linkend="allnodesdlg">All Nodes</link> detail
window.</para>
</listitem>
</varlistentry>
</variablelist></para>
<figure id="figure-usage-toolbar">
<title>&appname; 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>&appname; toolbar screenshot</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
</sect1>
<sect1 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>
<note>
<para>Capture files often contain lengthy sections without traffic. Here the command-line option
--max-delay or the <link linkend="toolbar-next">Next button</link> may be useful to avoid staring for hours to an empty display.
Conversely, --min-delay can help analyze many short lived connections.</para>
</note>
</listitem>
<listitem>
<para><menuchoice>
<guimenuitem>Export</guimenuitem>
</menuchoice> creates an xml with a snapshot of current nodes and their statistics. A sample output file can be found in <xref linkend="appendix-a"/>.</para>
<note>
<para>&app; can automatically export to user-chosen files
with two command line options, <option>--final-export</option> and <option>--signal-export</option>. The first writes to file at end of a replay, the second dumps when receiving signal USR1.</para>
</note>
</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 operating <link linkend="modes">mode</link>.
</para>
<itemizedlist>
<listitem>
<para>
<menuchoice>
<shortcut>
<keycap>Alt-L</keycap>
</shortcut>
<guimenuitem>Link Layer</guimenuitem>
</menuchoice>
Selects Link Layer mode.
</para>
</listitem>
<listitem>
<para>
<menuchoice>
<shortcut>
<keycap>Alt-I</keycap>
</shortcut>
<guimenuitem>IP</guimenuitem>
</menuchoice>
Selects IP mode.
</para>
</listitem>
<listitem>
<para>
<menuchoice>
<shortcut>
<keycap>Alt-T</keycap>
</shortcut>
<guimenuitem>TCP</guimenuitem>
</menuchoice>
Selects TCP mode.
</para>
</listitem>
</itemizedlist>
</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>Next</guimenuitem>
</menuchoice> when pressed fast forwards to the next packet, skipping any delay. Useful for dealing with long pauses in captured data. Active only during replay.</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 &appname; 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>Nodes</guimenuitem> opens the <link
linkend="allnodesdlg"><interface>All Nodes
dialog</interface></link>, which allows you see all known nodes with
summary statistics.</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> Opens the
<interface>About</interface> dialog which shows basic
information about &app;, such
as release number, or the author's names.</para>
</listitem>
</itemizedlist></para>
</listitem>
</varlistentry>
</variablelist>
</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. The third row shows average packet size.</para>
<para>A protocol table depicting data on all protocol traversing the
chosen node is also displayed. See the <link
linkend="protodlg">All Protocols dialog</link> 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. The third row shows
average packet sizes.</para>
<para>A protocol table depicting data on all protocol traversing the
chosen link is also displayed. See the <link
linkend="protodlg">All Protocols dialog</link> 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">All Protocols dialog</title>
<para>The Protocols dialog shows global traffic statistics for
active (i.e. not expired) protocols. 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, or
disabled by deselecting it in the <guilabel>Columns</guilabel>
menu.</para>
<para>
Available statistics are:
<itemizedlist>
<listitem><para>Protocol color</para></listitem>
<listitem><para>Protocol name. For TCP/UDP traffic, the services file is searched for a matching entry.</para></listitem>
<listitem><para>Protocol port (TCP/UDP traffic only).
<note><para>&app; assigns the same port to all nodes in a packet using the following heuristic:
<orderedlist>
<listitem><para>if only one port of the two matches is mapped to a
color, that entry is used. This way you can override automatic port assignement.</para></listitem>
<listitem><para>if both ports of packet are mapped, the minor one is choosen.</para></listitem>
<listitem><para>if only one port of the two matches an entry of the services file, that entry is used.</para></listitem>
<listitem><para>if both ports of packet match, the minor one is choosen.</para></listitem>
<listitem><para>if no ports match a services file entry, the minor one is chosen. The packet is labelled "unknown traffic" and processed as such (see "Group unknown ports" in <xref linkend="group-unknown"/>). </para></listitem>
</orderedlist>
</para></note>
</para></listitem>
<listitem><para>Inst Traffic shows the (moving average of) active traffic.</para></listitem>
<listitem><para>Accum Traffic shows the accumulated traffic.</para></listitem>
<listitem><para>Avg Size is the average packet size computed on the total traffic seen.</para></listitem>
<listitem><para>Last Heard reports when the last packet was seen.</para></listitem>
<listitem><para>Packets is the total number of packets.</para></listitem>
</itemizedlist>
</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>All Protocols dialog screenshot</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
</sect1>
<sect1 id="allnodesdlg">
<title id="allnodes-ref">All Nodes dialog</title>
<para>The Nodes dialog shows global traffic statistics for all
known (i.e. not expired) nodes. Expiration is controlled by the
Node 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.</para>
<note>
<para>This dialog lists all known nodes, even those not shown on the diagram because their Diagram timeout is expired. A node is fully expired and &app; forgets it only when all three timeouts (Diagram, Traffic Statistics, Protocol Statistics) are expired.</para>
</note>
<figure id="figure-allnodes-dlg">
<title>All Nodes dialog</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/all_nodes.png" format="PNG" />
</imageobject>
<imageobject>
<imagedata fileref="figures/all_nodes.eps" format="EPS" />
</imageobject>
<textobject>
<phrase>All Nodes dialog screenshot</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
</sect1>
<sect1 id="etherape-prefs">
<title id="pref-ref">Preferences</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>Any change you make will be applied immediately. When satisfied, click on
<guibutton>OK</guibutton> to close the
<interface>Properties</interface> dialog. The <guibutton>Save</guibutton>
saves current settings (to ~/.gnome2/&appname;).
</para>
<para>To abort the changes and return to previous values, click the
<guibutton>Cancel</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>
<warning>
<para>Protocol level attribution can be confused by
encapsulation. For instance, when an Ethernet packet
containing IP traffic is encapsulated by an LLC-SNAP
header, IP data might be incorrectly flagged as ISO level 4 or 5.</para>
<para>The most safe settings is Topmost
recognized protocol.</para>
</warning>
</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>
<note>
<para>In this context, "istantaneous" means traffic averaged over the "Averaging Time Period".</para>
</note>
</listitem>
<listitem>
<para><guilabel>Instant. traffic (Inbound)</guilabel></para>
<para>Size depends on instantenous inbound
traffic.</para>
</listitem>
<listitem>
<para><guilabel>Instant. traffic (Outbound)</guilabel></para>
<para>Size depends 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 on accumulated inbound traffic.</para>
</listitem>
<listitem>
<para><guilabel>Accum. traffic (Outbound)</guilabel></para>
<para>Size depends 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>Square Root</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 Width - Node Radius Ratio</guilabel></term>
<listitem>
<para>This slider specifies the ratio between node and link sizes.</para>
<para>Default: <guilabel>1</guilabel>.</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: <guilabel>ip</guilabel></para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Node Label Font</guilabel></term>
<listitem>
<para>Selects the font used for node labels.</para>
<para>Default: <guilabel>Sans 8 Pts.</guilabel>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Node Label Color</guilabel></term>
<listitem>
<para>Selects the color used for node labels.</para>
<para>Default: <guilabel>yellow</guilabel>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Hide node names</guilabel></term>
<listitem>
<para>If checked, doesn't show the node names.</para>
<para>Default: <guilabel>unchecked</guilabel>.</para>
</listitem>
</varlistentry>
<varlistentry id="group-unknown">
<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". In unchecked, those ports are shown as "UDP-nnnn" or "TCP-nnnn", where nnnn is the port number.
<note><para>&app; assigns the same port to all nodes in a packet using the following heuristic:
<orderedlist>
<listitem><para>if only one port of the two matches an entry of the services file, that entry is used.</para></listitem>
<listitem><para>if both ports of packet match, the minor one is choosen.</para></listitem>
<listitem><para>if no ports match an entry, the minor one is chosen. The packet is labelled "unknown traffic" and processed as such.</para></listitem>
</orderedlist>
</para></note>
</para>
<para>Default: <guilabel>checked</guilabel>.</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: <guilabel>checked</guilabel>.</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 one or more protocols.</para>
<para>The <guilabel>Color</guilabel> column shows the color</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>&appname; 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 items without an
assigned protocol. If all entries have an assigned protocol
unmapped traffic will be shown as gray.</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>Change color</guilabel></term>
<listitem>
<para>A dialog will open to choose a new color for the selected row.</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 protocols can be edited. A row can contain multiple protocols, separated by a comma.</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>
</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
&appname;.</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>Some old libpcap versions have a bug for which a filter "ip" doesn't
capture icmp traffic.</para>
<para>Due to pcap limitations, VLAN-tagged packets are visible
only if the filter expression starts with 'vlan' and in this case
only VLAN-tagged traffic will be shown.</para>
<para>OSI level attribution can be confused by
encapsulation. For instance, when an Ethernet packet containing IP
traffic is encapsulated by an LLC-SNAP header, IP data might be
incorrectly flagged as ISO level 4 or 5.</para>
<para>Most NFS traffic will show up as UDP_FRAGMENT or just RPC</para>
<para>Older distributions, (e.g. CentOS 5, or RHEL 5) do not support PPI
encapsulation.</para>
</sect1>
<sect1 id="appendix-a">
<title>XML export file format</title>
<para>This section presents &app; XML export file format followed by a detailed analysis.</para>
<warning><para>At this time &app; exports only node informations. Future releases might export also link data.</para></warning>
<para>This example shows a file containing only a single, simple, node. A real file will contain many nodes, possibly with more involved <protocol> subtags. The general structure remains the same, however.</para>
<programlisting linenumbering="numbered">
<?xml version="1.0"?>
<!-- traffic data in bytes. last_heard in seconds from dump time -->
<etherape>
<header>
<capture_device>eth0</capture_device>
<timestamp>2011-02-26 10:33:27 +0100</timestamp>
</header>
<nodes>
<node>
<name>
<id>
<IP>10.0.0.98</IP>
</id>
<resolved_name>floss.rulez.example.net</resolved_name>
<numeric_name>10.0.0.98</numeric_name>
</name>
<traffic_stats>
<active_packets>12</active_packets>
<in>
<stats>
<avg>1080</avg>
<total>1027</total>
<avg_size>102</avg_size>
<packets>10</packets>
<last_heard>0.357600</last_heard>
</stats>
</in>
<out>
<stats>
<avg>34416</avg>
<total>14456</total>
<avg_size>1205</avg_size>
<packets>12</packets>
<last_heard>0.000000</last_heard>
</stats>
</out>
<tot>
<stats>
<avg>35496</avg>
<total>15483</total>
<avg_size>704</avg_size>
<packets>22</packets>
<last_heard>0.000000</last_heard>
</stats>
</tot>
<protocols>
<protocol>
<level>1</level>
<key>ETH_II</key>
<stats>
<avg>55948</avg>
<total>14049</total>
<avg_size>669</avg_size>
<packets>21</packets>
<last_heard>0.174299</last_heard>
</stats>
<name>
<id>
<link>fe:ff:20:00:01:00</link>
</id>
<numeric_name>fe:ff:20:00:01:00</numeric_name>
<accumulated>14049</accumulated>
</name>
</protocol>
<protocol>
<level>2</level>
<key>IP</key>
<stats>
<avg>55948</avg>
<total>14049</total>
<avg_size>669</avg_size>
<packets>21</packets>
<last_heard>0.174299</last_heard>
</stats>
<name>
<id>
<IP>10.0.0.98</IP>
</id>
<resolved_name>floss.rulez.example.net</resolved_name>
<numeric_name>10.0.0.98</numeric_name>
<accumulated>14049</accumulated>
</name>
</protocol>
<protocol>
<level>3</level>
<key>TCP</key>
<stats>
<avg>55948</avg>
<total>14049</total>
<avg_size>669</avg_size>
<packets>21</packets>
<last_heard>0.174299</last_heard>
</stats>
</protocol>
<protocol>
<level>4</level>
<key>WWW</key>
<stats>
<avg>55948</avg>
<total>14049</total>
<avg_size>669</avg_size>
<packets>21</packets>
<last_heard>0.174299</last_heard>
</stats>
</protocol>
</protocols>
</traffic_stats>
</node>
</nodes>
</etherape>
</programlisting>
<para>The export file begins with an header (lines 5-9) containing the file
replayed (tag <capture_file>, not shown) or the capture device (tag
<capture_device>, line 5), followed by the export timestamp.
</para>
<para>Node information are, perhaps unsurprisingly, enclosed by <node> tags (lines 9-115). A node is composed by an identifying header, <name> (lines 10-16) followed by traffic statistics, enclosed by <traffic_stats> (lines 17-107).
</para>
<para>Lines 10-16 contain the primary node identifier, i.e. the name/address displayed by &app;. In this example is the IPv4 address 10.0.0.4, along its resolved name.</para>
<para>While only one <name> can be displayed, a node usually has multiple identities: an Ethernet MAC address, an IP one, perhaps a NETBIOS name. Every identity has a matching <name> element; see lines 57-63 and 74-82.</para>
<para>A <name> is identified by its <id> i.e. its address, which
can be of type IP (an IPv4 dotted decimal address), IPv6 or 'link', a
link-level, colon separated, list of octets (e.g. the Ethernet MAC address). You see an example of the latter in lines 58-60.</para>
<para><numeric_name> and <resolved_name> are the high level equivalent of <id>; <accumulated> is the total bytes of traffic related with the name. &app; uses this statistic to choose between multiple names.
</para>
<para>Traffic statistics (lines 17-107) give a summary of node traffic: first,
the number of active packets (line 18), i.e. the packets received during the 'Node traffic statistics' interval (see <xref linkend="etherape-prefs-timings"/>).
<in> record incoming traffic, <out> outgoing and <tot> the total bytes seen. The <protocols> element reports traffic broken down by protocol.</para>
<para><stats> elements are:
<itemizedlist>
<listitem><para><avg> is the moving average of active packets (see "Averaging Time", <xref linkend="etherape-prefs-timings"/>), in bytes. Shown as 'Instantaneous' traffic in <xref linkend="nodedlg"/> </para></listitem>
<listitem><para><total> is the accumulated traffic seen.</para></listitem>
<listitem><para><avg_size> is the average packet size.</para></listitem>
<listitem><para><packets> is the number of packets received.</para></listitem>
<listitem><para><last_heard> is the distance in seconds between time of exporting and the last packet seen. I.e. 2.000100 means 2 seconds and 100 microseconds ago.</para></listitem>
</itemizedlist>
</para>
<para><protocol> elements carry per protocol breakdown of node statistics. A packet might affect multiple protocols: an HTTP request over Ethernet is recorded by protocols "WWW", "TCP", "IP" and "ETH_II", while an Ethernet broadcast is seen only as "ETH_II".</para>
<para>Here <level> roughly equates to the OSI level, but multiple
encapsulation can confuse the engine and introduce additional levels. A
protocol level 2 is always lower than one of level 3.</para>
<para><key> is a mnemonic identifier of the protocol; for TCP/UDP ports is taken from the services file, if available.</para>
<para>There can be multiple entries with the same level (e.g. HTTP and
IMAP). Only the combination of level and key is unique. </para>
</sect1>
<sect1 id="authors">
<title>Authors</title>
<para>&app; 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 &app;,
please visit <ulink type="http" url="http://etherape.sourceforge.net/">
the &app; web page</ulink>. Instructions for submitting bug reports can be
found <ulink type="http"
url="http://etherape.sourceforge.net/bug-reporting.html">
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 type="help" url="gnome-help:gpl">
<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
type="http" url="http://www.fsf.org">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>
|