Commit Graph

69 Commits

Author SHA1 Message Date
Gerald Combs 394773ccae Switch the guides back to html output.
DocBook's xhtml5 stylesheet output didn't render correctly in Firefox.

This reverts commit dc09d18e8e.
This reverts commit 62e56ad92a.
This reverts commit 53a80334bc.

Change-Id: Iafcf18cfce25772146fc2e155728401fd105a44b
Reviewed-on: https://code.wireshark.org/review/9944
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-09 16:16:24 +00:00
Gerald Combs dc09d18e8e Output xhtml guides everywhere.
Update Autotools / Nmake to generate xhtml5 user and developer guides.

Change-Id: I5024151aecaee62ea6d8469807fabda552d3f663
Reviewed-on: https://code.wireshark.org/review/9884
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-05 23:27:04 +00:00
Hadriel Kaplan 0caf0616ba Lua: split up wslua files into class-based files
The size of some of the wslua source files has grown large, and it's hard
to quickly find things. So split them up based on class name, as much as
seems reasonable. Also have the make-wsluarm.pl Perl script handle this.

Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213
Reviewed-on: https://code.wireshark.org/review/9579
Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-07-12 02:08:24 +00:00
Gerald Combs 3ac9921065 Retire git_version.xml.
Remove check_git_version.sh and its associated targets. We haven't used
git_version.xml since the AsciiDoc conversion.

Change-Id: I480f0094c4355d71201f2dd285198581bbbfc415
Reviewed-on: https://code.wireshark.org/review/8104
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-04-17 17:02:22 +00:00
Gerald Combs 6dd1296b76 WSUG: Update the Packet Colorization section.
Change-Id: I0f880293bd185e202d230f0db1a6bc4cbe6cfbfb
Reviewed-on: https://code.wireshark.org/review/7011
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-07 19:23:11 +00:00
Gerald Combs 64b8759fbb Try to fix dist.
Change-Id: Ib4332bace88f9db7a06867861c40627e2bdc55f0
Reviewed-on: https://code.wireshark.org/review/5218
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-10 06:25:21 +00:00
Gerald Combs 62289300d6 Finish converting the User's Guide to AsciiDoc.
As with the Developer's Guide, add user-guide-docinfo.xml, which lets us
carry over DocBook front matter. Remove the meta_info chapter. Most of
its contents are now in user-guide-docinfo.xml. Add a DocBook revision
history based on hints from the Git/SVN/CVS revision history.

Remove the various makefile targets for converting AsciiDoc files to
DocBook chapters. Remove GPL_appendix.xml. We use the AsciiDoc version.

Change-Id: I543fa2a92f2c735c5f00c97ec65cff2187e09e3a
Reviewed-on: https://code.wireshark.org/review/5216
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-10 05:30:10 +00:00
Gerald Combs 3924310d86 WSUG: Convert ``Command Line Tools'' to AsciiDoc.
Move the idl2wrs section to the Developer's Guide. Leave most of the
other content intact for now.

Change-Id: I98c6eeab62af5cc55e3ce23ab1107df02b1a22cf
Reviewed-on: https://code.wireshark.org/review/5214
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09 19:41:44 +00:00
Gerald Combs b41f0c3257 WSUG: Convert ``Troubleshooting'' to AsciiDoc.
The chapter is disabled so its final output hasn't been checked. Leave
most of the content intact for now.

Change-Id: I2147ee2863e7ededadf892794a836b4dc8055649
Reviewed-on: https://code.wireshark.org/review/5211
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09 18:25:10 +00:00
Gerald Combs f8f915c248 WSUG: Convert ``Protocols'', ``Messages'', and ``How Wireshark Works''
to AsciiDoc.

``How Wireshark Works'' is disabled, so its final output hasn't been
checked.

Leave most of the content intact for now.

Change-Id: Ia78951faa3ffd9c6d2e23067dbfb954ab4042f60
Reviewed-on: https://code.wireshark.org/review/5210
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09 18:17:15 +00:00
Gerald Combs d8a0757674 WSUG: Convert ``Files'' to AsciiDoc.
Leave most of the content intact for now.

Change-Id: I78f47b8310cb41ac5a07d352e56ec907b36665f8
Reviewed-on: https://code.wireshark.org/review/5209
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09 17:44:35 +00:00
Gerald Combs 04aad36c0e Convert the Lua reference to AsciiDoc.
Move it to the Developer's Guide while we're here.

Nudge the markup in epan/wslua where needed. Note that we should
probably convert it to AsciiDoc (if we're going to keep it in the DG) or
Doxygen.

Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b
Reviewed-on: https://code.wireshark.org/review/5203
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09 05:12:09 +00:00
Gerald Combs f8c3f15613 WSUG: Convert ``Customizing'' to AsciiDoc.
Leave most of the content intact for now.

Change-Id: Id00d942f87e0a25e27333ac56eb9b99311694a13
Reviewed-on: https://code.wireshark.org/review/5063
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-02 03:54:14 +00:00
Gerald Combs f20d5d7bd3 WSUG: Convert ``Telephony'' to AsciiDoc.
Leave most of the content intact for now.

Change-Id: I21aad681194d1bb1841e29f4ac41be4677fcb909
Reviewed-on: https://code.wireshark.org/review/3939
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01 14:44:26 +00:00
Gerald Combs af3e2dbdc6 WSUG: Convert ``Advanced Topics'' to AsciiDoc.
Leave most of the content intact for now.

Change-Id: Ie91fda8a3fe6ea2eb4c47acf7c41d7e6979235b0
Reviewed-on: https://code.wireshark.org/review/3938
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01 05:16:14 +00:00
Gerald Combs 5e6e0600c5 WSUG: Convert ``Working with captured packets'' to AsciiDoc.
Leave most of the content intact for now.

Change-Id: Ic264814aa8e442df100ae8533098843ef6a2e6c9
Reviewed-on: https://code.wireshark.org/review/3937
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01 02:38:16 +00:00
Gerald Combs eb14a1f932 WSUG: Convert the ``File I/O'' chapter to AsciiDoc.
Leave most of the content intact for now. Remove images for
no-longer-supported versions of GTK+. Add an example for building the
Guides to README.cmake.

Change-Id: Id9e6a308c91b594d1fb7f107d7b9b28074a92a8b
Reviewed-on: https://code.wireshark.org/review/3931
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01 01:07:08 +00:00
Joerg Mayer 827d8995d7 The remaining build systems didn't know about the change of the
capture chapter from xml to asciidoc either.

Change-Id: Ia48d4e0e4b445aedabd29a8483bcc19f12c13b20
Reviewed-on: https://code.wireshark.org/review/3857
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-08-26 04:35:25 +00:00
Gerald Combs 7de88cc147 Try to get HTML Help to render SVG.
Add a custom stylesheet that inserts

    <meta http-equiv="X-UA-Compatible" content="IE=9" >

at the top of our HTML Help output. This *should* convince the
WebBrowser control to draw our new SVG images.

Change-Id: Iae491128195d3738951f3d19e2f82dd3fc73d1d8
Reviewed-on: https://code.wireshark.org/review/3814
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24 17:47:22 +00:00
Gerald Combs f88eca47c3 Fix admon.graphics.path.
Change-Id: I43d7d56f0fc2bd73efc54a685aea90f635b145ff
Reviewed-on: https://code.wireshark.org/review/3807
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24 05:23:58 +00:00
Gerald Combs d31011572d Convert admon graphics to SVG.
Use a common set of SVG files for AsciiDoc / DocBook admonition
graphics. Put them in a common directory. According to
http://caniuse.com/svg all common browsers have had SVG support for
a while now.

The graphics themselves were created with Inkscape. If you would like
to refine them further you are more than welcome.

Use variables to assemble xsltproc commands in Autotools and Nmake
while we're here.

Try to update Debian rules to reflect ga92c3fb.

Change-Id: If82647af27a60117c517125dff0aca81c033be72
Reviewed-on: https://code.wireshark.org/review/3206
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24 02:56:35 +00:00
Gerald Combs 02c5a12ee4 WSUG: Convert the "User Interface" chapter to AsciiDoc.
Add the "asciidoc.conf" compatibility configuration file from
Asciidoctor. Although we don't use Asciidoctor it gives us macros that
keep us from losing some useful DocBook elements. Update various CMake
files to support multiple AsciiDoc configuration files.

Leave most of the content intact for now. Hopefully the other chapters
aren't as laden with markup.

Change-Id: Id69757342b86abb2b3130cb61e90f5695a26ea8a
Reviewed-on: https://code.wireshark.org/review/3680
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-23 18:32:51 +00:00
Guy Harris 6af0631457 Remove duplicate line.
Change-Id: I0b32ccaaa7c9e0294ee7bc96fe4937a98d8461d5
Reviewed-on: https://code.wireshark.org/review/3394
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-08-03 20:54:28 +00:00
Gerald Combs 43eea3cfe8 Convert the Statistics chapter to AsciiDoc.
Don't update any content for now.

Change-Id: Ib4f6402d9b23bd1ad57a57831b63c63a150391aa
Reviewed-on: https://code.wireshark.org/review/3372
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-02 23:23:11 +00:00
Gerald Combs a722f83ff1 Convert the build and install chapter to AsciiDoc.
Add OS X content. Remove GTK+ content. Update the names in the NSIS
package to match the documentation (untested).

Change-Id: Id8fd08982bc26871bb8a319b0319808bcdba878c
Reviewed-on: https://code.wireshark.org/review/3366
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-02 21:05:01 +00:00
Guy Harris acea064009 Missing end-of-line backslash.
Change-Id: I99b72e4d38b12e0356f27d29f919484e40b7443b
Reviewed-on: https://code.wireshark.org/review/3287
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-07-31 08:57:28 +00:00
Guy Harris 067beb0210 Add a bunch of missing files to the distribution.
Files from the debian directory, documents from the doc directory,
graphics from the docbook/wsug_graphics directory, and the echld
Makefile.nmake.

Change-Id: Iccccc58811753581b0b180053defd937aea22f95
Reviewed-on: https://code.wireshark.org/review/3283
Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-07-31 07:43:41 +00:00
Gerald Combs 700a474d3b Start converting the User's Guide to AsciiDoc.
Convert the preface and introduction. Update various makefiles.

Change-Id: Id998cabadb6de458f04b7a43bdba4f98e4edb052
Reviewed-on: https://code.wireshark.org/review/3139
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-07-21 15:31:16 +00:00
Stig Bjørlykke 066a9f3d2d Support out-of-source docbook build
Change-Id: I273a6317c459664a247d3f5623ef54b0a70a9ab8
Reviewed-on: https://code.wireshark.org/review/2232
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-06-16 14:19:13 +00:00
Alexis La Goutte 757aa33220 Continue to remove $Id$ from top of file
(Using sed : sed -i '/^\# \$Id\$/,+1 d') (start with dash)

Change-Id: Ia4b5a6c2302f6a531f6a86c1ec3a2f8205c8c2dd
Reviewed-on: https://code.wireshark.org/review/881
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-31 18:48:06 +00:00
Hadriel Kaplan 8c2bb80574 Add various functions for Lua directory handling and path info
This adds new functions to get plugins path info, find out if a directory
exists, make a new one, remove one, etc. It also creates a file environment
for user-supplied Lua scripts, to prevent global variable contamination as
well as supply the script-specific file name.  Some other minor cleanup was
done as I found them.

A new testsuite was added to test the existing and new directory functions.

Change-Id: I19bd587b5e8a73d89b8521af73670e023314fb33
Reviewed-on: https://code.wireshark.org/review/832
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-26 07:37:34 +00:00
Michael Mann 04d9501306 Add capture file reader/writer support for Lua so scripts can implement new capture file formats.
This enables a Lua script to implement a brand new capture file format reader/writer, so that for example one could write a script to read from vendor-specific "logs" of packets, and show them as normal packets in wireshark.

Change-Id: Id394edfffa94529f39789844c382b7ab6cc2d814
Reviewed-on: https://code.wireshark.org/review/431
Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
Reviewed-by: Michael Mann <mmann78@netscape.net>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-19 05:04:54 +00:00
Hadriel Kaplan c4f1777a97 Adds support for Lua struct library so one can pack/unpack binary structures
This is based on Roberto Ierusalimschy's struct library, along with additional
options based on Flemming Madsen's patch to the lua-users mailing list, and
some changes I made to support 64-bit integer packing/unpacking.  Details
are in the top comments for wslua_struct.c.  This also includes a test script.

Change-Id: Ifcd0116ba013d5c760927721c8d6e9f28965534b
Reviewed-on: https://code.wireshark.org/review/98
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Tested-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-02-14 10:11:50 +00:00
Gerald Combs 30b53c3331 Try to fix dist. Change the .asciidoc.xml inference rule to a pattern
rule specific to wsug_src similar to the nmake change in gedc06c1.

Change-Id: I6d4bffc5391bd84a83fca8acb6a3688805e05de6
Reviewed-on: https://code.wireshark.org/review/179
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-11 20:03:59 +00:00
Gerald Combs 5e3113e7c9 Finish converting the Developer's Guide to AsciiDoc.
Add developer-guide-docinfo.xml, which lets us carry over DocBook front
matter. Remove the meta_info chapter. Most of its contents are now in
developer-guide-docinfo.xml. Add a DocBook revision history based on
hints from the Git/SVN/CVS revision history.

Comment out or note makefile content that's no longer necessary for
converting the Developer's Guide but will be useful for converting the
User's Guide. Fix building the release notes with CMake. Other minor
changes. Tested with Autotools, nmake, and CMake.

Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a
Reviewed-on: https://code.wireshark.org/review/155
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-11 18:04:45 +00:00
Gerald Combs 1dc06a2681 Convert the user interface chapter to AsciiDoc.
Start mentioning Qt. Update and add HIG links.

Change-Id: Iac984045b03a96862981d58ff63c9ee6bcdbbce8
Reviewed-on: https://code.wireshark.org/review/127
Tested-by: Wireshark Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-06 20:59:00 +00:00
Hadriel Kaplan 2e7f771a18 Adds support for Lua Int64 and UInt64 operators, functions, and general
usefulness, working around bug #9162 until Lua 5.3 is released.

The existing Int64 and UInt64 classes provide virtually no
usefullness, other than for creating a string of their value.  While
one could then write Lua code to convert the string to Lua numbers and
such, ultimately Lua has no native 64-bit integer support, making such
a task difficult to handle in Lua.  This change adds a host of
functions and operators to the existing Int64 (gint64) and UInt64
(guint64) classes, to enable true 64-bit integer support on par with
native Lua numbers.

A test script is also provided, which tests the functions/operators.

Change-Id: I4c5f8f5219b9a88198902283bd32ddf24c346bbe
Reviewed-on: https://code.wireshark.org/review/83
Tested-by: Evan Huus <eapache@gmail.com>
Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-04 00:37:46 +00:00
Gerald Combs 4dd6451a91 Convert the dissection chapter to AsciiDoc.
Change-Id: Ieccd2ad235576b9ec6013ddb23a8373ccf2f8cdf
Reviewed-on: https://code.wireshark.org/review/92
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-03 18:32:32 +00:00
Gerald Combs 1b2145d931 Convert three more WSDG chapters: works, build, and capture.
Start adding references to Qt and wsutil. Fix a file extension in
CMakeLists.txt.

Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53
Reviewed-on: https://code.wireshark.org/review/79
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02 19:12:17 +00:00
Gerald Combs ec6fc7690b Convert the libraries chapter to AsciiDoc.
Add some docbook-related entries to .gitignore. Whoever maintains the
Windows libraries has done a terrible job of keeping this chapter up to
date.

Change-Id: Ic6dcbd9e8369eae9f07403bd3f805a515886f542
Reviewed-on: https://code.wireshark.org/review/72
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-01 19:30:01 +00:00
Gerald Combs bdafbad955 Convert the tools chapter to AsciiDoc.
Replace SVN text with Git, other mostly-minor edits.

Change-Id: I41b602cc9334656dc8e5f37c33fb6cd660043d17
Reviewed-on: https://code.wireshark.org/review/69
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-01 18:27:15 +00:00
Gerald Combs 257e301696 Convert the quick setup chapter to AsciiDoc and start converting its
content to Git.

svn path=/trunk/; revision=54985
2014-01-27 18:43:57 +00:00
Gerald Combs 5344e2f2fc Migrate the build environment introduction to AsciiDoc.
svn path=/trunk/; revision=54971
2014-01-27 04:20:44 +00:00
Gerald Combs e61a6533e7 Convert the preface to AsciiDoc with minor edits.
svn path=/trunk/; revision=54970
2014-01-27 03:08:01 +00:00
Gerald Combs 8997fb0d89 Start migrating the Developer's Guide to AsciiDoc. So far only one
chapter (WSDG_chapter_sources) has been converted.

Conversion was done using the script in
https://code.wireshark.org/review/#/c/9/ along with manual cleanup.
Changes are mostly limited formatting.

It's helpful to have a copy of the pre-conversion guide for comparison.
I've placed a chunked copy online at
http://www.wireshark.org/~gerald/wsdg_html_2014_01/ .

Tested under Autotools. Nmake and CMake will likely break. I'll take a
look shortly. If only we had documention adding a feature branch to
Gerrit and using it to test different platforms...

svn path=/trunk/; revision=54945
2014-01-24 18:55:27 +00:00
Gerald Combs 2b26c1e216 Prepare for Git migration.
Mass-replace "svn" with "git". Add commented code to use git to fetch
the repository version.

svn path=/trunk/; revision=54905
2014-01-22 18:15:44 +00:00
Gerald Combs fc6e505dac Switch to Asciidoc for the release notes. The initial conversion from
Docbook was done using Pandoc and cleaned up by hand. Add an
asciidoc.conf which contains macros for linking to Wireshark bugs and
CVE IDs.

Remove the release-notes.chm target. I don't think we ever used it and
we're probably better off generating PDF or HTML if we need something
fancier than plain text.

In configure.ac, consolidate program path discovery a bit and add a2x
discovery.

svn path=/trunk/; revision=48307
2013-03-15 00:08:18 +00:00
Balint Reczey 228740dde9 fix building Developer Guide from release tarball
svn path=/trunk/; revision=43148
2012-06-07 18:44:20 +00:00
Stig Bjørlykke 233643e566 Removed empty directory docbook/wsluarm_src. It's generated during 'make',
and now removed during 'make clean'.

svn path=/trunk/; revision=37866
2011-07-02 18:20:39 +00:00
Anders Broman 51d8ad3a45 Remove some stuff again.
svn path=/trunk/; revision=37437
2011-05-27 13:16:28 +00:00