Commit Graph

27 Commits

Author SHA1 Message Date
Peter Wu 68698db8cc Always use html2text.py for FAQ, improve output
A recent commit broke compilation with Python 3. The original author of
html2text.py is deceased and the fork has increased the number of files
for this "simple" helper.

The html2text.py script in this patch was rewritten and its output
matches with lynx (except for a few newlines around lists). This means
that indentation has been added for headings, paragraphs and lists.
Also, since it was written from scratch, a new license could be chosen
that matches Wireshark.

Since now the in-tree html2text.py script provides nicer output, remove
detection of the alternative programs (elinks, links). lynx/w3m is
somehow still necessary for asciidoc though.

(I also looked into reusing html2text.py for the release notes to
replace asciidoc, but the --format=html output produces different output
(HTML adds a ToC and section numbers). For now still require lynx for
release notes)

Tested with Python 2.6.6, 2.7.9, 3.2.6 and 3.4.3 under LC_ALL=C and
LC_ALL=en_US.UTF-8 on Linux. Tested reading from stdin and file, writing
to file, pipe and tty. Tested with cmake (Ninja) and autotools on Arch
Linux x86_64. Test:

    # For each $PATH per python version, execute (with varying LC_ALL)
    help/faq.py -b | tools/html2text.py /dev/stdin | md5sum
    help/faq.py -b | tools/html2text.py | md5sum
    help/faq.py -b | tools/html2text.py
    help/faq.py -b | tools/html2text.py >/dev/null

Change-Id: I6409450a3e6c8b010ca082251f9db7358b0cc2fd
Reviewed-on: https://code.wireshark.org/review/7779
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-03-25 07:08:52 +00:00
Stephen Fisher fbd6caa36c Take out parenthesis around faq.txt rule so it works when automake
chooses Korn shell instead of Bourne shell.  It still works with the
Bourne shell in my testing.

Change-Id: I00bfed22fb0d9bb183637ea5fb111904b8536949
Reviewed-on: https://code.wireshark.org/review/5880
Reviewed-by: Stephen Fisher <sfisher@sdf.org>
2014-12-19 18:33:40 +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
Jeff Morriss 9fd357b174 Fix https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=8908 :
As per http://stackoverflow.com/questions/592620/check-if-a-program-exists-from-a-bash-script
the portable way to find out if a particular command is available is with "command -v" not
"which".

svn path=/trunk/; revision=50610
2013-07-15 13:28:53 +00:00
Gerald Combs c0ca6220ef Prettify more build output.
svn path=/trunk/; revision=47469
2013-02-04 17:22:32 +00:00
Jakub Zawadzki bf81b42e1e Update Free Software Foundation address.
(COPYING will be updated in next commit)

svn path=/trunk/; revision=43536
2012-06-28 22:56:06 +00:00
Jörg Mayer 5667e75a50 Get rid of FAQ file completely: It's still available as help/faq.txt
svn path=/trunk/; revision=27359
2009-02-03 08:49:03 +00:00
Gerald Combs f49377e0e7 Update html2text.py to suit our needs. Add spaces in the faq.txt target
so to fix a problem with OS X 10.4. Add html2text.py to the end of the
faq.txt target.

svn path=/trunk/; revision=27040
2008-12-17 19:49:18 +00:00
Gerald Combs 9ef162199f Suggest an alternative to hunting for elinks/links/lynx.
svn path=/trunk/; revision=27003
2008-12-15 16:44:47 +00:00
Balint Reczey 4607e187df Serialize faq.txt creation steps.
svn path=/trunk/; revision=27001
2008-12-15 12:54:35 +00:00
Balint Reczey 40385b9ab0 Try browsers for faq.txt generation silently.
svn path=/trunk/; revision=26999
2008-12-15 12:35:23 +00:00
Balint Reczey bc79c1f13a Fixed links parameters.
Tested with Links 2.1pre37.

svn path=/trunk/; revision=26997
2008-12-15 10:34:37 +00:00
Stig Bjørlykke adf9b77ac1 From Didier Gautheron (bug 3121):
User srcdir in Makefiles for faq.py.

svn path=/trunk/; revision=26996
2008-12-14 23:56:51 +00:00
Bill Meier 157f478a23 Fix to make faq.txt when one or more of elinks,... don't exist
svn path=/trunk/; revision=26986
2008-12-13 15:00:11 +00:00
Gerald Combs 6906e79600 Fix FAQ targets.
svn path=/trunk/; revision=26981
2008-12-13 02:53:34 +00:00
Gerald Combs 8a1109396a Update faq.py to generate a full HTML document by default. Pull in a typo
fix from FAQ. Update the makefiles to build help/faq.txt and FAQ. Remove
help/faq.txt and FAQ from the repository, since they're automatically
generated now. Remove the make-faq script.

svn path=/trunk/; revision=26980
2008-12-13 00:58:43 +00:00
Ronnie Sahlberg f0b33a4789 ethereal->wireshark updates
svn path=/trunk/; revision=18206
2006-05-22 08:14:01 +00:00
Ronnie Sahlberg 89f022b12b name change
svn path=/trunk/; revision=18197
2006-05-21 05:12:17 +00:00
Jörg Mayer 5b442f2279 After doing "make maintainer-clean", "svn status --no-ignore | grep ^I"
returned quite a list of files. Add them to MAINTAINERCLEANFILES.

Whitespace changes (replace multiple spaces by TABs, in a few cases this
needed to be done at the beginning of Makefile lines.


svn path=/trunk/; revision=14891
2005-07-10 08:04:27 +00:00
Ulf Lamping 2d2b3d4f5a removed "Well Known" help page, as the content (and far more than that) moved to the wiki.
svn path=/trunk/; revision=12100
2004-09-25 10:15:08 +00:00
Guy Harris 8a8b883450 Set the svn:eol-style property on all text files to "native", so that
they have LF at the end of the line on UN*X and CR/LF on Windows;
hopefully this means that if a CR/LF version is checked in on Windows,
the CRs will be stripped so that they show up only when checked out on
Windows, not on UN*X.

svn path=/trunk/; revision=11400
2004-07-18 00:24:25 +00:00
Ulf Lamping 62e8b4836e two new help pages:
getting_started for the very first steps running Ethereal
capturing for some explanation how to capture data

svn path=/trunk/; revision=10013
2004-02-09 18:22:28 +00:00
Guy Harris a7d9018c1f Have a "toc" file in the help directory, which gives a list of help
topic titles and help file names.

svn path=/trunk/; revision=9417
2003-12-22 22:17:30 +00:00
Ulf Lamping c263d27773 file "convert-include.sh" no longer used, so no need to distribute it
svn path=/trunk/; revision=9413
2003-12-22 21:01:29 +00:00
Guy Harris b3c8b9bb2b Arrange to install the help files.
svn path=/trunk/; revision=9411
2003-12-22 20:04:32 +00:00
Ulf Lamping 2e7258ed35 using distributed help text files, instead of "#include" built in texts
svn path=/trunk/; revision=9408
2003-12-22 08:12:10 +00:00
Gerald Combs e660fedd31 Add the help directory to the build. Bump the release version to 0.10.0a
svn path=/trunk/; revision=9276
2003-12-13 18:05:49 +00:00