aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/wsug_src
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2016-11-01 14:35:29 -0700
committerGerald Combs <gerald@wireshark.org>2016-11-11 17:18:25 +0000
commit65ab2a97018877ec3a8664d7422c3ee4662e97ca (patch)
treef6068d14ae9493c400eca66019dedbb76a2c42f4 /docbook/wsug_src
parentaba4d3a3a7d8c7f97290621085a8fb7a33942847 (diff)
AsciiDoc: Create an include file for attributes.
Move the replacement definitions in asciidoc.conf to attributes.asciidoc. This makes the markup a bit cleaner and is more compatible with AsciiDoctor. Use a standard naming scheme for URLs. Change-Id: Ica73aaadb013be2a4e6a3963fb54e6db6e02e98f Reviewed-on: https://code.wireshark.org/review/18655 Reviewed-by: Peter Wu <peter@lekensteyn.nl> Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'docbook/wsug_src')
-rw-r--r--docbook/wsug_src/WSUG_app_protocols.asciidoc2
-rw-r--r--docbook/wsug_src/WSUG_app_tools.asciidoc11
-rw-r--r--docbook/wsug_src/WSUG_chapter_advanced.asciidoc15
-rw-r--r--docbook/wsug_src/WSUG_chapter_build_install.asciidoc46
-rw-r--r--docbook/wsug_src/WSUG_chapter_capture.asciidoc49
-rw-r--r--docbook/wsug_src/WSUG_chapter_customize.asciidoc23
-rw-r--r--docbook/wsug_src/WSUG_chapter_introduction.asciidoc106
-rw-r--r--docbook/wsug_src/WSUG_chapter_statistics.asciidoc4
-rw-r--r--docbook/wsug_src/WSUG_chapter_telephony.asciidoc7
-rw-r--r--docbook/wsug_src/WSUG_chapter_use.asciidoc10
-rw-r--r--docbook/wsug_src/WSUG_chapter_work.asciidoc2
-rw-r--r--docbook/wsug_src/WSUG_preface.asciidoc24
12 files changed, 148 insertions, 151 deletions
diff --git a/docbook/wsug_src/WSUG_app_protocols.asciidoc b/docbook/wsug_src/WSUG_app_protocols.asciidoc
index d4416b32ae..45c6e9ffee 100644
--- a/docbook/wsug_src/WSUG_app_protocols.asciidoc
+++ b/docbook/wsug_src/WSUG_app_protocols.asciidoc
@@ -12,7 +12,7 @@ tcp.port).
A comprehensive list of all protocols and protocol fields can be found
in the ``Display Filter Reference'' at
-link:wireshark-display-filter-reference:[][wireshark-display-filter-reference:[]]
+{wireshark-display-filter-reference-url}
++++++++++++++++++++++++++++++++++++++
<!-- End of WSUG Appendix Protocols -->
diff --git a/docbook/wsug_src/WSUG_app_tools.asciidoc b/docbook/wsug_src/WSUG_app_tools.asciidoc
index df66220bb3..9775e80dba 100644
--- a/docbook/wsug_src/WSUG_app_tools.asciidoc
+++ b/docbook/wsug_src/WSUG_app_tools.asciidoc
@@ -11,10 +11,10 @@
=== Introduction
-Along with the main application, Wireshark comes with an array of command line
-tools which can be helpful for specialized tasks. These tools will be described
-in this chapter. You can find more information about each command in the
-link:wireshark-man-page-reference:[][Manual Pages].
+Along with the main application, Wireshark comes with an array of
+command line tools which can be helpful for specialized tasks. These
+tools will be described in this chapter. You can find more information
+about each command in the link:{wireshark-man-page-url}[Manual Pages].
[[AppToolstshark]]
@@ -150,8 +150,7 @@ save into. In addition, you will have to terminate the capture with ^C when you
believe you have captured enough packets.
+tcpdump+ is not part of the Wireshark distribution. You can get it from
-link:$$http://www.tcpdump.org/:[]$$[http://www.tcpdump.org] or as a standard
-package in most Linux distributions.
+{tcpdump-main-url} or as a standard package in most Linux distributions.
[[AppToolsdumpcap]]
diff --git a/docbook/wsug_src/WSUG_chapter_advanced.asciidoc b/docbook/wsug_src/WSUG_chapter_advanced.asciidoc
index 396060e318..e407fa09ec 100644
--- a/docbook/wsug_src/WSUG_chapter_advanced.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_advanced.asciidoc
@@ -447,9 +447,8 @@ If it's 3 o'clock in Berlin it's 2 o'clock in UTC ``at the same moment''.
Be aware that at a few places on earth don't use time zones with even hour
offsets (e.g. New Delhi uses UTC+05:30)!
-Further information can be found at:
-link:wikipedia-web-site:[]Time_zone[wikipedia-web-site:[]Time_zone] and
-link:wikipedia-web-site:[]Coordinated_Universal_Time[wikipedia-web-site:[]Coordinated_Universal_Time].
+Further information can be found at: {wikipedia-main-url}Time_zone and
+{wikipedia-main-url}Coordinated_Universal_Time.
****
@@ -470,12 +469,11 @@ Australia).
Keep in mind: UTC remains the same all year around, regardless of DST!
Further information can be found at
-link:wikipedia-web-site:[]Daylight_saving[wikipedia-web-site:[]Daylight_saving].
+link:{wikipedia-main-url}Daylight_saving[].
****
Further time zone and DST information can be found at
-link:greenwichmeantime-web-site:[][greenwichmeantime-web-site:[]] and
-link:timeanddate-web-site:[][timeanddate-web-site:[]].
+{greenwichmeantime-main-url} and {timeanddate-main-url}.
==== Set your computer's time correctly!
@@ -503,8 +501,7 @@ before, you are simply in a different time zone with a different local time.
You can use the Network Time Protocol (NTP) to automatically adjust your
computer to the correct time, by synchronizing it to Internet NTP clock servers.
NTP clients are available for all operating systems that Wireshark supports (and
-for a lot more), for examples see:
-link:ntp-web-site:[][ntp-web-site:[]].
+for a lot more), for examples see {ntp-main-url}.
==== Wireshark and Time Zones
@@ -794,7 +791,7 @@ medium, the importance of error detection, the processor load to perform the
calculation, the performance needed and many other things.
Further information about checksums can be found at:
-link:wikipedia-web-site:[]Checksum[wikipedia-web-site:[]Checksum].
+{wikipedia-main-url}Checksum.
****
==== Wireshark checksum validation
diff --git a/docbook/wsug_src/WSUG_chapter_build_install.asciidoc b/docbook/wsug_src/WSUG_chapter_build_install.asciidoc
index a4c9b7cb5b..c4721f5761 100644
--- a/docbook/wsug_src/WSUG_chapter_build_install.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_build_install.asciidoc
@@ -12,7 +12,7 @@
As with all things there must be a beginning and so it is with Wireshark. To
use Wireshark you must first install it. If you are running Windows or OS X
-you can download an official release at wireshark-download-page:[], install it,
+you can download an official release at {wireshark-download-url}, install it,
and skip the rest of this chapter.
If you are running another operating system such as Linux or FreeBSD you might
@@ -38,9 +38,9 @@ The following are the general steps you would use:
=== Obtaining the source and binary distributions
-You can obtain both source and binary distributions from the Wireshark web site:
-wireshark-web-site:[]. Select the download link and then select the desired
-binary or source package.
+You can obtain both source and binary distributions from the Wireshark
+web site: {wireshark-download-url}. Select the download link and then
+select the desired binary or source package.
[NOTE]
.Download all required files
@@ -70,10 +70,11 @@ Wireshark-win64-{wireshark-version}.exe installs Wireshark {wireshark-version}
for 64-bit Windows. The Wireshark installer includes WinPcap which is required
for packet capture.
-Simply download the Wireshark installer from: wireshark-download-page:[] and
-execute it. Official packages are signed by the *Wireshark Foundation*. You can
-choose to install several optional components and select the location of the
-installed package. The default settings are recommended for most users.
+Simply download the Wireshark installer from {wireshark-download-url}
+and execute it. Official packages are signed by the *Wireshark
+Foundation*. You can choose to install several optional components and
+select the location of the installed package. The default settings are
+recommended for most users.
[[ChBuildInstallWinComponents]]
@@ -94,7 +95,7 @@ On the _Choose Components_ page of the installer you can select from the followi
- *Tree Statistics Plugins* - Extended statistics.
- - *Mate - Meta Analysis and Tracing Engine* - User configurable extension(s) of the display filter engine, see wireshark-wiki-site:[]Mate for details.
+ - *Mate - Meta Analysis and Tracing Engine* - User configurable extension(s) of the display filter engine, see {wireshark-wiki-url}Mate for details.
- *SNMP MIBs* - SNMP MIBs for a more detailed SNMP dissection.
@@ -149,8 +150,8 @@ traffic but you will still be able to open saved capture files. By default the
latest version of WinPcap will be installed. If you don't wish to do this or if
you wish to reinstall WinPcap you can check the _Install WinPcap_ box as needed.
-For more information about WinPcap see winpcap-web-site:[] and
-wireshark-wiki-site:[]WinPcap.
+For more information about WinPcap see {winpcap-main-url} and
+{wireshark-wiki-url}WinPcap.
[[ChBuildInstallWinWiresharkCommandLine]]
@@ -191,9 +192,9 @@ The following is only necessary if you want to use a different version than the
one included in the Wireshark installer, e.g. because a new WinPcap version was
released.
-Additional WinPcap versions (including newer alpha or beta releases) can be
-downloaded from the main WinPcap site: winpcap-web-site:[]. The _Installer for
-Windows_ supports modern Windows operating systems.
+Additional WinPcap versions (including newer alpha or beta releases) can
+be downloaded from the main WinPcap site at {winpcap-main-url}. The
+_Installer for Windows_ supports modern Windows operating systems.
[[ChBuildInstallWinWiresharkUpdate]]
@@ -214,9 +215,10 @@ remain unchanged.
==== Update WinPcap
-New versions of WinPcap are less frequently available. You will find WinPcap
-update instructions the WinPcap web site at winpcap-web-site:[]. You may have to
-reboot your machine after installing a new WinPcap version.
+New versions of WinPcap are less frequently available. You will find
+WinPcap update instructions the WinPcap web site at {winpcap-main-url}.
+You may have to reboot your machine after installing a new WinPcap
+version.
[[ChBuildInstallWinUninstall]]
@@ -257,9 +259,9 @@ included _Read me first_ file for more details.
=== Building Wireshark from source under UNIX
-Building Wireshark requires the proper build environment including a compiler
-and many supporting libraries. See the Developer's Guide at
-wireshark-developers-guide-url:[] for more information.
+Building Wireshark requires the proper build environment including a
+compiler and many supporting libraries. See the Developer's Guide at
+{wireshark-developers-guide-url} for more information.
Use the following general steps to build Wireshark from source under UNIX or Linux:
@@ -428,10 +430,10 @@ We strongly recommended that you use the binary installer for Windows unless you
want to start developing Wireshark on the Windows platform.
For further information how to build Wireshark for Windows from the sources
-see the Developer's Guide at wireshark-developers-guide-url:[]
+see the Developer's Guide at {wireshark-developers-guide-url}.
You may also want to have a look at the Development Wiki
-(wireshark-wiki-site:[]Development) for the latest available development
+({wireshark-wiki-url}Development) for the latest available development
documentation.
++++++++++++++++++++++++++++++++++++++
diff --git a/docbook/wsug_src/WSUG_chapter_capture.asciidoc b/docbook/wsug_src/WSUG_chapter_capture.asciidoc
index e1f4146fcf..7b65a8b35c 100644
--- a/docbook/wsug_src/WSUG_chapter_capture.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_capture.asciidoc
@@ -38,9 +38,9 @@ The capture engine still lacks the following features:
=== Prerequisites
-Setting up Wireshark to capture packets for the first time can be tricky. A
-comprehensive guide ``How To setup a Capture'' is available at
-link:wireshark-wiki-site:[]CaptureSetup[wireshark-wiki-site:[]CaptureSetup].
+Setting up Wireshark to capture packets for the first time can be
+tricky. A comprehensive guide ``How To setup a Capture'' is available at
+{wireshark-wiki-url}CaptureSetup.
Here are some common pitfalls:
@@ -247,7 +247,7 @@ $ echo 1 >/proc/sys/net/core/bpf_jit_enable
----
if it is not enabled already. To make the change persistent you can use
-link:sysfs-web-site:[][sysfsutils].
+link:{sysfs-main-url}[sysfsutils].
====
_Manage Interfaces_::
@@ -272,11 +272,11 @@ _Use multiple files_::
Instead of using a single file Wireshark will automatically switch to a new
one if a specific trigger condition is reached.
-_Use pcap-ng format_::
-This checkbox allows you to specify that Wireshark saves the captured packets in
-pcap-ng format. This next generation capture file format is currently in
-development. If more than one interface is chosen for capturing, this checkbox
-is set by default. See link:wireshark-wiki-site:[]Development/PcapNg[wireshark-wiki-site:[]Development/PcapNg] for more details on
+_Use pcap-ng format_:: This checkbox allows you to specify that
+Wireshark saves the captured packets in pcap-ng format. This next
+generation capture file format is currently in development. If more than
+one interface is chosen for capturing, this checkbox is set by default.
+See {wireshark-wiki-url}Development/PcapNg for more details on
pcap-ng.
_Next file every n megabyte(s)_::
@@ -392,7 +392,7 @@ If some other process has put the interface in promiscuous mode you may be
capturing in promiscuous mode even if you turn off this option.
Even in promiscuous mode you still won't necessarily see all packets on your LAN
-segment. See link:wireshark-faq-url:[]#promiscsniff[the Wireshark FAQ] for more information.
+segment. See link:{wireshark-faq-url}#promiscsniff[the Wireshark FAQ] for more information.
====
_Limit each packet to n bytes_::
@@ -533,11 +533,11 @@ This dialog and capability is only available on Microsoft Windows. On Linux/Unix
you can achieve the same effect (securely) through an SSH tunnel.
====
-The Remote Packet Capture Protocol service must first be running on the target
-platform before Wireshark can connect to it. The easiest way is to install
-WinPcap from link:winpcap-download-page:[][winpcap-download-page:[]] on the target. Once
-installation is completed go to the Services control panel, find the Remote
-Packet Capture Protocol service and start it.
+The Remote Packet Capture Protocol service must first be running on the
+target platform before Wireshark can connect to it. The easiest way is
+to install WinPcap from {winpcap-download-url} on the target. Once
+installation is completed go to the Services control panel, find the
+Remote Packet Capture Protocol service and start it.
[NOTE]
====
@@ -742,11 +742,10 @@ to be read by an application that doesn't support SunATM headers, select ``RFC
=== Filtering while capturing
-Wireshark uses the libpcap filter language for capture filters. A brief overview
-of the syntax follows. Complete documentation can be found in the
-link:pcap-filter-man-page-url:[][pcap-filter man page]. You can find a lot of
-Capture Filter examples at
-link:wireshark-wiki-site:[]CaptureFilters[wireshark-wiki-site:[]CaptureFilters].
+Wireshark uses the libpcap filter language for capture filters. A brief
+overview of the syntax follows. Complete documentation can be found in
+the link:{pcap-filter-man-page-url}[pcap-filter man page]. You can find
+a lot of Capture Filter examples at {wireshark-wiki-url}CaptureFilters.
You enter the capture filter into the ``Filter'' field of the Wireshark
``Capture Options'' dialog box, as shown in <<ChCapCaptureOptionsDialog>>.
@@ -839,10 +838,10 @@ _ether|ip broadcast|multicast_::
This primitive allows you to filter on either Ethernet or IP broadcasts or
multicasts.
-_&lt;expr&gt; relop &lt;expr&gt;_::
-This primitive allows you to create complex filter expressions that select bytes
-or ranges of bytes in packets. Please see the pcap-filter man page at
-link:pcap-filter-man-page-url:[][pcap-filter-man-page-url:[]] for more details.
+_&lt;expr&gt; relop &lt;expr&gt;_:: This primitive allows you to create
+complex filter expressions that select bytes or ranges of bytes in
+packets. Please see the pcap-filter man page at
+{pcap-filter-man-page-url} for more details.
[[ChCapCaptureAutoFilterSection]]
@@ -912,7 +911,7 @@ dialog'' option in the Capture Options dialog box.
A running capture session will be stopped in one of the following ways:
-. Using the button:[Stop[ button from the ``Capture Info'' dialog box.
+. Using the button:[Stop] button from the ``Capture Info'' dialog box.
[NOTE]
====
diff --git a/docbook/wsug_src/WSUG_chapter_customize.asciidoc b/docbook/wsug_src/WSUG_chapter_customize.asciidoc
index d855405798..97d35f1cc0 100644
--- a/docbook/wsug_src/WSUG_chapter_customize.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_customize.asciidoc
@@ -456,17 +456,18 @@ result in a window that updates in semi-real time.
=== Packet colorization
-A very useful mechanism available in Wireshark is packet colorization. You can
-set up Wireshark so that it will colorize packets according to a display filter.
-This allows you to emphasize the packets you might be interested in.
-
-You can find a lot of coloring rule examples at the _Wireshark Wiki Coloring
-Rules page_ at
-link:wireshark-wiki-site:[]ColoringRules[wireshark-wiki-site:[]ColoringRules].
-
-There are two types of coloring rules in Wireshark: temporary rules that are
-only in effect until you quit the program, and permanent rules that are saved
-in a preference file so that they are available the next time you run Wireshark.
+A very useful mechanism available in Wireshark is packet colorization.
+You can set up Wireshark so that it will colorize packets according to a
+display filter. This allows you to emphasize the packets you might be
+interested in.
+
+You can find a lot of coloring rule examples at the _Wireshark Wiki
+Coloring Rules page_ at {wireshark-wiki-url}ColoringRules.
+
+There are two types of coloring rules in Wireshark: temporary rules that
+are only in effect until you quit the program, and permanent rules that
+are saved in a preference file so that they are available the next time
+you run Wireshark.
Temporary rules can be added by selecting a packet and pressing the kbd:[Ctrl]
key together with one of the number keys. This will create a coloring rule based
diff --git a/docbook/wsug_src/WSUG_chapter_introduction.asciidoc b/docbook/wsug_src/WSUG_chapter_introduction.asciidoc
index 67a9cf2747..409ccd7925 100644
--- a/docbook/wsug_src/WSUG_chapter_introduction.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_introduction.asciidoc
@@ -82,11 +82,11 @@ image::wsug_graphics/ws-main.png[{screenshot-attrs}]
==== Live capture from many different network media
-Wireshark can capture traffic from many different network media types - and
-despite its name - including wireless LAN as well. Which media types are
-supported, depends on many things like the operating system you are using. An
-overview of the supported media types can be found at
-wireshark-wiki-site:[]CaptureSetup/NetworkMedia[].
+Wireshark can capture traffic from many different network media types -
+and despite its name - including wireless LAN as well. Which media types
+are supported, depends on many things like the operating system you are
+using. An overview of the supported media types can be found at
+link:{wireshark-wiki-url}CaptureSetup/NetworkMedia[].
==== Import files from many other capture programs
@@ -106,7 +106,7 @@ for a great many protocols: see <<AppProtocols>>.
==== Open Source Software
Wireshark is an open source software project, and is released under the
-gpl-url:[][GNU General Public License] (GPL). You can freely use
+{gplv2-url}[GNU General Public License] (GPL). You can freely use
Wireshark on any number of computers you like, without worrying about license
keys or fees or such. In addition, all source code is freely available under the
GPL. Because of that, it is very easy for people to add new protocols to
@@ -146,7 +146,7 @@ space is always a good idea.
====
If Wireshark runs out of memory it will crash. See
-wireshark-wiki-site:[]KnownBugs/OutOfMemory[] for details and workarounds.
+{wireshark-wiki-url}KnownBugs/OutOfMemory for details and workarounds.
Although Wireshark captures packets using a separate process the main interface
is single-threaded and won't benefit much from multi-core systems.
@@ -171,15 +171,15 @@ is single-threaded and won't benefit much from multi-core systems.
* A supported network card for capturing
- Ethernet. Any card supported by Windows should work. See the wiki pages on
- wireshark-wiki-site:[]CaptureSetup/Ethernet[Ethernet capture] and
- wireshark-wiki-site:[]CaptureSetup/Offloading[offloading] for issues that
+ link:{wireshark-wiki-url}CaptureSetup/Ethernet[Ethernet capture] and
+ link:{wireshark-wiki-url}CaptureSetup/Offloading[offloading] for issues that
may affect your environment.
- - 802.11. See the wireshark-wiki-site:[]CaptureSetup/WLAN#Windows[Wireshark
+ - 802.11. See the {wireshark-wiki-url}CaptureSetup/WLAN#Windows[Wireshark
wiki page]. Capturing raw 802.11 information may be difficult without
special equipment.
- - Other media. See wireshark-wiki-site:[]CaptureSetup/NetworkMedia[]
+ - Other media. See link:{wireshark-wiki-url}CaptureSetup/NetworkMedia[].
Older versions of Windows which are outside Microsoft's extended lifecycle
support window are no longer supported. It is often difficult or impossible to
@@ -188,20 +188,19 @@ party libraries on which we depend or due to necessary features that are only
present in newer versions of Windows (such as hardened security or memory
management).
-Wireshark 1.12 was the last release branch to support Windows Server 2003.
-Wireshark 1.10 was the last branch to officially support Windows XP.
-See the
-wireshark-wiki-site:[]Development/LifeCycle[Wireshark release lifecycle] page
-for more details.
+Wireshark 1.12 was the last release branch to support Windows Server
+2003. Wireshark 1.10 was the last branch to officially support Windows
+XP. See the link:{wireshark-wiki-url}Development/LifeCycle[Wireshark
+release lifecycle] page for more details.
==== UNIX / Linux
Wireshark runs on most UNIX and UNIX-like platforms including OS X and
-Linux. The system requirements should be comparable to the Windows values listed
-above.
+Linux. The system requirements should be comparable to the Windows
+values listed above.
-Binary packages are available for most Unices and Linux distributions including
-the following platforms:
+Binary packages are available for most Unices and Linux distributions
+including the following platforms:
* Apple OS X
@@ -227,18 +226,18 @@ the following platforms:
* Canonical Ubuntu
-If a binary package is not available for your platform you can download the
-source and try to build it. Please report your experiences to
-mailto:wireshark-dev-list-email:[][wireshark-dev-list-email:[]].
+If a binary package is not available for your platform you can download
+the source and try to build it. Please report your experiences to
+mailto:{wireshark-dev-list-email}[].
[[ChIntroDownload]]
=== Where to get Wireshark
You can get the latest copy of the program from the Wireshark website at
-wireshark-download-page:[][wireshark-download-page:[]]. The download page should
-automatically highlight the appropriate download for your platform and direct you
-to the nearest mirror. Official Windows and OS X installers are signed by
+{wireshark-download-url}. The download page should automatically
+highlight the appropriate download for your platform and direct you to
+the nearest mirror. Official Windows and OS X installers are signed by
the *Wireshark Foundation*.
A new Wireshark version typically becomes available each month or two.
@@ -293,14 +292,14 @@ Wireshark was initially developed by Gerald Combs. Ongoing development and
maintenance of Wireshark is handled by the Wireshark team, a loose group of
individuals who fix bugs and provide new functionality.
-There have also been a large number of people who have contributed protocol
-dissectors to Wireshark, and it is expected that this will continue. You can
-find a list of the people who have contributed code to Wireshark by checking the
-about dialog box of Wireshark, or at the wireshark-authors-url:[][authors] page
-on the Wireshark web site.
+There have also been a large number of people who have contributed
+protocol dissectors to Wireshark, and it is expected that this will
+continue. You can find a list of the people who have contributed code to
+Wireshark by checking the about dialog box of Wireshark, or at the
+link:{wireshark-authors-url}[authors] page on the Wireshark web site.
Wireshark is an open source software project, and is released under the
-gpl-url:[][GNU General Public License] (GPL) version 2. All source code is
+{gplv2-url}[GNU General Public License] (GPL) version 2. All source code is
freely available under the GPL. You are welcome to modify Wireshark to suit your
own needs, and it would be appreciated if you contribute your improvements back
to the Wireshark team.
@@ -321,9 +320,9 @@ You gain three benefits by contributing your improvements back to the community:
(which is done often), you can get a new Wireshark version from the website
and your changes will already be included without any effort for you.
-The Wireshark source code and binary kits for some platforms are all available
-on the download page of the Wireshark website:
-wireshark-download-page:[][wireshark-download-page:[]].
+The Wireshark source code and binary kits for some platforms are all
+available on the download page of the Wireshark website:
+{wireshark-download-url}.
[[ChIntroHelp]]
@@ -337,13 +336,13 @@ may be of interest to you (well, besides this guide of course).
==== Website
You will find lots of useful information on the Wireshark homepage at
-wireshark-web-site:[][wireshark-web-site:[]].
+{wireshark-main-url}.
[[ChIntroWiki]]
==== Wiki
-The Wireshark Wiki at wireshark-wiki-site:[][wireshark-wiki-site:[]] provides a
+The Wireshark Wiki at {wireshark-wiki-url} provides a
wide range of information related to Wireshark and packet capture in general.
You will find a lot of information not part of this user's guide. For example,
there is an explanation how to capture on a switched network, an ongoing effort
@@ -357,11 +356,12 @@ simply using your web browser.
==== Q&amp;A Site
-The Wireshark Q&amp;A site at wireshark-qa-url:[][wireshark-qa-url:[]] offers a
-resource where questions and answers come together. You have the option to
-search what questions were asked before and what answers were given by people
-who knew about the issue. Answers are graded, so you can pick out the best ones
-easily. If your question hasn't been discussed before you can post one yourself.
+The Wireshark Q&amp;A site at {wireshark-qa-url} offers a resource where
+questions and answers come together. You have the option to search what
+questions were asked before and what answers were given by people who
+knew about the issue. Answers are graded, so you can pick out the best
+ones easily. If your question hasn't been discussed before you can post
+one yourself.
[[ChIntroFAQ]]
@@ -382,10 +382,9 @@ mailing lists.
You will find the FAQ inside Wireshark by clicking the menu item Help/Contents
and selecting the FAQ page in the dialog shown.
-An online version is available at the Wireshark website:
-link:$$wireshark-faq-url:[]$$[wireshark-faq-url:[]]. You might prefer this
-online version, as it's typically more up to date and the HTML format is easier
-to use.
+An online version is available at the Wireshark website at
+{wireshark-faq-url}. You might prefer this online version, as it's
+typically more up to date and the HTML format is easier to use.
[[ChIntroMailingLists]]
@@ -406,10 +405,10 @@ _wireshark-dev_::
developing a protocol dissector, join this list.
You can subscribe to each of these lists from the Wireshark web site:
-wireshark-mailing-lists-url:[][wireshark-mailing-lists-url:[]]. From
-there, you can choose which mailing list you want to subscribe to by clicking on
-the Subscribe/Unsubscribe/Options button under the title of the relevant list.
-The links to the archives are included on that page as well.
+{wireshark-mailing-lists-url}. From there, you can choose which mailing
+list you want to subscribe to by clicking on the
+Subscribe/Unsubscribe/Options button under the title of the relevant
+list. The links to the archives are included on that page as well.
[TIP]
.The lists are archived
@@ -476,15 +475,14 @@ backtrace
If you do not have `gdb` available, you will have to check out your operating system's debugger.
-Mail `backtrace.txt` to
-mailto:wireshark-dev-list-email:[][wireshark-dev-list-email:[]].
+Mail `backtrace.txt` to mailto:{wireshark-dev-list-email}[].
==== Reporting Crashes on Windows platforms
The Windows distributions don't contain the symbol files (.pdb) because they are
very large. You can download them separately at
-wireshark-web-site:[]download/win32/all-versions[] and
-wireshark-web-site:[]download/win64/all-versions[]
+{wireshark-main-url}download/win32/all-versions/ and
+{wireshark-main-url}download/win64/all-versions/ .
++++++++++++++++++++++++++++++++++++++
<!-- End of WSUG Chapter 1 -->
diff --git a/docbook/wsug_src/WSUG_chapter_statistics.asciidoc b/docbook/wsug_src/WSUG_chapter_statistics.asciidoc
index daa00ca62b..d2ea5f382a 100644
--- a/docbook/wsug_src/WSUG_chapter_statistics.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_statistics.asciidoc
@@ -467,8 +467,8 @@ The protocol specific statistics windows display detailed information of
specific protocols and might be described in a later version of this document.
Some of these statistics are described at
-wireshark-wiki-site:[]Statistics.
+{wireshark-wiki-url}Statistics.
++++++++++++++++++++++++++++++++++++++
<!-- End of WSUG Chapter Statistics -->
-++++++++++++++++++++++++++++++++++++++ \ No newline at end of file
+++++++++++++++++++++++++++++++++++++++
diff --git a/docbook/wsug_src/WSUG_chapter_telephony.asciidoc b/docbook/wsug_src/WSUG_chapter_telephony.asciidoc
index 0023052968..ce3fe51c66 100644
--- a/docbook/wsug_src/WSUG_chapter_telephony.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_telephony.asciidoc
@@ -52,8 +52,7 @@ streams of a selected IAX2 call along with a graph.
The VoIP Calls window shows a list of all detected VoIP calls in the captured
traffic. It finds calls by their signaling.
-More details can be found on the
-link:wireshark-wiki-site:[]VoIP_calls[wireshark-wiki-site:[]VoIP_calls] page.
+More details can be found on the {wireshark-wiki-url}VoIP_calls page.
[[ChTelRtpPlayer]]
@@ -62,7 +61,7 @@ this feature your version of Wireshark must support audio and the codecs
used by each RTP stream.
More details can be found on the
-link:wireshark-wiki-site:[]VoIP_calls[wireshark-wiki-site:[]VoIP_calls] page.
+{wireshark-wiki-url}VoIP_calls page.
[[ChTelLTEMACTraffic]]
@@ -109,7 +108,7 @@ The protocol specific statistics windows display detailed information of
specific protocols and might be described in a later version of this document.
Some of these statistics are described at the
-link:wireshark-wiki-site:[]Statistics[wireshark-wiki-site:[]Statistics] pages.
+{wireshark-wiki-url}Statistics pages.
++++++++++++++++++++++++++++++++++++++
<!-- End of WSUG Chapter Telephony -->
diff --git a/docbook/wsug_src/WSUG_chapter_use.asciidoc b/docbook/wsug_src/WSUG_chapter_use.asciidoc
index a17f5c7c92..157a353e67 100644
--- a/docbook/wsug_src/WSUG_chapter_use.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_use.asciidoc
@@ -529,7 +529,7 @@ image::wsug_graphics/ws-analyze-menu.png[{screenshot-attrs}]
|menu:User Specified Decodes...[] ||This menu item allows the user to force Wireshark to decode certain packets as a particular protocol, see <<ChAdvDecodeAsShow>>
|menu:Follow TCP Stream[] ||This menu item brings up a separate window and displays all the TCP segments captured that are on the same TCP connection as a selected packet, see <<ChAdvFollowTCPSection>>
|menu:Follow UDP Stream[] ||Same functionality as ``Follow TCP Stream'' but for UDP streams.
-|menu:Follow SSL Stream[] ||Same functionality as ``Follow TCP Stream'' but for SSL streams. See the wiki page on wireshark-wiki-site:[]SSL[SSL] for instructions on providing SSL keys.
+|menu:Follow SSL Stream[] ||Same functionality as ``Follow TCP Stream'' but for SSL streams. See the wiki page on link:{wireshark-wiki-url}SSL[SSL] for instructions on providing SSL keys.
|menu:Expert Info[] ||Open a dialog showing some expert information about the captured packets. The amount of information will depend on the protocol and varies from very detailed to non-existent. XXX - add a new section about this and link from here
|menu:Conversation Filter[...] ||In this menu you will find conversation filter for various protocols.
|===============
@@ -667,11 +667,11 @@ image::wsug_graphics/ws-help-menu.png[{screenshot-attrs}]
|Menu Item|Accelerator|Description
|menu:Contents[]|F1| This menu item brings up a basic help system.
|menu:Manual Pages[...]|| This menu item starts a Web browser showing one of the locally installed html manual pages.
-|menu:Website[]|| This menu item starts a Web browser showing the webpage from: link:$$wireshark-web-site:[]$$[wireshark-web-site:[]].
+|menu:Website[]|| This menu item starts a Web browser showing the webpage from: link:{wireshark-main-url}[].
|menu:FAQ's[]|| This menu item starts a Web browser showing various FAQ's.
-|menu:Downloads[]|| This menu item starts a Web browser showing the downloads from: link:$$wireshark-web-site:[]$$[wireshark-web-site:[]].
-|menu:Wiki[]|| This menu item starts a Web browser showing the front page from: link:$$wireshark-wiki-site:[]$$[wireshark-wiki-site:[]].
-|menu:Sample Captures[]|| This menu item starts a Web browser showing the sample captures from: link:$$wireshark-wiki-site:[]$$[wireshark-wiki-site:[]].
+|menu:Downloads[]|| This menu item starts a Web browser showing the downloads from: link:{wireshark-download-url}[].
+|menu:Wiki[]|| This menu item starts a Web browser showing the front page from: link:{wireshark-wiki-url}[].
+|menu:Sample Captures[]|| This menu item starts a Web browser showing the sample captures from: link:{wireshark-wiki-url}SampleCaptures[].
|menu:About Wireshark[]|| This menu item brings up an information window that provides various detailed information items on Wireshark, such as how it's build, the plugins loaded, the used folders, ...
|===============
diff --git a/docbook/wsug_src/WSUG_chapter_work.asciidoc b/docbook/wsug_src/WSUG_chapter_work.asciidoc
index 59e388ed99..22713256c3 100644
--- a/docbook/wsug_src/WSUG_chapter_work.asciidoc
+++ b/docbook/wsug_src/WSUG_chapter_work.asciidoc
@@ -255,7 +255,7 @@ sections provide more information on doing this.
[TIP]
====
You will find a lot of Display Filter examples at the _Wireshark Wiki Display
-Filter page_ at: wireshark-wiki-site:[]DisplayFilters.
+Filter page_ at: link:{wireshark-wiki-url}DisplayFilters[].
====
==== Display filter fields
diff --git a/docbook/wsug_src/WSUG_preface.asciidoc b/docbook/wsug_src/WSUG_preface.asciidoc
index 3b00a89380..507a9203f4 100644
--- a/docbook/wsug_src/WSUG_preface.asciidoc
+++ b/docbook/wsug_src/WSUG_preface.asciidoc
@@ -25,10 +25,10 @@ This book will explain all the basics and also some of the advanced features
that Wireshark provides. As Wireshark has become a very complex program since
the early days, not every feature of Wireshark may be explained in this book.
-This book is not intended to explain network sniffing in general and it will not
-provide details about specific network protocols. A lot of useful information
-regarding these topics can be found at the Wireshark Wiki at
-wireshark-wiki-site:[][wireshark-wiki-site:[]]
+This book is not intended to explain network sniffing in general and it
+will not provide details about specific network protocols. A lot of
+useful information regarding these topics can be found at the Wireshark
+Wiki at link:{wireshark-wiki-url}[].
By reading this book, you will learn how to install Wireshark, how to use the
basic elements of the graphical user interface (such as the menu) and what's
@@ -71,12 +71,13 @@ Wireshark project from who sections of this document borrow heavily:
=== About this document
-This book was originally developed by mailto:wsug-author-email2:[][Richard
+This book was originally developed by mailto:{wsug-author-email2}[Richard
Sharpe] with funds provided from the Wireshark Fund. It was updated by
-mailto:wsug-author-email3:[][Ed Warnicke] and more recently redesigned and
-updated by mailto:wsug-author-email:[][Ulf Lamping].
+mailto:{wsug-author-email3}[Ed Warnicke] and more recently redesigned and
+updated by mailto:{wsug-author-email}[Ulf Lamping].
-It was originally written in DocBook/XML and converted to AsciiDoc by Gerald Combs.
+It was originally written in DocBook/XML and converted to AsciiDoc by
+Gerald Combs.
You will find some specially marked parts in this book:
@@ -102,11 +103,12 @@ Tips are helpful for your everyday work using Wireshark.
=== Where to get the latest copy of this document?
-The latest copy of this documentation can always be found at wireshark-users-guide-url:[][].
+The latest copy of this documentation can always be found at
+{wireshark-users-guide-url}.
[[PreFeedback]]
=== Providing feedback about this document
-Should you have any feedback about this document, please send it to the authors
-through mailto:wireshark-dev-list-email:[][wireshark-dev-list-email:[]].
+Should you have any feedback about this document, please send it to the
+authors through mailto:{wireshark-dev-list-email}[].