2003-12-13 18:05:49 +00:00
|
|
|
# Makefile.am
|
2006-05-22 08:14:01 +00:00
|
|
|
# Automake file for Wireshark help files
|
2003-12-13 18:05:49 +00:00
|
|
|
#
|
2006-05-21 05:12:17 +00:00
|
|
|
# Wireshark - Network traffic analyzer
|
|
|
|
|
# By Gerald Combs <gerald@wireshark.org>
|
2003-12-13 18:05:49 +00:00
|
|
|
# Copyright 2003 Gerald Combs
|
2013-07-15 13:28:53 +00:00
|
|
|
#
|
2003-12-13 18:05:49 +00:00
|
|
|
# This program is free software; you can redistribute it and/or
|
|
|
|
|
# modify it under the terms of the GNU General Public License
|
|
|
|
|
# as published by the Free Software Foundation; either version 2
|
|
|
|
|
# of the License, or (at your option) any later version.
|
2013-07-15 13:28:53 +00:00
|
|
|
#
|
2003-12-13 18:05:49 +00:00
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
# GNU General Public License for more details.
|
2013-07-15 13:28:53 +00:00
|
|
|
#
|
2003-12-13 18:05:49 +00:00
|
|
|
# You should have received a copy of the GNU General Public License
|
|
|
|
|
# along with this program; if not, write to the Free Software
|
2012-06-28 22:56:06 +00:00
|
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
2003-12-13 18:05:49 +00:00
|
|
|
|
2003-12-22 20:04:32 +00:00
|
|
|
#
|
|
|
|
|
# Install the help files in the "help" subdirectory of the data directory.
|
|
|
|
|
#
|
|
|
|
|
helpdir = $(pkgdatadir)/help
|
2005-07-10 08:04:27 +00:00
|
|
|
help_DATA = \
|
|
|
|
|
toc \
|
|
|
|
|
getting_started.txt \
|
|
|
|
|
capturing.txt \
|
|
|
|
|
capture_filters.txt \
|
|
|
|
|
display_filters.txt \
|
|
|
|
|
faq.txt \
|
2004-09-25 10:15:08 +00:00
|
|
|
overview.txt
|
2003-12-13 18:05:49 +00:00
|
|
|
|
2009-02-03 08:49:03 +00:00
|
|
|
EXTRA_DIST = \
|
|
|
|
|
$(help_DATA) \
|
|
|
|
|
$(srcdir)/faq.py \
|
|
|
|
|
faq.txt
|
2003-12-13 18:05:49 +00:00
|
|
|
|
2008-12-13 00:58:43 +00:00
|
|
|
CLEANFILES = faq.txt
|
2005-07-10 08:04:27 +00:00
|
|
|
|
|
|
|
|
MAINTAINERCLEANFILES = \
|
|
|
|
|
Makefile.in
|
|
|
|
|
|
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-21 10:57:01 +00:00
|
|
|
# Convert the FAQ to text.
|
2008-12-14 23:56:51 +00:00
|
|
|
faq.txt: $(srcdir)/faq.py
|
2016-10-02 23:49:40 +00:00
|
|
|
$(AM_V_GEN)$(PYTHON) $(srcdir)/faq.py -b >$@.tmp && \
|
|
|
|
|
$(PYTHON) $(srcdir)/../tools/html2text.py $@.tmp > $@ && \
|
2008-12-13 15:00:11 +00:00
|
|
|
rm -f $@.tmp
|