Commit Graph

39 Commits

Author SHA1 Message Date
Gerald Combs 65ab2a9701 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>
2016-11-11 17:18:25 +00:00
Gerald Combs 943a9ede85 Update docbook/README.txt
Update to reflect current reality. Still needs a lot of work.

Change-Id: Id6bb12f5e8ca42bbadc237f148bb388b54a321e2
Reviewed-on: https://code.wireshark.org/review/17247
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-08-22 23:57:14 +00:00
Dario Lombardo 704c12a572 docbook: fix typos.
Change-Id: If94a1427d91a5de2f5f2308be454479e6b4d8d5a
Reviewed-on: https://code.wireshark.org/review/16900
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2016-08-05 19:02:28 +00:00
Pascal Quantin 6baa1b544c Remove Nmake build system
Change-Id: I3bd474f3cda9667dec66426b5729449953df3e61
Reviewed-on: https://code.wireshark.org/review/15777
Petri-Dish: Pascal Quantin <pascal.quantin@gmail.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
Reviewed-by: Balint Reczey <balint@balintreczey.hu>
2016-06-15 19:21:57 +00:00
Gerald Combs a183726370 DocBook: Don't require xmllint.
Remove dependencies on xmllint. We don't write DocBook by hand any more
and we haven't used it in a long time in the CMake builds.

Change-Id: Ic07f03b00c4554c058eece0462b0925d565b6da1
Reviewed-on: https://code.wireshark.org/review/14506
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-03-18 23:26:51 +00:00
Gerald Combs a84937198b WSUG: Convert the "Capturing" chapter to AsciiDoc.
Leave most of the content intact for now. Add a section on markup
conventions to README.txt. Remove the .mediaobject border.

Change-Id: I06cfd482a4c8ea63c90b9f59fcdf2afaf636a4a2
Reviewed-on: https://code.wireshark.org/review/3821
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-25 22:15:17 +00:00
Graham Bloice d3728738dd Updates for docbook builds on Windows
In config.nmake search for multiple versions of fop in a couple of places, preferring fop 1.1
In Makefile.nmake remove any PYTHONPATH env var (as that's probably for Windows)
and not the Cygwin python used in asciidoc
In Readme.txt update some Cygwin package info

Change-Id: I117ec6bbdabc34829b421fd514508383b925090f
Reviewed-on: https://code.wireshark.org/review/3816
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2014-08-25 22:00:29 +00:00
Tim Furlong f737381896 Add a note to Doc/docbook-xml42 requirement in docbook/README.txt indicating
that a later version may be required; e.g. my a2x (from cygwin64) generates a
developer-guide.xml that needs docbook-xml45.

Change-Id: Iea9d4b45e32157a9317e3fcf6794668e3a810c54
Reviewed-on: https://code.wireshark.org/review/2750
Reviewed-by: Evan Huus <eapache@gmail.com>
2014-07-02 01:21:24 +00:00
Joerg Mayer 1496111f99 Fix a whitepace error that got committed in the last change
Change-Id: I5344d04916998263710c16b506250062c1c11b37
Reviewed-on: https://code.wireshark.org/review/2275
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-06-16 21:05:38 +00:00
Bill Meier 27c5eaf947 Update info as to packages needed for Windows and Fedora.
Change-Id: Ie477760abd8232eb646526aeb7cd0eab377ce541
Reviewed-on: https://code.wireshark.org/review/2264
Reviewed-by: Bill Meier <wmeier@newsguy.com>
2014-06-16 19:16:58 +00:00
Alexis La Goutte 94a791a76e Continue to remove $Id$ from top of file
(Using sed : sed -i '/^\$Id\$/,+1 d') (No space or star before $Id$)

Change-Id: I0801bd7cf234d32487008a8b6dcee64875b07688
Reviewed-on: https://code.wireshark.org/review/876
Reviewed-by: Evan Huus <eapache@gmail.com>
2014-03-31 16:00:04 +00:00
Gerald Combs 06fdf8130d Fix the AsciiDoc description.
svn path=/trunk/; revision=53151
2013-11-07 23:43:35 +00:00
Gerald Combs c00caf8eab Remove catalog.xml. As a comment from Bill Meier in 2010 notes, we don't
seem to use it (and if your Docbook environment isn't set up correctly
the problem should probably be fixed elsewhere).

svn path=/trunk/; revision=51221
2013-08-08 16:41:10 +00:00
Gerald Combs 42ede93b8e Switch from Docbook 4.2 to 4.5. Our documentation builder only has the
4.4 and 4.5 DTDs installed and a quick check using a popular network
protocol analyzer showed that xsltproc was fetching the 4.2 DTDs from
the network instead of the local filesystem.

svn path=/trunk/; revision=51220
2013-08-08 15:58:35 +00:00
Gerald Combs 9c31e74bc5 There doesn't appear to be a clean, portable way to run FOP under
Cygwin. Try using dblatex for AsciiDoc → PDF conversion.

svn path=/trunk/; revision=48327
2013-03-15 21:18:16 +00:00
Gerald Combs f609d943e5 Get release note conversion working on Windows.
svn path=/trunk/; revision=48321
2013-03-15 17:00:21 +00:00
Chris Maynard ea55211408 Update a couple of URL's.
svn path=/trunk/; revision=45134
2012-09-25 16:58:53 +00:00
Bill Meier d6d24d6d18 We're now using fop-1.0 on Windows;
Also: remove trailing whitespace from lines.

svn path=/trunk/; revision=37569
2011-06-06 15:32:40 +00:00
Stephen Fisher 973abd3e40 Change underscore to dash to show correct docbook-xml42 package in Cygwin.
svn path=/trunk/; revision=35095
2010-12-01 21:21:33 +00:00
Bill Meier bcea060cd5 Mention elinks as an alternative to lynx [on *nix].
svn path=/trunk/; revision=32399
2010-04-06 15:34:07 +00:00
Gerald Combs 051b274944 Add a note about build-docbook-catalog/util-linux.
svn path=/trunk/; revision=32162
2010-03-10 17:54:05 +00:00
Guy Harris 6c58478023 Give some information on whence xsltproc and xmllint come. Note that
they're both part of OS X Panther and later.

svn path=/trunk/; revision=31377
2009-12-28 22:09:35 +00:00
Jaap Keuter b4a185a325 Clean up the docbook source code, apply proper tags, update references.
Update readme information, add some editing information for authors.

svn path=/trunk/; revision=31326
2009-12-20 14:49:49 +00:00
Bill Meier 5e3d697f0d Update README to reflect fop-0.95 as default on Windows.
svn path=/trunk/; revision=31264
2009-12-14 15:04:49 +00:00
Gerald Combs cc036df5ea Updates for FOP 0.95.
svn path=/trunk/; revision=30913
2009-11-10 01:32:59 +00:00
Ulf Lamping 6ffb831268 add some cygwin clarifications
svn path=/trunk/; revision=25200
2008-04-30 07:35:25 +00:00
Bill Meier aaacabe6e7 Add info for Fedora 7
svn path=/trunk/; revision=22856
2007-09-12 21:34:48 +00:00
Ulf Lamping fc7bda273e add zip to the list of required packages for cygwin
svn path=/trunk/; revision=21094
2007-03-21 21:13:39 +00:00
Ulf Lamping 009d38e6a0 mention lynx, it's mandatory and needed to create plain text version of the release-notes (aka NEWS)
svn path=/trunk/; revision=20694
2007-02-03 08:01:16 +00:00
Ulf Lamping 8d67caf4b3 - update information to the latest changes
- redesign parts of the file
- remove some redundant information
- remove tabs, tabs don't work well!

svn path=/trunk/; revision=20691
2007-02-03 04:09:22 +00:00
Jaap Keuter ace05a6830 From Gerhard Gappmeier: Here is some information for Gentoo users who want to contribute some documentation to wireshark:
svn path=/trunk/; revision=18722
2006-07-12 16:44:23 +00:00
Jaap Keuter 5f152a8ea2 edg -> wsdg
-This line, and those below, will be ignored--

D    docbook/edg_graphics
M    docbook/developer-guide.xml
M    docbook/Makefile.auto.am
A    docbook/wsdg_graphics
D    docbook/edg_src
M    docbook/README.txt
A    docbook/wsdg_src
D    docbook/wsdg_src/EDG_meta_info.xml
A    docbook/wsdg_src/WSDG_userinterface.xml
D    docbook/wsdg_src/EDG_preface.xml
D    docbook/wsdg_src/EDG_chapter_userinterface.xml
D    docbook/wsdg_src/EDG_chapter_tools.xml
A    docbook/wsdg_src/WSDG_meta_info.xml
D    docbook/wsdg_src/EDG_chapter_env_intro.xml
D    docbook/wsdg_src/EDG_chapter_capture.xml
A    docbook/wsdg_src/WSDG_preface.xml
A    docbook/wsdg_src/WSDG_works.xml
D    docbook/wsdg_src/EDG_chapter_dissection.xml
A    docbook/wsdg_src/WSDG_chapter_tools.xml
D    docbook/wsdg_src/EDG_chapter_works.xml
A    docbook/wsdg_src/WSDG_chapter_env_intro.xml
A    docbook/wsdg_src/WSDG_chapter_capture.xml
A    docbook/wsdg_src/WSDG_chapter_dissection.xml
D    docbook/wsdg_src/EDG_chapter_build_intro.xml
D    docbook/wsdg_src/EDG_chapter_libraries.xml
A    docbook/wsdg_src/WSDG_chapter_build_intro.xml
A    docbook/wsdg_src/WSDG_chapter_libraries.xml
D    docbook/wsdg_src/EDG_chapter_sources.xml
A    docbook/wsdg_src/WSDG_chapter_sources.xml
M    docbook/Makefile

svn path=/trunk/; revision=18368
2006-06-06 23:08:58 +00:00
Gerald Combs 6deb90af7b eug -> wsug
svn path=/trunk/; revision=18259
2006-05-30 21:34:56 +00:00
Ulf Lamping fb49859e64 The target is called eug_html_chunked not eug_htmlchunk
The pdf (and chm) targets are called differently in the two Makefiles (user-guide... vs. eug...), and I don't know which one is better (while keeping in mind that this will require changes in the documentation and elsewhere as well if we change it).

svn path=/trunk/; revision=17243
2006-02-10 09:27:32 +00:00
Jörg Mayer aaec199c4a Start a list of packages required for each distro.
So far only Suse 9.3 is covered.

Infos for other systems are very welcome.


svn path=/trunk/; revision=15252
2005-08-07 00:07:18 +00:00
Jörg Mayer 0a71da16a8 - Add -Xmx256m automatically on unixish systems.
- Make build process for A4 and letter pdfs more similar.

svn path=/trunk/; revision=13585
2005-03-04 13:24:47 +00:00
Ulf Lamping a3340a4c2e update to the current state of the art
svn path=/trunk/; revision=12317
2004-10-16 11:32:07 +00:00
Jörg Mayer 9ab5bc5713 Svn stuff:
- Add eol-style native to all text files
- Add Id attributes

Add $Id: $ to all text files

Makefile:
- add several files and directories to make clean
- Add comments for values on Suse 9.1

catalog.xml:
- Add comments for values on Suse 9.1

svn path=/trunk/; revision=11618
2004-08-06 21:06:27 +00:00
Ulf Lamping 556f1245e4 The first draft of an updated "Ethereal User's Guide" redesigned and updated to the current released Ethereal version 0.10.5.
As generation of output files is a bit tricky, please have a look at the Readme.txt file for instructions.

Please send comments and improvements.

svn path=/trunk/; revision=11433
2004-07-19 16:59:49 +00:00