Add missing comments in syntax description for -z expert
[obnox/wireshark/wip.git] / doc / Makefile.am
1 # Makefile.am
2 # Automake file for Wireshark documentation
3 #
4 # $Id$
5 #
6 # Wireshark - Network traffic analyzer
7 # By Gerald Combs <gerald@wireshark.org>
8 # Copyright 1998 Gerald Combs
9 #
10 # This program is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU General Public License
12 # as published by the Free Software Foundation; either version 2
13 # of the License, or (at your option) any later version.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the GNU General Public License
21 # along with this program; if not, write to the Free Software
22 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23
24 # We include dependencies on ../config.h in order to
25 # capture when $(VERSION) changes.
26
27 #
28 # This is a hideous hack.
29 #
30 # Automake needs to know into which sections to install various man
31 # pages; if the names in "man_MANS" have suffixes, it can infer the
32 # sections from the name (e.g., "hello.1" goes in section 1), but if
33 # they don't have suffixes, it can't tell what sections to put them, and
34 # it just gives up and doesn't create any rules to install them (and it
35 # gives up silently, so you have no clue what's wrong).
36 #
37 # Therefore, we can't just set "man_MANS" to a list of variables to be
38 # filled in by the configure script, as those variables don't have man
39 # page section numbers.
40 #
41 # It turns out (although this is not documented anywhere I could find
42 # in the automake Info file) that if you define, instead, variables with
43 # names like "man{section}_MANS", automake will infer that the names in
44 # those variables are the names of man pages to be installed in section
45 # "{section}".
46 #
47 # So we define "man1_MANS" to contain all the section 1 man pages and
48 # man4_MANS for the (one) section 4 man page.
49 #
50 # *However*, if "man_MANS" isn't defined at all, automake concludes that
51 # there are no man pages, the fact that, say, "man1_MANS" is defined
52 # nonwithstanding!  (I suspect this is the result of a mistaken attempt
53 # to get people to fix their automake files not to use "MANS"; if "MANS"
54 # is defined, it prints a warning and sets the exit status, but doesn't
55 # exit, and then it just gives up if "man_MANS" isn't defined,
56 # presumably on the theory that the only reason it wouldn't be defined
57 # is because the automake file uses the obsolete "MANS" variable instead
58 # of the shiny new "man_MANS" variable.)
59 #
60 # So we also define "man_MANS", but don't define it as anything;
61 # automake will arrange that the Makefile define it as the union of all
62 # the "man{section}_MANS" variables.
63 #
64 man1_MANS = \
65         @wireshark_man@ \
66         @tshark_man@    \
67         @text2pcap_man@ \
68         @mergecap_man@  \
69         @capinfos_man@  \
70         @editcap_man@   \
71         @dumpcap_man@   \
72         idl2wrs.1       \
73         @rawshark_man@  \
74         @dftest_man@    \
75         @randpkt_man@
76 man4_MANS = @wiresharkfilter_man@
77 man_MANS =
78
79 pkgdata_DATA = AUTHORS-SHORT $(top_srcdir)/docbook/ws.css wireshark.html \
80         tshark.html wireshark-filter.html capinfos.html editcap.html \
81         idl2wrs.html mergecap.html text2pcap.html dumpcap.html rawshark.html \
82         dftest.html randpkt.html
83
84 #
85 # Build the short version of the authors file for the about dialog
86 #
87 AUTHORS-SHORT: $(top_srcdir)/AUTHORS $(srcdir)/make-authors-short.pl
88         $(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-short.pl < $(top_srcdir)/AUTHORS > AUTHORS-SHORT
89
90 # Put a copy in the top-level directory so Help->About, when run from the
91 # build directory, can find it.
92 ../AUTHORS-SHORT: AUTHORS-SHORT
93         cp AUTHORS-SHORT ..
94
95 #
96 # Build the short version of the authors file with formatting codes for the
97 # man page
98 # (Depending on ../AUTHORS-SHORT is a bit of a hack to get the file copied
99 # down there.)
100 #
101 AUTHORS-SHORT-FORMAT: ../AUTHORS-SHORT $(srcdir)/make-authors-format.pl
102         $(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-format.pl < AUTHORS-SHORT > AUTHORS-SHORT-FORMAT
103
104 wireshark.pod: $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT
105         cat $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT > wireshark.pod
106
107 wireshark.1: wireshark.pod ../config.h
108         $(POD2MAN)                                      \
109         --center="The Wireshark Network Analyzer"       \
110         --release=$(VERSION)                            \
111         wireshark.pod  > wireshark.1
112
113 wireshark.html: wireshark.pod ../config.h $(top_srcdir)/docbook/ws.css
114         $(POD2HTML)                                             \
115         --title="The Wireshark Network Analyzer $(VERSION)"     \
116         --css=$(top_srcdir)/docbook/ws.css                      \
117         --noindex                                               \
118         wireshark.pod > wireshark.html
119
120 tshark.1: tshark.pod ../config.h
121         $(POD2MAN)                                      \
122         --center="The Wireshark Network Analyzer"       \
123         --release=$(VERSION)                            \
124         $(srcdir)/tshark.pod > tshark.1
125
126 tshark.html: tshark.pod ../config.h $(top_srcdir)/docbook/ws.css
127         $(POD2HTML)                                                     \
128         --title="tshark - The Wireshark Network Analyzer $(VERSION)"    \
129         --css=$(top_srcdir)/docbook/ws.css                              \
130         --noindex                                                       \
131         $(srcdir)/tshark.pod > tshark.html
132
133 wireshark-filter.4: wireshark-filter.pod ../config.h
134         $(POD2MAN)                                      \
135         --section=4                                     \
136         --center="The Wireshark Network Analyzer"       \
137         --release=$(VERSION)                            \
138         $(srcdir)/wireshark-filter.pod > wireshark-filter.4
139
140 wireshark-filter.html: wireshark-filter.pod ../config.h $(top_srcdir)/docbook/ws.css
141         $(POD2HTML)                                                             \
142         --title="wireshark-filter - The Wireshark Network Analyzer $(VERSION)"  \
143         --css=$(top_srcdir)/docbook/ws.css                                      \
144         --noindex                                                               \
145         $(srcdir)/wireshark-filter.pod > wireshark-filter.html
146
147 capinfos.1: capinfos.pod ../config.h
148         $(POD2MAN)                                      \
149         --center="The Wireshark Network Analyzer"       \
150         --release=$(VERSION)                            \
151         $(srcdir)/capinfos.pod > capinfos.1
152
153 capinfos.html: capinfos.pod ../config.h $(top_srcdir)/docbook/ws.css
154         $(POD2HTML)                                                     \
155         --title="capinfos - The Wireshark Network Analyzer $(VERSION)"  \
156         --css=$(top_srcdir)/docbook/ws.css                              \
157         --noindex                                                       \
158         $(srcdir)/capinfos.pod > capinfos.html
159
160 editcap.1: editcap.pod ../config.h
161         $(POD2MAN)                                      \
162         --center="The Wireshark Network Analyzer"       \
163         --release=$(VERSION)                            \
164         $(srcdir)/editcap.pod > editcap.1
165
166 editcap.html: editcap.pod ../config.h $(top_srcdir)/docbook/ws.css
167         $(POD2HTML)                                                     \
168         --title="editcap - The Wireshark Network Analyzer $(VERSION)"   \
169         --css=$(top_srcdir)/docbook/ws.css                              \
170         --noindex                                                       \
171         $(srcdir)/editcap.pod > editcap.html
172
173 idl2wrs.1: idl2wrs.pod ../config.h
174         $(POD2MAN)                                      \
175         --center="The Wireshark Network Analyzer"       \
176         --release=$(VERSION)                            \
177         $(srcdir)/idl2wrs.pod > idl2wrs.1
178
179 idl2wrs.html: idl2wrs.pod ../config.h $(top_srcdir)/docbook/ws.css
180         $(POD2HTML)                                                     \
181         --title="idl2wrs - The Wireshark Network Analyzer $(VERSION)"   \
182         --css=$(top_srcdir)/docbook/ws.css                              \
183         --noindex                                                       \
184         $(srcdir)/idl2wrs.pod > idl2wrs.html
185
186 mergecap.1: mergecap.pod ../config.h
187         $(POD2MAN)                                      \
188         --center="The Wireshark Network Analyzer"       \
189         --release=$(VERSION)                            \
190         $(srcdir)/mergecap.pod > mergecap.1
191
192 mergecap.html: mergecap.pod ../config.h $(top_srcdir)/docbook/ws.css
193         $(POD2HTML)                                                     \
194         --title="mergecap - The Wireshark Network Analyzer $(VERSION)"  \
195         --css=$(top_srcdir)/docbook/ws.css                              \
196         --noindex                                                       \
197         $(srcdir)/mergecap.pod > mergecap.html
198
199 text2pcap.1: text2pcap.pod ../config.h
200         $(POD2MAN)                                      \
201         --center="The Wireshark Network Analyzer"       \
202         --release=$(VERSION)                            \
203         $(srcdir)/text2pcap.pod > text2pcap.1
204
205 text2pcap.html: text2pcap.pod ../config.h $(top_srcdir)/docbook/ws.css
206         $(POD2HTML)                     \
207         --title="text2pcap - The Wireshark Network Analyzer $(VERSION)" \
208         --css=$(top_srcdir)/docbook/ws.css                              \
209         --noindex                                                       \
210         $(srcdir)/text2pcap.pod > text2pcap.html
211
212 dumpcap.1: dumpcap.pod ../config.h
213         $(POD2MAN)                                      \
214         --center="The Wireshark Network Analyzer"       \
215         --release=$(VERSION)                            \
216         $(srcdir)/dumpcap.pod > dumpcap.1
217
218 dumpcap.html: dumpcap.pod ../config.h $(top_srcdir)/docbook/ws.css
219         $(POD2HTML)                     \
220         --title="dumpcap - The Wireshark Network Analyzer $(VERSION)"   \
221         --css=$(top_srcdir)/docbook/ws.css                              \
222         --noindex                                                       \
223         $(srcdir)/dumpcap.pod > dumpcap.html
224
225 rawshark.1: rawshark.pod ../config.h
226         $(POD2MAN)                                      \
227         --center="The Wireshark Network Analyzer"       \
228         --release=$(VERSION)                            \
229         $(srcdir)/rawshark.pod > rawshark.1
230
231 rawshark.html: rawshark.pod ../config.h $(top_srcdir)/docbook/ws.css
232         $(POD2HTML)                     \
233         --title="rawshark - The Wireshark Network Analyzer $(VERSION)"  \
234         --css=$(top_srcdir)/docbook/ws.css                              \
235         --noindex                                                       \
236         $(srcdir)/rawshark.pod > rawshark.html
237
238 dftest.1: dftest.pod ../config.h
239         $(POD2MAN)                                      \
240         --center="The Wireshark Network Analyzer"       \
241         --release=$(VERSION)                            \
242         $(srcdir)/dftest.pod > dftest.1
243
244 dftest.html: dftest.pod ../config.h $(top_srcdir)/docbook/ws.css
245         $(POD2HTML)                     \
246         --title="dftest - The Wireshark Network Analyzer $(VERSION)"    \
247         --css=$(top_srcdir)/docbook/ws.css                              \
248         --noindex                                                       \
249         $(srcdir)/dftest.pod > dftest.html
250
251 randpkt.1: randpkt.pod ../config.h
252         $(POD2MAN)                                      \
253         --center="The Wireshark Network Analyzer"       \
254         --release=$(VERSION)                            \
255         $(srcdir)/randpkt.pod > randpkt.1
256
257 randpkt.html: randpkt.pod ../config.h $(top_srcdir)/docbook/ws.css
258         $(POD2HTML)                     \
259         --title="randpkt - The Wireshark Network Analyzer $(VERSION)"   \
260         --css=$(top_srcdir)/docbook/ws.css                              \
261         --noindex                                                       \
262         $(srcdir)/randpkt.pod > randpkt.html
263
264 CLEANFILES =            \
265         wireshark.pod \
266         wireshark-filter.4 \
267         wireshark-filter.html \
268         wireshark.1     \
269         wireshark.html  \
270         capinfos.1      \
271         capinfos.html   \
272         dftest.1        \
273         dftest.html     \
274         dumpcap.1       \
275         dumpcap.html    \
276         editcap.1       \
277         editcap.html    \
278         idl2wrs.1       \
279         idl2wrs.html    \
280         mergecap.1      \
281         mergecap.html   \
282         randpkt.1       \
283         randpkt.html    \
284         rawshark.1      \
285         rawshark.html   \
286         text2pcap.1     \
287         text2pcap.html  \
288         tshark.1        \
289         tshark.html
290
291 DISTCLEANFILES =                \
292         pod2htmi.tmp            \
293         pod2htmd.tmp            \
294         AUTHORS-SHORT           \
295         ../AUTHORS-SHORT        \
296         AUTHORS-SHORT-FORMAT    \
297         *~
298
299 MAINTAINERCLEANFILES = \
300         Makefile.in
301
302 EXTRA_DIST = \
303         Makefile.nmake  \
304         README.binarytrees      \
305         README.capture  \
306         README.design   \
307         README.developer        \
308         README.display_filter   \
309         README.heuristic        \
310         README.idl2wrs  \
311         README.malloc   \
312         README.packaging        \
313         README.plugins  \
314         README.python \
315         README.regression   \
316         README.request_response_tracking        \
317         README.stats_tree       \
318         README.tapping  \
319         README.xml-output       \
320         doc.vcproj              \
321         make-authors-format.pl  \
322         make-authors-short.pl   \
323         perlnoutf.pl            \
324         capinfos.pod            \
325         dfilter2pod.pl          \
326         dftest.pod              \
327         dumpcap.pod             \
328         editcap.pod             \
329         eproto2sgml             \
330         idl2wrs.pod             \
331         mergecap.pod            \
332         randpkt.pod             \
333         randpkt.txt             \
334         rawshark.pod            \
335         sgml.doc.template       \
336         text2pcap.pod           \
337         tshark.pod              \
338         wireshark-filter.pod    \
339         wireshark.pod.template
340