osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

WSUG+WSDG: Remove description list formatting. 

Remove the last of our description list term formatting. This is better
handled using CSS. Update the filter expression dialog DL text.

Change-Id: Ib21e2ee5265c9b476d960e7d73ac99b25b646141
Reviewed-on: https://code.wireshark.org/review/35437
Reviewed-by: Gerald Combs <gerald@wireshark.org>
This commit is contained in:
Gerald Combs 2019-12-14 11:47:44 -08:00
parent 8939d358e2
commit 85e47d9bcd
4 changed files with 79 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docbook/wsdg_src/WSDG_chapter_dissection.adoc
View File

@ -1150,16 +1150,16 @@ calls to decode the CORBA traffic on the wire.
It consists of 4 main files.
_README.idl2wrs_::
README.idl2wrs::
This document
_$$wireshark_be.py$$_::
wireshark_be.py::
The main compiler backend
_$$wireshark_gen.py$$_::
wireshark_gen.py::
A helper class, that generates the C code.
_idl2wrs_::
idl2wrs::
A simple shell script wrapper that the end user should use to generate the
dissector from the IDL file(s).

30
docbook/wsug_src/WSUG_app_files.adoc
View File

@ -179,7 +179,7 @@ _/usr/local/etc_.
[float]
===== File contents
_preferences_::
preferences::
This file contains your Wireshark preferences, including defaults for capturing
and displaying packets. It is a simple text file containing statements of the
form:
@ -199,7 +199,7 @@ If you press the Save button in the “Preferences” dialog box, all the
current settings are written to the personal preferences file.
--
_recent_::
recent::
This file contains various GUI related settings like the main window position
and size, the recent files list and such. It is a simple text file containing
statements of the form:
@ -212,7 +212,7 @@ variable: value
It is read at program start and written at program exit.
--
_cfilters_::
cfilters::
This file contains all the capture filters that you have defined and saved. It
consists of one or more lines, where each line has the following format:
+
@ -231,7 +231,7 @@ all the current capture filters are written to the personal capture
filters file.
--
_dfilters_::
dfilters::
This file contains all the display filters that you have defined and saved. It
consists of one or more lines, where each line has the following format:
+
@ -250,7 +250,7 @@ all the current display filters are written to the personal display
filters file.
--
_+++dfilter_macros+++_::
dfilter_macros::
This file contains all the display filter macros that you have defined and saved.
It consists of one or more lines, where each line has the following format:
+
@ -272,7 +272,7 @@ More information about Display Filter Macros is available in
<<ChDisplayFilterMacrosSection>>
--
_colorfilters_::
colorfilters::
This file contains all the color filters that you have defined and saved. It
consists of one or more lines, where each line has the following format:
+
@ -291,7 +291,7 @@ all the current color filters are written to the personal color filters
file.
--
_+++disabled_protos+++_::
disabled_protos::
Each line in this file specifies a disabled protocol name. The following are
some examples:
+
@ -313,7 +313,7 @@ the current set of disabled protocols is written to the personal
disabled protocols file.
--
_ethers_::
ethers::
When Wireshark is trying to translate an hardware MAC address to
a name, it consults the _ethers_ file in the personal configuration
folder first. If the address is not found in that file, Wireshark
@ -334,7 +334,7 @@ The settings from this file are read in when a MAC address is to be
translated to a name, and never written by Wireshark.
--
_manuf_::
manuf::
At program start, if there is a _manuf_ file in the global
configuration folder, it is read.
+
@ -353,7 +353,7 @@ The settings from this file are read in at program start and never written by
Wireshark.
--
_hosts_::
hosts::
Wireshark uses the entries in the _hosts_ files to translate IPv4 and
IPv6 addresses into names.
+
@ -377,7 +377,7 @@ The settings from this file are read in at program start and never written by
Wireshark.
--
_services_::
services::
Wireshark uses the _services_ files to translate port numbers into names.
+
At program start, if there is a _services_ file in the global
@ -398,7 +398,7 @@ The settings from these files are read in at program start and never
written by Wireshark.
--
_subnets_::
subnets::
Wireshark uses the __subnets__ files to translate an IPv4 address into a
subnet name. If no exact match from a __hosts__ file or from DNS is
found, Wireshark will attempt a partial match for the subnet of the
@ -431,7 +431,7 @@ The settings from these files are read in at program start and never
written by Wireshark.
--
_ipxnets_::
ipxnets::
When Wireshark is trying to translate an IPX network number to
a name, it consults the _ipxnets_ file in the personal configuration
folder first. If the address is not found in that file, Wireshark
@ -451,7 +451,7 @@ The settings from this file are read in when an IPX network number is to
be translated to a name, and never written by Wireshark.
--
_vlans_::
vlans::
Wireshark uses the _vlans_ file to translate VLAN tag IDs into names.
+
If there is a _vlans_ file in the currently active profile folder, it is used. Otherwise the _vlans_ file in the personal configuration folder is used.
@ -469,7 +469,7 @@ The settings from this file are read in at program start or when changing
the active profile and are never written by Wireshark.
--
_ss7pcs_::
ss7pcs::
Wireshark uses the _ss7pcs_ file to translate SS7 point codes to node names.
+
At program start, if there is a _ss7pcs_ file in the personal

60
docbook/wsug_src/WSUG_chapter_statistics.adoc
View File

@ -99,27 +99,27 @@ The btn:[Copy] button will let you copy the window contents as CSV or YAML.
.Protocol hierarchy columns
_Protocol_:: This protocol’s name
Protocol:: This protocol’s name
_Percent Packets_:: The percentage of protocol packets relative to all packets in
Percent Packets:: The percentage of protocol packets relative to all packets in
the capture
_Packets_:: The total number of packets of this protocol
Packets:: The total number of packets of this protocol
_Percent Bytes_:: The percentage of protocol bytes relative to the total bytes in
Percent Bytes:: The percentage of protocol bytes relative to the total bytes in
the capture
_Bytes_:: The total number of bytes of this protocol
Bytes:: The total number of bytes of this protocol
_Bits/s_:: The bandwidth of this protocol relative to the capture time
Bits/s:: The bandwidth of this protocol relative to the capture time
_End Packets_:: The absolute number of packets of this protocol where it
End Packets:: The absolute number of packets of this protocol where it
was the highest protocol in the stack (last dissected)
_End Bytes_:: The absolute number of bytes of this protocol where it
End Bytes:: The absolute number of bytes of this protocol where it
was the highest protocol in the stack (last dissected)
_End Bits/s_:: The bandwidth of this protocol relative to the capture time where
End Bits/s:: The bandwidth of this protocol relative to the capture time where
was the highest protocol in the stack (last dissected)
Packets usually contain multiple protocols. As a result more than one protocol will
@ -205,43 +205,43 @@ you’re looking for.
.Endpoint and Conversation types
_Bluetooth_:: A MAC-48 address similar to Ethernet.
Bluetooth:: A MAC-48 address similar to Ethernet.
_Ethernet_:: Identical to the Ethernet device’s MAC-48 identifier.
Ethernet:: Identical to the Ethernet device’s MAC-48 identifier.
_Fibre Channel_:: A MAC-48 address similar to Ethernet.
Fibre Channel:: A MAC-48 address similar to Ethernet.
_IEEE 802.11_:: A MAC-48 address similar to Ethernet.
IEEE 802.11:: A MAC-48 address similar to Ethernet.
_FDDI_:: Identical to the FDDI MAC-48 address.
FDDI:: Identical to the FDDI MAC-48 address.
_IPv4_:: Identical to the 32-bit IPv4 address.
IPv4:: Identical to the 32-bit IPv4 address.
_IPv6_:: Identical to the 128-bit IPv6 address.
IPv6:: Identical to the 128-bit IPv6 address.
_IPX_:: A concatenation of a 32 bit network number and 48 bit node address, by
IPX:: A concatenation of a 32 bit network number and 48 bit node address, by
default the Ethernet interface’s MAC-48 address.
_JXTA_:: A 160 bit SHA-1 URN.
JXTA:: A 160 bit SHA-1 URN.
_NCP_:: Similar to IPX.
NCP:: Similar to IPX.
_RSVP_:: A combination of varios RSVP session attributes and IPv4 addresses.
RSVP:: A combination of varios RSVP session attributes and IPv4 addresses.
_SCTP_:: A combination of the host IP addresses (plural) and
SCTP:: A combination of the host IP addresses (plural) and
the SCTP port used. So different SCTP ports on the same IP address are different
SCTP endpoints, but the same SCTP port on different IP addresses of the same
host are still the same endpoint.
_TCP_:: A combination of the IP address and the TCP port used.
TCP:: A combination of the IP address and the TCP port used.
Different TCP ports on the same IP address are different TCP endpoints.
_Token Ring_:: Identical to the Token Ring MAC-48 address.
Token Ring:: Identical to the Token Ring MAC-48 address.
_UDP_:: A combination of the IP address and the UDP port used, so different UDP
UDP:: A combination of the IP address and the UDP port used, so different UDP
ports on the same IP address are different UDP endpoints.
_USB_:: Identical to the 7-bit USB address.
USB:: Identical to the 7-bit USB address.
[NOTE]
.Broadcast and multicast endpoints
@ -514,22 +514,22 @@ image::wsug_graphics/ws-stats-http-requestsequences.png[{screenshot-attrs}]
Show different visual representations of the TCP streams in a capture.
_Time Sequence (Stevens)_:: This is a simple graph of the TCP sequence
Time Sequence (Stevens):: This is a simple graph of the TCP sequence
number over time, similar to the ones used in Richard Stevens’ “TCP/IP
Illustrated” series of books.
_Time Sequence (tcptrace)_:: Shows TCP metrics similar to the
Time Sequence (tcptrace):: Shows TCP metrics similar to the
http://www.tcptrace.org/[tcptrace] utility, including forward segments,
acknowledgements, selective acknowledgements, reverse window sizes, and
zero windows.
_Throughput_:: Average throughput and goodput.
Throughput:: Average throughput and goodput.
_Round Trip Time_:: Round trip time vs time or sequence number. RTT is
Round Trip Time:: Round trip time vs time or sequence number. RTT is
based on the acknowledgement timestamp corresponding to a particular
segment.
_Window Scaling_:: Window size and outstanding bytes.
Window Scaling:: Window size and outstanding bytes.
[[ChStatUDPMulticastGraphs]]

52
docbook/wsug_src/WSUG_chapter_work.adoc
View File

@ -817,41 +817,49 @@ image::wsug_graphics/ws-filter-add-expression.png[{screenshot-attrs}]
When you first bring up the Display Filter Expression dialog box you are shown a tree
of field names, organized by protocol, and a box for selecting a relation.
_Field Name_::
Field Name::
Select a protocol field from the protocol field tree. Every protocol with
filterable fields is listed at the top level. (You can search for a particular
protocol entry by entering the first few letters of the protocol name). By
filterable fields is listed at the top level. You can search for a particular
protocol entry by entering the first few letters of the protocol name. By
expanding a protocol name you can get a list of the field names available for
filtering for that protocol.
_Relation_::
Relation::
Select a relation from the list of available relation. The _is present_ is a
unary relation which is true if the selected field is present in a packet. All
other listed relations are binary relations which require additional data (e.g.
a _Value_ to match) to complete.
+
When you select a field from the field name list and select a binary relation
(such as the equality relation ==) you will be given the opportunity to enter a
value, and possibly some range information.
_Value_::
Value::
You may enter an appropriate value in the _Value_ text box. The _Value_ will
also indicate the type of value for the _field name_ you have selected (like
also indicate the type of value for the _Field Name_ you have selected (like
character string).
_Predefined values_::
Some of the protocol fields have predefined values available, much like enum’s
Predefined Values::
Some of the protocol fields have predefined values available, much like enumerations
in C. If the selected protocol field has such values defined, you can choose one
of them here.
_Range_::
Search::
Lets you search for a full or partial field name or description.
Regular expressions are supported
For example, searching for “tcp.*flag” shows the TCP flags fields supported by a wide variety of dissectors, while “^tcp.flag” shows only the TCP flags fields supported by the TCP dissector.
Range::
A range of integers or a group of ranges, such as `1-12` or `39-42,98-2000`.
_OK_::
btn:[Help]::
Opens this section of the User’s Guide.
btn:[OK]::
When you have built a satisfactory expression click btn:[OK] and a filter string
will be built for you.
_Cancel_::
btn:[Cancel]::
You can leave the “Add Expression...” dialog box without any effect by
clicking the btn:[Cancel] button.
@ -884,51 +892,51 @@ Wireshark.
.The “Capture Filters” and “Display Filters” dialog boxes
image::wsug_graphics/ws-filters.png[{screenshot-attrs}]
_New_::
New::
This button adds a new filter to the list of filters. The currently entered
values from Filter name and Filter string will be used. If any of these fields
are empty, it will be set to “new”.
_Delete_::
Delete::
This button deletes the selected filter. It will be greyed out if no filter is
selected.
_Filter_::
Filter::
You can select a filter from this list (which will fill in the filter name and
filter string in the fields down at the bottom of the dialog box).
_Filter name:_::
Filter name:::
You can change the name of the currently selected filter here.
+
The filter name will only be used in this dialog to identify the filter for your
convenience, it will not be used elsewhere. You can add multiple filters with
the same name, but this is not very useful.
_Filter string:_::
Filter string:::
You can change the filter string of the currently selected filter here. Display
Filter only: the string will be syntax checked while you are typing.
_Add Expression..._::
Add Expression...::
Display Filter only: This button brings up the Add Expression dialog box which
assists in building filter strings. You can find more information about the Add
Expression dialog in <<ChWorkFilterAddExpressionSection>>
_OK_::
OK::
Display Filter only: This button applies the selected filter to the current
display and closes the dialog.
_Apply_::
Apply::
Display Filter only: This button applies the selected filter to the current
display, and keeps the dialog open.
_Save_::
Save::
Save the current settings in this dialog. The file location and format is
explained in <<AppFiles>>.
_Close_::
Close::
Close this dialog. This will discard unsaved settings.
[[ChWorkDefineFilterMacrosSection]]