Commit Graph

24 Commits

Author SHA1 Message Date
Roland Knall f82535d645 Docbook: Add changed behavior for byteview
Add the changed hover behavior for the byteview to the
documentation
2021-09-14 10:56:39 +02:00
Thomas Dreibholz 0f86c41e73 Added NetPerfMeter statistics feature, including corresponding documentation. 2021-05-05 07:09:25 +00:00
Thomas Dreibholz c295e8a149 Added missing documentation for the RSerPool statistics features. 2021-04-21 19:53:09 +00:00
Chuck Craft ec4a059968 WSUG: update Tools Menu - text and screenshot 2021-04-13 10:14:37 +00:00
Jirka Novak 2c82ed9a97 WSUG: Added description of new features of telephony dialogs
Changes:
- Added description of playlist idea and related operations
- Added description of RTP Player dialog
- Added description of VoIP Calls dialog
- Added description of Flow Graph dialog
- Added help link to Flow Graph dialog
- Added description of RTP Streams window
- Added description of RTP Stream Analysis window
- Updated related past images
2021-04-11 15:46:48 +00:00
Alex Nik ef61fd4638 added description for UDP Multicast Streams
fixed UDP Multicast Streams title and also crossref in WSUG_chapter_use.adoc table

applied SME suggestions

minor fixes
2021-02-23 21:14:36 +00:00
Martin Mathieson df651aca91 Spelling improvements
Improve script by ignoring common contractions, dealing with
e.g. \n within strings, and finding multiple concatenated words even
when no camelCase is used.

Also includes some actual spelling fixes.
2020-11-22 11:30:24 +00:00
Chuck Craft 90cd509d92 Consistent "Prepare as Filter" - menus and screenshots #16892 2020-10-15 09:18:56 +00:00
Роман Донченко 88b0370f86 Fix spelling errors in the documentation 2020-10-12 11:43:47 +00:00
Gerald Combs bf46e5c4cc Docs: Note that you can group filter buttons.
Note that you can group filter buttons in the release notes and in the
filter toolbar docs.
2020-09-30 16:27:38 +00:00
Gerald Combs 9b07412277 Qt: Add a packet diagram view.
Add a new top-level view that shows each packet as a series of diagrams
similar to what you'd find in a networking textook or an RFC.

Add proto_item_set_bits_offset_len so that we can display some diagram
fields correctly.

Bugs / to do:
  - Make this a separate dialog instead of a main window view?
  - Handle bitfields / flags

Change-Id: Iba4897a5bf1dcd73929dde6210d5483cf07f54df
Reviewed-on: https://code.wireshark.org/review/37497
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2020-08-10 18:17:50 +00:00
Jaap Keuter 3605bdc323 WSUG: Remove expression button from filter toolbar
Since Wireshark 3.2 the filter toolbar no longer has an Expression button.
Remove this from the Users Guide as well.

Change-Id: I54d0356c42ff599296fa800e7d730e6098f35976
Reviewed-on: https://code.wireshark.org/review/37338
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-05-29 23:01:30 +00:00
Gerald Combs fac6a2179e WSUG: Add a Packet Lengths dialog section.
Add a section for the Packet Lengths window. Use title case for the
column headers. Fix a button name and other issues elsewhere.

Change-Id: I339d56aa169158e0788acd02a897729205e9f50e
Reviewed-on: https://code.wireshark.org/review/35615
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2020-01-03 16:37:08 +00:00
Gerald Combs 5e8d79fd69 WSUG: Update the Expert Information and Status Bar docs.
Update the Expert Information section of the User's Guide. Use the term
"Expert Information" to describe the dialog and "expert information
item" to describe each generated item. Update related text elsewhere.

Update the expert icon and other parts of the status bar docs.

Change-Id: I0c2cba0cbb3c74a1f6e3a37d4a2a592faccb350f
Reviewed-on: https://code.wireshark.org/review/35462
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-12-17 05:10:44 +00:00
Gerald Combs 643dc75964 WSUG: Add a Wireless menu section.
Add a section for the Wireless menu.

Remove some unused images. It doesn't look like we ever used
ws-*-preferences.png. They had ENTITY definitions in the original XML,
but those weren't referenced anywhere.

Change-Id: I7f027b48ef22c8680f6224f189d4e9d0bd8114c0
Reviewed-on: https://code.wireshark.org/review/35328
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-12-06 19:43:39 +00:00
Moshe Kaplan cb7dafbcf6 WSUG: Clean up duplicated words
Used egrep "\b([a-zA-Z]+) \1\b" docbook/wsug_src/*.adoc to find instances
where words were erroneously duplicated.

Change-Id: Ie390fa4f1c61a288ff0ed77aa84c4fb01f4de27e
Reviewed-on: https://code.wireshark.org/review/34725
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-10-08 03:57:49 +00:00
Gerald Combs fb5a029e47 Docbook: Fixup our table delimiters.
Update our table delimiters to match the Asciidoctor documentation.

Change-Id: I87a6834f2889e175236aa609984a9bc4dd9d3b8e
Reviewed-on: https://code.wireshark.org/review/34544
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-09-16 17:35:49 +00:00
Gerald Combs e9daf6ce51 WSUG: Clean up some menu item descriptions.
Summarize and clean up some of the menu item text. Start sentences on a
new line as recommended at
https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line,
although we wrap long lines.

Change-Id: I778f278d8503153ec649c3f0a4b2ccb24512e701
Reviewed-on: https://code.wireshark.org/review/34341
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Reviewed-by: Jaap Keuter <jaap.keuter@xs4all.nl>
2019-08-23 18:18:03 +00:00
Jaap Keuter 7519c077d0 WSUG: Update Control Protocol dissection chapter
With the design changes made in the Qt interface with respect to the
Deocode as dialogs the Users Guide content is confusing. Update the
graphics and text to accurately describe the current design. Update
references in other parts of the document too.

Change-Id: Iad6af555d2da3430230c7f176bf2ec1e808cc134
Reviewed-on: https://code.wireshark.org/review/34337
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2019-08-22 15:17:25 +00:00
Moshe Kaplan b4c6b3981f WSUG: Corrected keyboard shortcuts for Edit Menu
Change-Id: Id65a56c179bdcf60772239f0f371efa4b79a652b
Reviewed-on: https://code.wireshark.org/review/34062
Petri-Dish: Guy Harris <guy@alum.mit.edu>
Tested-by: Petri Dish Buildbot
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2019-07-23 18:35:41 +00:00
Dario Lombardo 1af6e1f860 tap: add credentials tap.
This new tap collects credentials (username and paassword)
from the dissectors.

So far, few dissectors have been instrumented:
- http (basic auth)
- http (header auth)
- ftp
Others can be instrumented as well using the same technique.

Tshark has a new option (-z credentials) and Wireshark a new
"tools" menu: the documentation has been updated accordingly.

Change-Id: I2d0d96598c85bb3ea4fb5ec090dd8dc28b481fc9
Reviewed-on: https://code.wireshark.org/review/33453
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Dario Lombardo <lomato@gmail.com>
2019-06-26 07:09:54 +00:00
Dario Lombardo 7969c41519 Use I/O Graphs instead of IO graphs everywhere.
Change-Id: I6ce866b03632965dd1bad6eff361d91dd210c62b
Reviewed-on: https://code.wireshark.org/review/33680
Petri-Dish: Dario Lombardo <lomato@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-06-20 20:01:00 +00:00
Moshe Kaplan c6bed35254 WSUG: Clarified and improved phrasing
Change-Id: I1b3b8b7bf5f6460aa779c54881abd53059b26bbb
Reviewed-on: https://code.wireshark.org/review/33606
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-06-17 00:46:03 +00:00
Gerald Combs b658de2fa7 Rename our .asciidoc files to .adoc
As noted in "AsciiDoc Recommended Practices" at
https://asciidoctor.org/docs/asciidoc-recommended-practices/, the
AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a
file extension and that's the one preferred by the Asciidoctor project.
Update our filenames to match.

Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c
Reviewed-on: https://code.wireshark.org/review/32037
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2019-02-15 05:17:26 +00:00