diff options
| author | Gerald Combs <gerald@wireshark.org> | 2016-11-01 14:35:29 -0700 |
|---|---|---|
| committer | Gerald Combs <gerald@wireshark.org> | 2016-11-11 17:18:25 +0000 |
| commit | 65ab2a97018877ec3a8664d7422c3ee4662e97ca (patch) | |
| tree | f6068d14ae9493c400eca66019dedbb76a2c42f4 /docbook | |
| parent | aba4d3a3a7d8c7f97290621085a8fb7a33942847 (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')
26 files changed, 346 insertions, 302 deletions
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt index 5138e8422a..0ad3b33d51 100644 --- a/docbook/CMakeLists.txt +++ b/docbook/CMakeLists.txt @@ -308,7 +308,11 @@ set( WSDG_BUILT_DEPS ws.css wsluarm ) if(ENABLE_HTML_GUIDES OR ENABLE_PDF_GUIDES OR ENABLE_CHM_GUIDES) # Generate the DocBook sources of user and developer guides - set( ASCIIDOC_CONF_FILES asciidoc.conf asciidoctor-asciidoc.conf ) + set( ASCIIDOC_CONF_FILES + asciidoc.conf + asciidoctor-asciidoc.conf + attributes.asciidoc + ) ASCIIDOC2DOCBOOK(user-guide.asciidoc ASCIIDOC_CONF_FILES WSUG_SOURCE WSUG_BUILT_DEPS) add_custom_target(user_guide_docbook DEPENDS generate_user-guide.xml) diff --git a/docbook/Makefile.am b/docbook/Makefile.am index 86c8e73467..f0faba8e89 100644 --- a/docbook/Makefile.am +++ b/docbook/Makefile.am @@ -221,6 +221,7 @@ COMMON_GRAPHICS = \ # user-guide.xml must be first in the list (to match $<) WSUG_DIST = \ user-guide.asciidoc \ + attributes.asciidoc \ GPL_appendix.asciidoc \ custom_layer_chm.xsl \ custom_layer_pdf.xsl \ @@ -233,6 +234,7 @@ WSUG_SOURCE = $(WSUG_GENERATED_SOURCE) $(WSUG_DIST) # developer-guide.asciidoc must be first in the list (to match $<) WSDG_DIST = \ developer-guide.asciidoc \ + attributes.asciidoc \ GPL_appendix.asciidoc \ custom_layer_chm.xsl \ custom_layer_pdf.xsl \ @@ -244,6 +246,7 @@ WSDG_SOURCE = $(WSDG_GENERATED_SOURCE) $(WSDG_DIST) RELEASE_NOTES_SOURCE = \ release-notes.asciidoc \ + attributes.asciidoc \ asciidoc.conf \ asciidoctor-asciidoc.conf diff --git a/docbook/README.txt b/docbook/README.txt index 83664ffc41..deb7b7ad42 100644 --- a/docbook/README.txt +++ b/docbook/README.txt @@ -13,7 +13,8 @@ Requirements are listed below. The guides and release notes are written in AsciiDoc (http://asciidoc.org), but use many Asciidoctor (http://asciidoctor.org/) markup extensions which are provided in asciidoctor-asciidoc.conf. The documentation toolchain may -switch exclusively to Asciidoctor at some point in the future. +switch exclusively to Asciidoctor at some point in the future. See the +AsciiDoctor section at the end of this document for details. To get HTML, PDF or other output formats, conversions are done using XSL stylesheets, which provides a flexible way for these conversions. @@ -244,3 +245,20 @@ Using the prefix wsdg_ instead of wsug_ will build the same targets but for the Wireshark Developer's Guide. The makefile is written to be run with make on UNIX/Linux platforms. + +AsciiDoctor +----------- + +At the time of this writing (November 2016) the AsciiDoctor project is much +more active than AsciiDoc. At some point it might be worth the effort to +migrate to AsciiDoctor. To do so we'd have to do the following at a minimum: + +- Require Ruby + AsciiDoctor or Java + AsciiDoctorj to build the documentation. + +- Either port the macros in asciidoc.conf to AsciiDoctor or stop using them. + +- Restrict ourselves to decimal entities since the PDF renderer doesn't + support hexadecimal ones: + https://github.com/asciidoctor/asciidoctorj/issues/439 + +- Choose a "compat" mode: http://asciidoctor.org/docs/migration/
\ No newline at end of file diff --git a/docbook/asciidoc.conf b/docbook/asciidoc.conf index c658adc399..0c3608c464 100644 --- a/docbook/asciidoc.conf +++ b/docbook/asciidoc.conf @@ -2,67 +2,11 @@ [attributes] -wireshark-version=2.3.0 - -# "scaledwidth" only applies to PDF output -pdf-scaledwidth=scaledwidth="85%" -screenshot-attrs=scaledwidth="85%" -small-screenshot-attrs=scaledwidth="35%" -toolbar-icon-attrs=height=24,width=24 -related-attrs=height=18 -# XXX height=22 results in content-height="22px" in the .fo file. Not sure -# how to make scaledwidth take precedence. -statusbar-attrs=scaledwidth="85%",height=22 +# Moved to attributes.asciidoc [replacements] -# Most of these are fake macros. -# We should probably replace some or all of them with attributes. - -wireshark-authors-url:\[\]=https://www.wireshark.org/about.html#authors -wireshark-bugs-site:\[\]=https://bugs.wireshark.org/ -wireshark-code-browse-url:\[\]=https://code.wireshark.org/review/gitweb?p=wireshark.git -wireshark-code-review-url:\[\]=https://code.wireshark.org/review -wireshark-dev-list-email:\[\]=wireshark-dev[AT]wireshark.org -wireshark-developers-guide-url:\[\]=https://www.wireshark.org/docs/ -wireshark-download-page:\[\]=https://www.wireshark.org/download.html -wireshark-display-filter-reference:\[\]=https://www.wireshark.org/docs/dfref/ -wireshark-man-page-reference:\[\]=https://www.wireshark.org/docs/man-pages/ -wireshark-faq-url:\[\]=https://www.wireshark.org/faq.html -wireshark-git-anonhttp-url:\[\]=https://code.wireshark.org/review/wireshark -wireshark-git-http-url:\[\]=https://your.username@code.wireshark.org/review/wireshark -wireshark-git-ssh-url:\[\]=ssh://your.username@code.wireshark.org:29418/wireshark -wireshark-buildbot-url:\[\]=https://buildbot.wireshark.org/trunk/waterfall -wireshark-mailing-lists-url:\[\]=https://www.wireshark.org/lists/ -wireshark-qa-url:\[\]=https://ask.wireshark.org/ -wireshark-snapshots-url:\[\]=https://www.wireshark.org/download/automated/src/ -wireshark-users-guide-url:\[\]=https://www.wireshark.org/docs/ -wireshark-web-site:\[\]=https://www.wireshark.org/ -wireshark-wiki-site:\[\]=https://wiki.wireshark.org/ - -tcpdump-web-site:\[\]=http://www.tcpdump.org/ -tcpdump-man-page-url:\[\]=http://www.tcpdump.org/manpages/tcpdump.1.html -pcap-filter-man-page-url:\[\]=http://www.tcpdump.org/manpages/pcap-filter.7.html - -winpcap-web-site:\[\]=https://www.winpcap.org/ -winpcap-download-page:\[\]=https://www.winpcap.org/install/ - -wikipedia-web-site:\[\]=https://en.wikipedia.org/wiki/ -sysfs-web-site:\[\]=http://linux-diag.sourceforge.net/Sysfsutils.html -greenwichmeantime-web-site:\[\]=http://wwp.greenwichmeantime.com/ -timeanddate-web-site:\[\]=http://www.timeanddate.com/worldclock/ -ntp-web-site:\[\]=http://www.ntp.org/ - -# Make a document attribute after we fully convert to AsciiDoc -wsdg-author-email:\[\]=ulf.lamping[AT]web.de -wsdg-author-email2:\[\]=graham.bloice[AT]trihedral.com - -wsug-author-email:\[\]=ulf.lamping[AT]web.de -wsug-author-email2:\[\]=rsharpe[AT]ns.aus.com -wsug-author-email3:\[\]=hagbard[AT]physics.rutgers.edu -wsug-author-email4:\[\]=luis[AT]ontanon.org - -gpl-url:\[\]=https://www.gnu.org/licenses/gpl-2.0.html +# Moved to attributes.asciidoc [macros] diff --git a/docbook/attributes.asciidoc b/docbook/attributes.asciidoc new file mode 100644 index 0000000000..bc5e776604 --- /dev/null +++ b/docbook/attributes.asciidoc @@ -0,0 +1,71 @@ +// Common attributes + +:wireshark-version: 2.3.0 + +// +// URLs +// + +// Wireshark top level URLs (sites) +:wireshark-main-url: https://www.wireshark.org/ +:wireshark-bugs-url: https://bugs.wireshark.org/ +:wireshark-code-review-url: https://code.wireshark.org/review +:wireshark-qa-url: https://ask.wireshark.org/ +:wireshark-wiki-url: https://wiki.wireshark.org/ + +// Wireshark secondary URLs (pages) +:wireshark-authors-url: {wireshark-main-url}about.html#authors +:wireshark-buildbot-url: https://buildbot.wireshark.org/trunk/waterfall +:wireshark-code-browse-url: {wireshark-code-review-url}/gitweb?p=wireshark.git +:wireshark-developers-guide-url: {wireshark-main-url}docs/ +:wireshark-display-filter-reference-url: {wireshark-main-url}docs/dfref/ +:wireshark-download-url: {wireshark-main-url}download.html +:wireshark-faq-url: {wireshark-main-url}faq.html +:wireshark-git-anonhttp-url: {wireshark-code-review-url}/wireshark +:wireshark-git-http-url: https://your.username@code.wireshark.org/review/wireshark +:wireshark-git-ssh-url: ssh://your.username@code.wireshark.org:29418/wireshark +:wireshark-mailing-lists-url: {wireshark-main-url}lists/ +:wireshark-man-page-url: {wireshark-main-url}docs/man-pages/ +:wireshark-snapshots-url: {wireshark-main-url}download/automated/src/ +:wireshark-users-guide-url: {wireshark-main-url}docs/ + +// External URLs +:tcpdump-main-url: http://www.tcpdump.org/ +:pcap-filter-man-page-url: {tcpdump-main-url}manpages/pcap-filter.7.html + +:winpcap-main-url: https://www.winpcap.org/ +:winpcap-download-url: {winpcap-main-url}install/ + +:sysfs-main-url: http://linux-diag.sourceforge.net/Sysfsutils.html +:wikipedia-main-url: https://en.wikipedia.org/wiki/ + +:greenwichmeantime-main-url: http://wwp.greenwichmeantime.com/ +:timeanddate-main-url: http://www.timeanddate.com/worldclock/ +:ntp-main-url: http://www.ntp.org/ + +:gplv2-url: https://www.gnu.org/licenses/gpl-2.0.html + +// Email addresses +:at-separator: [AT] +:wireshark-dev-list-email: wireshark-dev{at-separator}wireshark.org +:wsdg-author-email: ulf.lamping{at-separator}web.de +:wsdg-author-email2: graham.bloice{at-separator}trihedral.com + +:wsug-author-email: ulf.lamping{at-separator}web.de +:wsug-author-email2: rsharpe{at-separator}ns.aus.com +:wsug-author-email3: hagbard{at-separator}physics.rutgers.edu +:wsug-author-email4: luis{at-separator}ontanon.org + +// +// Image formatting +// + +// "scaledwidth" only applies to PDF output +:pdf-scaledwidth: scaledwidth="85%" +:screenshot-attrs: scaledwidth="85%" +:small-screenshot-attrs: scaledwidth="35%" +:toolbar-icon-attrs: height=24,width=24 +:related-attrs: height=18 +// XXX height=22 results in content-height="22px" in the .fo file. Not sure +// how to make scaledwidth take precedence. +:statusbar-attrs: scaledwidth="85%",height=22 diff --git a/docbook/developer-guide.asciidoc b/docbook/developer-guide.asciidoc index 6beb58f92f..d70a9219d7 100644 --- a/docbook/developer-guide.asciidoc +++ b/docbook/developer-guide.asciidoc @@ -1,6 +1,7 @@ = Wireshark Developer's Guide //v1.0, February 2014: Finished conversion from DocBook to AsciiDoc :doctype: book +include::attributes.asciidoc[] [[Preface]] ["preface",id="Preface"] diff --git a/docbook/release-notes.asciidoc b/docbook/release-notes.asciidoc index 8b60376cea..5837bd56b6 100644 --- a/docbook/release-notes.asciidoc +++ b/docbook/release-notes.asciidoc @@ -1,3 +1,5 @@ +include::attributes.asciidoc[] + = Wireshark {wireshark-version} Release Notes // AsciiDoc quick reference: http://powerman.name/doc/asciidoc diff --git a/docbook/user-guide.asciidoc b/docbook/user-guide.asciidoc index ee0c2ccd98..e034a37120 100644 --- a/docbook/user-guide.asciidoc +++ b/docbook/user-guide.asciidoc @@ -1,6 +1,7 @@ = Wireshark User's Guide //v1.0, February 2014: Finished conversion from DocBook to AsciiDoc :doctype: book +include::attributes.asciidoc[] [[Preface]] ["preface",id="Preface"] diff --git a/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc b/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc index d50050851e..df7c1b6eb3 100644 --- a/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_dissection.asciidoc @@ -1178,7 +1178,7 @@ I have also had comments/feedback that this tool would be good for say a CORBA class when teaching students what CORBA traffic looks like ``on the wire''. It is also COOL to work on a great Open Source project such as the case with -``Wireshark'' (link:$$wireshark-web-site:[]$$[wireshark-web-site:[]] ) +``Wireshark'' ({wireshark-main-url}) ==== How to use idl2wrs diff --git a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc index 36a6b0d6cf..14c1bf310b 100644 --- a/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_env_intro.asciidoc @@ -19,7 +19,7 @@ development in general. Well, if you want to start Wireshark development, you might already know what Wireshark is doing. If not, please have a look at the -wireshark-users-guide-url:[][Wireshark User's Guide], +link:{wireshark-users-guide-url}[Wireshark User's Guide], which will provide a lot of general information about it. [[ChIntroPlatforms]] @@ -36,7 +36,7 @@ it's thus available on a wide variety of platforms. If a binary package is not available for your platform, you should download the source and try to build it. Please report your experiences -to mailto:wireshark-dev-list-email:[][wireshark-dev-list-email:[]]. +to mailto:{wireshark-dev-list-email}[]. Binary packages are available for the following platforms along with many others: @@ -109,11 +109,12 @@ Wireshark was initially developed by Gerald Combs. Ongoing development and maintenance of Wireshark is handled by the Wireshark core developers, 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 and other improvements 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 have a look at the -wireshark-authors-url:[] page on the Wireshark web site. +There have also been a large number of people who have contributed +protocol dissectors and other improvements 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 have a look at the {wireshark-authors-url} page on the +Wireshark web site. The communication between the developers is usually done through the developer mailing list, which can be joined by anyone interested in the development @@ -149,7 +150,7 @@ the target system. ==== Open Source Software Wireshark is an open source software (OSS) project, and is released under -the gpl-url:[][GNU General Public License] (GPL). +the link:{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 @@ -180,19 +181,19 @@ community: The Wireshark source code and binary packages for some platforms are all available on the download page of the Wireshark website: -wireshark-download-page:[]. +{wireshark-download-url}. [[ChIntroReleases]] === Releases and distributions -The officially released files can be found at: wireshark-download-page:[]. A new -Wireshark version is released after significant changes compared to the last -release are completed or a serious security issue is encountered. The typical -release schedule is about every 4-8 weeks (although this may vary). -There are two kinds of distributions: binary and source; both have their -advantages and disadvantages. +The officially released files can be found at {wireshark-download-url}. +A new Wireshark version is released after significant changes compared +to the last release are completed or a serious security issue is +encountered. The typical release schedule is about every 4-8 weeks +(although this may vary). There are two kinds of distributions: binary +and source; both have their advantages and disadvantages. [[ChIntroReleaseBinary]] @@ -331,13 +332,13 @@ course). ==== Website You will find lots of useful information on the Wireshark homepage at -wireshark-web-site:[]. +{wireshark-main-url}. [[ChIntroWiki]] ==== Wiki -The Wireshark Wiki at wireshark-wiki-site:[] provides a wide range +The Wireshark Wiki at {wireshark-wiki-url} provides a wide range of information related to Wireshark and packet capturing in general. You will find a lot of information not part of this developer's guide. For example, there is an explanation how to capture on a switched network, @@ -363,9 +364,9 @@ subscribed to the mailing lists. You will find the FAQ inside Wireshark by clicking the menu item Help/Contents and selecting the FAQ page in the upcoming dialog. -An online version is available at the Wireshark website: 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: +{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. [[ChIntroOtherSources]] @@ -424,10 +425,10 @@ repository, join this list. Details about the GIT repository can be found in <<ChSrcGitRepository>>. You can subscribe to each of these lists from the Wireshark web site: -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 archives are searchable @@ -442,19 +443,20 @@ someone answers your question. ==== Bug database (Bugzilla) The Wireshark community collects bug reports in a Bugzilla database at -wireshark-bugs-site:[]. This database is filled with manually filed bug reports, -usually after some discussion on wireshark-dev, and automatic bug reports from -the Buildbot tools. +{wireshark-bugs-url}. This database is filled with manually filed bug +reports, usually after some discussion on wireshark-dev, and automatic +bug reports from the Buildbot tools. [[ChIntroQA]] ==== Q&A Site -The Wireshark Q and A site at wireshark-qa-url:[] offers a resource where +The Wireshark Q&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 -issue isn't discussed before you can post one yourself. +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 issue isn't discussed before you can post one +yourself. [[ChIntroReportProblems]] @@ -543,8 +545,8 @@ If you do not have `gdb` available, you will have to check out your operating system's debugger. ==== -You should mail the traceback to the -mailto:wireshark-dev-list-email:[][wireshark-dev mailing list], or attach it to your bug report. +You should mail the traceback to mailto:{wireshark-dev-list-email}[] or attach it +to your bug report. ==== Reporting Crashes on Windows platforms diff --git a/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc b/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc index ebaeff50a8..24b9658831 100644 --- a/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_libraries.asciidoc @@ -237,7 +237,7 @@ to Wireshark's core functionality. ==== Unix: libpcap If this library isn't already installed or available as a package for your -platform, you can get it at http://www.tcpdump.org/[]. +platform, you can get it at {tcpdump-main-url}. [[ChLibsWinpPcap]] diff --git a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc index a0bd342009..bd8dd1cdb8 100644 --- a/docbook/wsdg_src/WSDG_chapter_sources.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_sources.asciidoc @@ -129,12 +129,12 @@ Age: a few minutes. You can use a Git client to download the source code from Wireshark's code review system. Anyone can clone from the anonymous git URL: -* wireshark-git-anonhttp-url:[] +* {wireshark-git-anonhttp-url} If you create a Gerrit account you can clone from an authenticated URL: -* wireshark-git-ssh-url:[] -* wireshark-git-http-url:[] +* {wireshark-git-ssh-url} +* {wireshark-git-http-url} SSH lets you use Gerrit on the https://code.wireshark.org/review/Documentation/cmd-index.html#_server[command line]. @@ -147,7 +147,7 @@ The following example shows how to get up and running on the command line. See <<ChToolsGit>> for information on installing and configuring graphical Git and Gerrit clients. -. Sign in to wireshark-code-review-url:[] using OpenID (click Register or Sign +. Sign in to {wireshark-code-review-url} using OpenID (click Register or Sign In in the upper right corner of the web page). Follow the login instructions. . In the upper right corner of the web page, click on your account name and @@ -242,11 +242,10 @@ be downloaded. Age: a few minutes (same as anonymous Git access). -The entire source tree of the Git repository is available via -a web interface at wireshark-code-browse-url:[]. You can view each -revision of a particular file, as well as diffs between different -revisions. You can also download individual files but not entire -directories. +The entire source tree of the Git repository is available via a web +interface at {wireshark-code-browse-url}. You can view each revision of +a particular file, as well as diffs between different revisions. You can +also download individual files but not entire directories. [[ChSrcBuildbot]] @@ -259,8 +258,8 @@ possible (e.g. because of a restrictive firewall). Age: some number of minutes (a bit older than the Git access). The Buildbot server will automatically start to generate a snapshot of -Wireshark's source tree after a source code change is committed. -These snapshots can be found at wireshark-snapshots-url:[]. +Wireshark's source tree after a source code change is committed. These +snapshots can be found at {wireshark-snapshots-url}. If Git access isn't possible, e.g. if the connection to the server isn't possible because of a corporate firewall, the sources can be @@ -277,10 +276,10 @@ Recommended for building pristine packages. Age: from days to weeks. -The official source releases can be found at -wireshark-download-page:[]. You should use these sources if you want -to build Wireshark on your platform for with minimal or no changes, -such Linux distribution packages. +The official source releases can be found at {wireshark-download-url}. +You should use these sources if you want to build Wireshark on your +platform for with minimal or no changes, such Linux distribution +packages. The differences between the released sources and the sources in the Git repository will keep on growing until the next release is made. @@ -301,7 +300,7 @@ Git repository. ==== As development evolves, the Wireshark sources are compilable most of the time -- but not always. You should take a look at -wireshark-buildbot-url:[] before fetching or pulling to make +{wireshark-buildbot-url} before fetching or pulling to make sure the builds are in good shape. ==== @@ -447,13 +446,13 @@ be informative when things don't work as expected. ==== Win32 native -During the build all relevant program files are collected in a subdirectory -`run\RelWithDebInfo`. You can run the program from there by +During the build all relevant program files are collected in a +subdirectory `run\RelWithDebInfo`. You can run the program from there by launching the Wireshark.exe executable. -The older GTK based version is also available in the same -subdirectory. You can run the program from there by launching the -wireshark-gtk.exe executable. +The older GTK based version is also available in the same subdirectory. +You can run the program from there by launching the wireshark-gtk.exe +executable. [[ChSrcDebug]] @@ -561,7 +560,7 @@ the following benefits by contributing your improvements: There's no direct way to push changes to the Git repository. Only a few people are authorised to actually make changes to the source code (check-in changed files). If you want to submit your changes, you should upload them to the code -review system at wireshark-code-review-url:[]. This requires you to set up git +review system at {wireshark-code-review-url}. This requires you to set up git as described at <<ChSrcGit>>. [[ChSrcDiffWhat]] @@ -681,7 +680,7 @@ as described at <<ChSrcGit>>. // do a diff, you should // have two source trees on your computer, one with your working copy // (containing your changes), and one with the "official" source tree -// (hopefully the latest SVN files) from wireshark-web-site:[]. +// (hopefully the latest SVN files) from {wireshark-main-url}. // // If you have only changed a single file, you could type something like // this: @@ -816,16 +815,16 @@ You'll take a capture file containing packets affecting your dissector and the fuzz test will randomly change bytes in this file, so that unusual code paths in your dissector are checked. There are tools available to automatically do this on any number of input files, see: -wireshark-wiki-site:[]FuzzTesting[] for details. +{wireshark-wiki-url}FuzzTesting for details. [[ChSrcUpload]] ==== Uploading your changes -When you're satisfied with your changes (and obtained any necessary approval -from your organization) you can upload them for review at -wireshark-code-review-url:[]. This requires a Gerrit Code Review account as -described at <<ChSrcGitRepository>>. +When you're satisfied with your changes (and obtained any necessary +approval from your organization) you can upload them for review at +{wireshark-code-review-url}. This requires a Gerrit Code Review account +as described at <<ChSrcGitRepository>>. Changes should be pushed to a https://code.wireshark.org/review/Documentation/user-upload.html#push_create[magical "refs/for" branch] diff --git a/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc b/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc index c303ff4099..3b213ea4b4 100644 --- a/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_userinterface.asciidoc @@ -147,7 +147,7 @@ it's not strictly required: - An `updateWidgets()` method, which enables and disables widgets depending on the current state and constraints of the dialog. For example, the Coloring - Rules dialog disables the button:[Save] button if the user has entered an + Rules dialog disables the *Save* button if the user has entered an invalid display filter. - A `hintLabel()` widget subclassed from `QLabel` or `ElidedLabel`, placed just above the dialog button box. The hint label provides guidance and feedback to @@ -222,11 +222,13 @@ http://qt-project.org/doc/qt-4.8/linguist-manual.html[its manual]. You can also manage translations online with https://www.transifex.com/projects/p/wireshark/[Transifex]. -Each week translations are automatically synchronized with the source code through the following steps: -* pull ts from Transifex -* lupdate ts file -* push and commit on Gerrit -* push ts on Transifex +Each week translations are automatically synchronized with the source +code through the following steps: + +- pull ts from Transifex +- lupdate ts file +- push and commit on Gerrit +- push ts on Transifex ==== Other Issues and Information diff --git a/docbook/wsdg_src/WSDG_preface.asciidoc b/docbook/wsdg_src/WSDG_preface.asciidoc index cd62147606..21cec67736 100644 --- a/docbook/wsdg_src/WSDG_preface.asciidoc +++ b/docbook/wsdg_src/WSDG_preface.asciidoc @@ -6,19 +6,19 @@ === Foreword -This book tries to give you a guide to start your own experiments into +This book tries to give you a guide to start your own experiments into the wonderful world of Wireshark development. -Developers who are new to Wireshark often have a hard time getting +Developers who are new to Wireshark often have a hard time getting their development environment up and running. This is especially true for Win32 developers, as a lot of the tools and methods used when building Wireshark are much more common in the UNIX world than on Win32. -The first part of this book will describe how to set up the environment +The first part of this book will describe how to set up the environment needed to develop Wireshark. -The second part of this book will describe how to change the Wireshark +The second part of this book will describe how to change the Wireshark source code. We hope that you find this book useful, and look forward to your comments. @@ -27,22 +27,22 @@ We hope that you find this book useful, and look forward to your comments. === Who should read this document? -The intended audience of this book is anyone going into the development of +The intended audience of this book is anyone going into the development of Wireshark. -This book is not intended to explain the usage of Wireshark in general. -Please refer the -wireshark-users-guide-url:[][Wireshark User's Guide] about Wireshark usage. +This book is not intended to explain the usage of Wireshark in general. +Please refer the +{wireshark-users-guide-url}[Wireshark User's Guide] about Wireshark usage. -By reading this book, you will learn how to develop Wireshark. It will -hopefully guide you around some common problems that frequently appear for +By reading this book, you will learn how to develop Wireshark. It will +hopefully guide you around some common problems that frequently appear for new (and sometimes even advanced) developers of Wireshark. [[PreAck]] === Acknowledgements -The authors would like to thank the whole Wireshark team for their +The authors would like to thank the whole Wireshark team for their assistance. In particular, the authors would like to thank: * Gerald Combs, for initiating the Wireshark project. @@ -50,23 +50,22 @@ assistance. In particular, the authors would like to thank: * Guy Harris, for many helpful hints and his effort in maintaining the various contributions on the mailing lists. -* Frank Singleton from whose `README.idl2wrs` <<ChDissectIdl2wrs>> is derived. +* Frank Singleton from whose `README.idl2wrs` <<ChDissectIdl2wrs>> is derived. -The authors would also like to thank the following people for their +The authors would also like to thank the following people for their helpful feedback on this document: * XXX - Please give feedback :-) -And of course a big thank you to the many, many contributors of the +And of course a big thank you to the many, many contributors of the Wireshark development community! [[PreAbout]] === About this document -// XXX - Convert to document attribute -This book was developed by mailto:wsdg-author-email:[][Ulf Lamping] -and updated for VS2013 by mailto:wsdg-author-email2:[][Graham Bloice] +This book was developed by mailto:{wsdg-author-email}[Ulf Lamping] +and updated for VS2013 by mailto:{wsdg-author-email2}[Graham Bloice] It is written in AsciiDoc. @@ -81,7 +80,7 @@ You should pay attention to a warning, as otherwise data loss might occur. [NOTE] .This is a note ==== -A note will point you to common mistakes and things that might not be +A note will point you to common mistakes and things that might not be obvious. ==== @@ -95,14 +94,15 @@ Tips will be helpful for your everyday work developing Wireshark. === Where to get the latest copy of this document? -The latest copy of this documentation can always be found at: -wireshark-developers-guide-url:[] in A4 PDF, US letter PDF, single HTML, and chunked HTML. +The latest copy of this documentation can always be found at: +{wireshark-developers-guide-url} in A4 PDF, US letter PDF, single HTML, +and chunked HTML. [[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}[]. 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. -_<expr> relop <expr>_:: -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. +_<expr> relop <expr>_:: 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&A Site -The Wireshark Q&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&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}[]. |