doc/Makefile.am

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