diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 38 | ||||
-rw-r--r-- | doc/Makefile.nmake | 38 | ||||
-rw-r--r-- | doc/README.binarytrees | 2 | ||||
-rw-r--r-- | doc/README.developer | 20 | ||||
-rw-r--r-- | doc/README.packaging | 4 | ||||
-rw-r--r-- | doc/README.tapping | 2 | ||||
-rw-r--r-- | doc/README.xml-output | 4 | ||||
-rw-r--r-- | doc/ethereal.pod | 12 |
8 files changed, 60 insertions, 60 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 02b40ba716..153452e20b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,5 +1,5 @@ # Makefile.am -# Automake file for Ethereal documentation +# Automake file for Wireshark documentation # # $Id$ # @@ -29,38 +29,38 @@ ethereal-tmp.pod: $(srcdir)/ethereal.pod $(top_builddir)/AUTHORS-SHORT-FORMAT ../ethereal.1: ethereal-tmp.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ ethereal-tmp.pod | sed 's/ETHEREAL-TMP/ETHEREAL/' > ../ethereal.1 ../ethereal.html: ethereal-tmp.pod ../config.h $(POD2HTML) \ - --title="The Ethereal Network Analyzer $(VERSION)" \ + --title="The Wireshark Network Analyzer $(VERSION)" \ --noindex \ ethereal-tmp.pod > ../ethereal.html ../tethereal.1: tethereal.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ $(srcdir)/tethereal.pod > ../tethereal.1 ../tethereal.html: tethereal.pod ../config.h $(POD2HTML) \ - --title="tethereal - The Ethereal Network Analyzer $(VERSION)" \ + --title="tethereal - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ $(srcdir)/tethereal.pod > ../tethereal.html ../ethereal-filter.4: ethereal-filter.pod ../config.h $(POD2MAN) \ --section=4 \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ ethereal-filter.pod > ../ethereal-filter.4 ../ethereal-filter.html: ethereal-filter.pod ../config.h $(POD2HTML) \ - --title="ethereal-filter - The Ethereal Network Analyzer $(VERSION)" \ + --title="ethereal-filter - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ ethereal-filter.pod > ../ethereal-filter.html @@ -69,73 +69,73 @@ ethereal-filter.pod: ethereal-filter.pod.template ../tethereal ../capinfos.1: capinfos.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ $(srcdir)/capinfos.pod > ../capinfos.1 ../capinfos.html: capinfos.pod ../config.h $(POD2HTML) \ - --title="capinfos - The Ethereal Network Analyzer $(VERSION)" \ + --title="capinfos - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ $(srcdir)/capinfos.pod > ../capinfos.html ../editcap.1: editcap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ $(srcdir)/editcap.pod > ../editcap.1 ../editcap.html: editcap.pod ../config.h $(POD2HTML) \ - --title="editcap - The Ethereal Network Analyzer $(VERSION)" \ + --title="editcap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ $(srcdir)/editcap.pod > ../editcap.html ../idl2eth.1: idl2eth.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ $(srcdir)/idl2eth.pod > ../idl2eth.1 ../idl2eth.html: idl2eth.pod ../config.h $(POD2HTML) \ - --title="idl2eth - The Ethereal Network Analyzer $(VERSION)" \ + --title="idl2eth - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ $(srcdir)/idl2eth.pod > ../idl2eth.html ../mergecap.1: mergecap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ $(srcdir)/mergecap.pod > ../mergecap.1 ../mergecap.html: mergecap.pod ../config.h $(POD2HTML) \ - --title="mergecap - The Ethereal Network Analyzer $(VERSION)" \ + --title="mergecap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ $(srcdir)/mergecap.pod > ../mergecap.html ../text2pcap.1: text2pcap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ $(srcdir)/text2pcap.pod > ../text2pcap.1 ../text2pcap.html: text2pcap.pod ../config.h $(POD2HTML) \ - --title="text2pcap - The Ethereal Network Analyzer $(VERSION)" \ + --title="text2pcap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ $(srcdir)/text2pcap.pod > ../text2pcap.html ../dumpcap.1: dumpcap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ $(srcdir)/dumpcap.pod > ../dumpcap.1 ../dumpcap.html: dumpcap.pod ../config.h $(POD2HTML) \ - --title="dumpcap - The Ethereal Network Analyzer $(VERSION)" \ + --title="dumpcap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ $(srcdir)/dumpcap.pod > ../dumpcap.html diff --git a/doc/Makefile.nmake b/doc/Makefile.nmake index e44d45d4ac..941893c721 100644 --- a/doc/Makefile.nmake +++ b/doc/Makefile.nmake @@ -1,5 +1,5 @@ # Makefile.nmake -# Nmake file for Ethereal documentation +# Nmake file for Wireshark documentation # # $Id$ # @@ -42,13 +42,13 @@ ethereal-tmp.pod: ethereal.pod ../AUTHORS-SHORT-FORMAT ethereal.1: ethereal.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ ethereal-tmp.pod > ethereal.1 ethereal.html: ethereal-tmp.pod ../config.h $(POD2HTML) \ - --title="The Ethereal Network Analyzer $(VERSION)" \ + --title="The Wireshark Network Analyzer $(VERSION)" \ --noindex \ ethereal-tmp.pod > ethereal.html @@ -59,25 +59,25 @@ ethereal.html: ethereal-tmp.pod ../config.h tethereal.1: tethereal.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ tethereal.pod > tethereal.1 tethereal.html: tethereal.pod ../config.h $(POD2HTML) \ - --title="tethereal - The Ethereal Network Analyzer $(VERSION)" \ + --title="tethereal - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ tethereal.pod > tethereal.html ethereal-filter.4: ethereal-filter.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ ethereal-filter.pod > ethereal.4 ethereal-filter.html: ethereal-filter.pod ../config.h $(POD2HTML) \ - --title="ethereal-filter - The Ethereal Network Analyzer $(VERSION)" \ + --title="ethereal-filter - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ ethereal-filter.pod > ethereal-filter.html @@ -90,74 +90,74 @@ ethereal-filter.pod: ethereal-filter.pod.template ../tethereal.exe capinfos.1: capinfos.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ capinfos.pod > capinfos.1 capinfos.html: capinfos.pod ../config.h $(POD2HTML) \ - --title="capinfos - The Ethereal Network Analyzer $(VERSION)" \ + --title="capinfos - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ capinfos.pod > capinfos.html editcap.1: editcap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ editcap.pod > editcap.1 editcap.html: editcap.pod ../config.h $(POD2HTML) \ - --title="editcap - The Ethereal Network Analyzer $(VERSION)" \ + --title="editcap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ editcap.pod > editcap.html idl2eth.1: idl2eth.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ idl2eth.pod > idl2eth.1 idl2eth.html: idl2eth.pod ../config.h $(POD2HTML) \ - --title="idl2eth - The Ethereal Network Analyzer $(VERSION)" \ + --title="idl2eth - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ idl2eth.pod > idl2eth.html mergecap.1: mergecap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ mergecap.pod > mergecap.1 mergecap.html: mergecap.pod ../config.h $(POD2HTML) \ - --title="mergecap - The Ethereal Network Analyzer $(VERSION)" \ + --title="mergecap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ mergecap.pod > mergecap.html text2pcap.1: text2pcap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ text2pcap.pod > text2pcap.1 text2pcap.html: text2pcap.pod ../config.h $(POD2HTML) \ - --title="text2pcap - The Ethereal Network Analyzer $(VERSION)" \ + --title="text2pcap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ text2pcap.pod > text2pcap.html dumpcap.1: dumpcap.pod ../config.h $(POD2MAN) \ - --center="The Ethereal Network Analyzer" \ + --center="The Wireshark Network Analyzer" \ --release=$(VERSION) \ dumpcap.pod > dumpcap.1 dumpcap.html: dumpcap.pod ../config.h $(POD2HTML) \ - --title="dumpcap - The Ethereal Network Analyzer $(VERSION)" \ + --title="dumpcap - The Wireshark Network Analyzer $(VERSION)" \ --noindex \ dumpcap.pod > dumpcap.html diff --git a/doc/README.binarytrees b/doc/README.binarytrees index dba93db76b..c5c039a6d3 100644 --- a/doc/README.binarytrees +++ b/doc/README.binarytrees @@ -17,7 +17,7 @@ Ethereal provides its own version of red black binary trees designed in particular to be easy to use and to eliminate most of the memory management often associated with such trees. -The trees supported by ethereal are currently all created using SEasonal +The trees supported by wireshark are currently all created using SEasonal storage which means that when you load a new trace into ethereal, the SEasonal memory management will automatically release every single byte of data associated with the tree. diff --git a/doc/README.developer b/doc/README.developer index fcb50db1c6..ce2c00d66e 100644 --- a/doc/README.developer +++ b/doc/README.developer @@ -1,6 +1,6 @@ $Id$ -This file is a HOWTO for Ethereal developers. It describes how to start coding +This file is a HOWTO for Wireshark developers. It describes how to start coding a Ethereal protocol dissector and the use some of the important functions and variables. @@ -144,7 +144,7 @@ and dereferencing that pointer. That point won't necessarily be aligned on the proper boundary, which can cause crashes on some platforms (even if it doesn't crash on an x86-based PC); furthermore, the data in a packet is not necessarily in the byte order of the machine on which -Ethereal is running. Use the tvbuff routines to extract individual +Wireshark is running. Use the tvbuff routines to extract individual items from the packet, or use "proto_tree_add_item()" and let it extract the items for you. @@ -299,7 +299,7 @@ Ethereal supports both platforms with GLib 1.2[.x]/GTK+ 1.2[.x] and GLib 2.x/GTK+ 1.3[.x] and 2.x. If at all possible, either use only mechanisms that are present in GLib 1.2[.x] and GTK+ 1.2[.x], use #if's to conditionally use older or newer mechanisms depending on the platform -on which Ethereal is being built, or, if the code in GLib or GTK+ that +on which Wireshark is being built, or, if the code in GLib or GTK+ that implements that mechanism will build with GLib 1.2[.x]/GTK+ 1.2[.x], conditionally include that code as part of the Ethereal source and use the included version with GLib 1.2[.x] or GTK+ 1.2[.x]. In particular, @@ -311,7 +311,7 @@ also work with GLib 1.2[.x] and GTK+ 1.2[.x]. When different code must be used on UN*X and Win32, use a #if or #ifdef that tests _WIN32, not WIN32. Try to write code portably whenever -possible, however; note that there are some routines in Ethereal with +possible, however; note that there are some routines in Wireshark with platform-dependent implementations and platform-independent APIs, such as the routines in epan/filesystem.c, allowing the code that calls it to be written portably without #ifdefs. @@ -380,8 +380,8 @@ Please read README.malloc . 1.1.3 Robustness. -Ethereal is not guaranteed to read only network traces that contain correctly- -formed packets. Ethereal is commonly used is to track down networking problems, +Wireshark is not guaranteed to read only network traces that contain correctly- +formed packets. Wireshark is commonly used is to track down networking problems, and the problems might be due to a buggy protocol implementation sending out bad packets. @@ -523,7 +523,7 @@ Avoid using tab expansions different from 8 spaces, as not all text editors in use by the developers support this. When creating a new file, you are free to choose an indentation logic. Most of -the files in Ethereal tend to use 2-space or 4-space indentation. You are +the files in Wireshark tend to use 2-space or 4-space indentation. You are encouraged to write a short comment on the indentation logic at the beginning of this new file. @@ -689,14 +689,14 @@ dissect_PROTOABBREV(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) (a) Operational dissection - In this mode, Ethereal is only interested in the way protocols + In this mode, Wireshark is only interested in the way protocols interact, protocol conversations are created, packets are reassembled and handed over to higher-level protocol dissectors. In this mode Ethereal does not build a so-called "protocol tree". (b) Detailed dissection - In this mode, Ethereal is also interested in all details of a given + In this mode, Wireshark is also interested in all details of a given protocol, so a "protocol tree" is created. Ethereal distinguishes between the 2 modes with the proto_tree pointer: @@ -2725,7 +2725,7 @@ whether it is registered to our protocol or not. We should do this because is uncommon but it does happen that multiple different protocols can use the same socketpair during different stages of an application cycle. By keeping track of the frame number a conversation -was started in ethereal can still tell these different protocols apart. +was started in wireshark can still tell these different protocols apart. The second argument to conversation_set_dissector is a dissector handle, which is created with a call to create_dissector_handle or diff --git a/doc/README.packaging b/doc/README.packaging index 6e199a7390..df866a03c0 100644 --- a/doc/README.packaging +++ b/doc/README.packaging @@ -10,9 +10,9 @@ distributing a software package containing Ethereal: If your packaging system downloads a copy of the Ethereal sources, use this location. -2. The Ethereal web site URL is http://www.ethereal.com/ . +2. The Wireshark web site URL is http://www.ethereal.com/ . -3. Ethereal is released under the GNU General Public License. Make sure +3. Wireshark is released under the GNU General Public License. Make sure your package complies with this license, or we send in the marmots. 4. Ethereal and the "e" logo are registered trademarks of Ethereal, Inc. diff --git a/doc/README.tapping b/doc/README.tapping index 328bbade3f..2347716dbb 100644 --- a/doc/README.tapping +++ b/doc/README.tapping @@ -1,6 +1,6 @@ $Id$ -The TAP system in ethereal is a powerful and flexible mechanism to get event +The TAP system in wireshark is a powerful and flexible mechanism to get event driven notification on packets matching certain protocols and/or filters. In order to use the tapping system, very little knowledge of ethereal internals are required. diff --git a/doc/README.xml-output b/doc/README.xml-output index 154b3940ab..5af7e80cde 100644 --- a/doc/README.xml-output +++ b/doc/README.xml-output @@ -32,7 +32,7 @@ It causes Analyzer to crash. As such, the PDML that ethereal produces is be labled with a version number of "0", which means that the PDML does not fully follow the PDML spec. Furthemore, a creator attribute in the "<pdml>" tag gives the version number of [t]ethereal that produced the PDML. -In that way, as the PDML produced by ethereal matures, but still does not +In that way, as the PDML produced by wireshark matures, but still does not meet the PDML spec, scripts can make intelligent decisions about how to best parse the PDML, based on the "creator" attribute. @@ -93,7 +93,7 @@ a field with a field-name. Those appear in PDML as "<field>" tags with no Many dissectors label the undissected payload of a protocol as belonging to a "data" protocol, and the "data" protocol usually resided inside that last protocol dissected. In the PDML, The "data" protocol becomes -a "data" field, placed exactly where the "data" protocol is in ethereal's +a "data" field, placed exactly where the "data" protocol is in wireshark's protocol tree. So, if ethereal would normally show: +-- Frame diff --git a/doc/ethereal.pod b/doc/ethereal.pod index 8acfdc7983..674c20c069 100644 --- a/doc/ethereal.pod +++ b/doc/ethereal.pod @@ -1512,13 +1512,13 @@ item can be set to use either inverse video, or bold characters. =item Save Window Position -If this item is selected, the position of the main Ethereal window will -be saved when Ethereal exits, and used when Ethereal is started again. +If this item is selected, the position of the main Wireshark window will +be saved when Ethereal exits, and used when Wireshark is started again. =item Save Window Size -If this item is selected, the size of the main Ethereal window will -be saved when Ethereal exits, and used when Ethereal is started again. +If this item is selected, the size of the main Wireshark window will +be saved when Ethereal exits, and used when Wireshark is started again. =item File Open Dialog Behavior @@ -1879,7 +1879,7 @@ you specify that Ethereal should stop capturing after the file to which captured packets are being saved grows as large as or larger than some specified number of megabytes. If the check box is not checked, Ethereal will not stop capturing at some capture file size (although the operating -system on which Ethereal is running, or the available disk space, may still +system on which Wireshark is running, or the available disk space, may still limit the maximum size of a capture file). This option is disabled, if "multiple files" mode is used, @@ -2011,7 +2011,7 @@ The settings in this file have the same format as in the F<preferences> files, and the same directory as for the personal preferences file is used. -Note: Whenever Ethereal is closed, your recent file +Note: Whenever Wireshark is closed, your recent file will be overwritten with the new settings, destroying any comments and unknown/obsolete settings that were in the file. |