aboutsummaryrefslogtreecommitdiffstats
path: root/doc/Makefile.am
blob: 91f367bdad4c99e239f6fc9c4e70585374077be6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# Makefile.am
# Automake file for Wireshark documentation
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# 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.
#
# 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.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

# We include dependencies on ../config.h in order to
# capture when $(VERSION) changes.

#
# This is a hideous hack.
#
# Automake needs to know into which sections to install various man
# pages; if the names in "man_MANS" have suffixes, it can infer the
# sections from the name (e.g., "hello.1" goes in section 1), but if
# they don't have suffixes, it can't tell what sections to put them, and
# it just gives up and doesn't create any rules to install them (and it
# gives up silently, so you have no clue what's wrong).
#
# Therefore, we can't just set "man_MANS" to a list of variables to be
# filled in by the configure script, as those variables don't have man
# page section numbers.
#
# It turns out (although this is not documented anywhere I could find
# in the automake Info file) that if you define, instead, variables with
# names like "man{section}_MANS", automake will infer that the names in
# those variables are the names of man pages to be installed in section
# "{section}".
#
# So we define "man1_MANS" to contain all the section 1 man pages and
# man4_MANS for the (one) section 4 man page.
#
# *However*, if "man_MANS" isn't defined at all, automake concludes that
# there are no man pages, the fact that, say, "man1_MANS" is defined
# nonwithstanding!  (I suspect this is the result of a mistaken attempt
# to get people to fix their automake files not to use "MANS"; if "MANS"
# is defined, it prints a warning and sets the exit status, but doesn't
# exit, and then it just gives up if "man_MANS" isn't defined,
# presumably on the theory that the only reason it wouldn't be defined
# is because the automake file uses the obsolete "MANS" variable instead
# of the shiny new "man_MANS" variable.)
#
# So we also define "man_MANS", but don't define it as anything;
# automake will arrange that the Makefile define it as the union of all
# the "man{section}_MANS" variables.
#
man1_MANS = \
	@wireshark_man@		\
	@tshark_man@		\
	@text2pcap_man@		\
	@mergecap_man@		\
	@reordercap_man@	\
	@capinfos_man@		\
	@editcap_man@		\
	@dumpcap_man@		\
	@rawshark_man@		\
	@dftest_man@		\
	@randpkt_man@		\
	@androiddump_man@	\
	@sshdump_man@		\
	@randpktdump_man@

man4_MANS = @wiresharkfilter_man@
man_MANS =

# Build these in case a developer wants to read them and for the Debian
# development package.
# (The former arguably should be in noinst_MANS but it didn't work for me.)
noinst_DATA = asn2deb.1 asn2deb.html idl2deb.1 idl2deb.html idl2wrs.1 idl2wrs.html

pkgdata_DATA = AUTHORS-SHORT $(top_srcdir)/docbook/ws.css wireshark.html \
	tshark.html wireshark-filter.html capinfos.html editcap.html \
	mergecap.html reordercap.html text2pcap.html dumpcap.html androiddump.html \
	sshdump.html randpktdump.html rawshark.html dftest.html randpkt.html

#
# Build the short version of the authors file for the about dialog
#
AUTHORS-SHORT: $(top_srcdir)/AUTHORS $(srcdir)/make-authors-short.pl
	$(AM_V_GEN)$(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-short.pl < $(top_srcdir)/AUTHORS > AUTHORS-SHORT

# Put a copy in the top-level directory so Help->About, when run from the
# build directory, can find it.
../AUTHORS-SHORT: AUTHORS-SHORT
	$(AM_V_GEN)cp AUTHORS-SHORT ..

#
# Build the short version of the authors file with formatting codes for the
# man page
# (Depending on ../AUTHORS-SHORT is a bit of a hack to get the file copied
# down there.)
#
AUTHORS-SHORT-FORMAT: ../AUTHORS-SHORT $(srcdir)/make-authors-format.pl
	$(AM_V_GEN)$(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-format.pl < AUTHORS-SHORT > AUTHORS-SHORT-FORMAT

wireshark.pod: $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT
	$(AM_V_GEN)cat $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT > wireshark.pod

AM_V_POD2MAN = $(am__v_POD2MAN_@AM_V@)
am__v_POD2MAN_ = $(am__v_POD2MAN_@AM_DEFAULT_V@)
am__v_POD2MAN_0 = @echo "  POD2MAN " $@;

AM_V_POD2HTML = $(am__v_POD2HTML_@AM_V@)
am__v_POD2HTML_ = $(am__v_POD2HTML_@AM_DEFAULT_V@)
am__v_POD2HTML_0 = @echo "  POD2HTML" $@;

POD_CSS_URL ?= $(top_srcdir)/docbook/ws.css

.pod.1: ../config.h
	$(AM_V_POD2MAN)$(POD2MAN)                       \
	--center="The Wireshark Network Analyzer"       \
	--release=$(VERSION)                            \
	$< > $@

.pod.html: ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                             \
	--title="The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)					\
	--noindex						\
	$< > $@

# This rule needs to stay separate because of the --section option.
wireshark-filter.4: wireshark-filter.pod ../config.h
	$(AM_V_POD2MAN)$(POD2MAN)			\
	--section=4					\
	--center="The Wireshark Network Analyzer"	\
	--release=$(VERSION)				\
	$(srcdir)/wireshark-filter.pod > wireshark-filter.4

# These rules need to stay separate because each man page has a separate
# title.  Using GNU make's pattern rules would allow these to be removed
# but at the cost of portability.
tshark.html: tshark.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)					\
	--title="tshark - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/tshark.pod > tshark.html

wireshark-filter.html: wireshark-filter.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)						\
	--title="wireshark-filter - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)							\
	--noindex								\
	$(srcdir)/wireshark-filter.pod > wireshark-filter.html

capinfos.html: capinfos.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)					\
	--title="capinfos - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/capinfos.pod > capinfos.html

editcap.html: editcap.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)					\
	--title="editcap - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/editcap.pod > editcap.html

idl2wrs.html: idl2wrs.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)					\
	--title="idl2wrs - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/idl2wrs.pod > idl2wrs.html

mergecap.html: mergecap.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)					\
	--title="mergecap - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/mergecap.pod > mergecap.html

reordercap.html: reordercap.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)					\
	--title="reordercap - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/reordercap.pod > reordercap.html

text2pcap.html: text2pcap.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="text2pcap - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/text2pcap.pod > text2pcap.html

dumpcap.html: dumpcap.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="dumpcap - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/dumpcap.pod > dumpcap.html

androiddump.html: androiddump.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="androiddump - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/androiddump.pod > androiddump.html

sshdump.html: sshdump.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="sshdump - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/sshdump.pod > sshdump.html

randpktdump.html: randpktdump.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="randpktdump - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/randpktdump.pod > randpktdump.html

rawshark.html: rawshark.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="rawshark - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/rawshark.pod > rawshark.html

dftest.html: dftest.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="dftest - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/dftest.pod > dftest.html

randpkt.html: randpkt.pod ../config.h $(top_srcdir)/docbook/ws.css
	$(AM_V_POD2HTML)$(POD2HTML)                     \
	--title="randpkt - The Wireshark Network Analyzer $(VERSION)"	\
	--css=$(POD_CSS_URL)						\
	--noindex							\
	$(srcdir)/randpkt.pod > randpkt.html

CLEANFILES =		\
	wireshark.pod	\
	*.1		\
	*.4		\
	*.html

DISTCLEANFILES =		\
	pod2htmi.tmp		\
	pod2htmd.tmp		\
	AUTHORS-SHORT		\
	../AUTHORS-SHORT	\
	AUTHORS-SHORT-FORMAT	\
	*~

MAINTAINERCLEANFILES = \
	Makefile.in

EXTRA_DIST =				\
	Makefile.nmake			\
	README.capture			\
	README.design			\
	README.developer		\
	README.display_filter		\
	README.dissector		\
	README.epan_child		\
	README.extcap			\
	README.heuristic		\
	README.idl2wrs			\
	README.packaging		\
	README.plugins			\
	README.qt			\
	README.regression   		\
	README.request_response_tracking\
	README.stats_tree		\
	README.tapping			\
	README.wmem			\
	README.wslua			\
	README.xml-output		\
	androiddump.pod			\
	asn2deb.pod			\
	capinfos.pod			\
	captype.pod			\
	dfilter2pod.pl			\
	dftest.pod			\
	dumpcap.pod			\
	editcap.pod			\
	extcap.pod			\
	eproto2sgml			\
	idl2deb.pod			\
	idl2wrs.pod			\
	make-authors-format.pl		\
	make-authors-short.pl		\
	mergecap.pod			\
	packet-PROTOABBREV.c		\
	perlnoutf.pl			\
	randpkt.pod			\
	randpkt.txt			\
	randpktdump.pod			\
	rawshark.pod			\
	reordercap.pod			\
	sgml.doc.template		\
	sshdump.pod				\
	text2pcap.pod			\
	tshark.pod			\
	wireshark-filter.pod    	\
	wireshark.pod.template