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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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         @reordercap_man@        \
  70         @capinfos_man@          \
  71         @editcap_man@           \
  72         @dumpcap_man@           \
  73         @rawshark_man@          \
  74         @dftest_man@            \
  75         @randpkt_man@
  76 man4_MANS = @wiresharkfilter_man@
  77 man_MANS =
  78
  79 # Build these in case a developer wants to read them and for the Debian
  80 # development package.
  81 # (The former arguably should be in noinst_MANS but it didn't work for me.)
  82 noinst_DATA = asn2deb.1 asn2deb.html idl2deb.1 idl2deb.html idl2wrs.1 idl2wrs.html
  83
  84 pkgdata_DATA = AUTHORS-SHORT $(top_srcdir)/docbook/ws.css wireshark.html \
  85         tshark.html wireshark-filter.html capinfos.html editcap.html \
  86         mergecap.html reordercap.html text2pcap.html dumpcap.html rawshark.html \
  87         dftest.html randpkt.html
  88
  89 #
  90 # Build the short version of the authors file for the about dialog
  91 #
  92 AUTHORS-SHORT: $(top_srcdir)/AUTHORS $(srcdir)/make-authors-short.pl
  93         $(AM_V_GEN)$(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-short.pl < $(top_srcdir)/AUTHORS > AUTHORS-SHORT
  94
  95 # Put a copy in the top-level directory so Help->About, when run from the
  96 # build directory, can find it.
  97 ../AUTHORS-SHORT: AUTHORS-SHORT
  98         $(AM_V_GEN)cp AUTHORS-SHORT ..
  99
 100 #
 101 # Build the short version of the authors file with formatting codes for the
 102 # man page
 103 # (Depending on ../AUTHORS-SHORT is a bit of a hack to get the file copied
 104 # down there.)
 105 #
 106 AUTHORS-SHORT-FORMAT: ../AUTHORS-SHORT $(srcdir)/make-authors-format.pl
 107         $(AM_V_GEN)$(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-format.pl < AUTHORS-SHORT > AUTHORS-SHORT-FORMAT
 108
 109 wireshark.pod: $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT
 110         $(AM_V_GEN)cat $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT > wireshark.pod
 111
 112 AM_V_POD2MAN = $(am__v_POD2MAN_@AM_V@)
 113 am__v_POD2MAN_ = $(am__v_POD2MAN_@AM_DEFAULT_V@)
 114 am__v_POD2MAN_0 = @echo "  POD2MAN " $@;
 115
 116 AM_V_POD2HTML = $(am__v_POD2HTML_@AM_V@)
 117 am__v_POD2HTML_ = $(am__v_POD2HTML_@AM_DEFAULT_V@)
 118 am__v_POD2HTML_0 = @echo "  POD2HTML" $@;
 119
 120 POD_CSS_URL ?= $(top_srcdir)/docbook/ws.css
 121
 122 .pod.1: ../config.h
 123         $(AM_V_POD2MAN)$(POD2MAN)                       \
 124         --center="The Wireshark Network Analyzer"       \
 125         --release=$(VERSION)                            \
 126         $< > $@
 127
 128 .pod.html: ../config.h $(top_srcdir)/docbook/ws.css
 129         $(AM_V_POD2HTML)$(POD2HTML)                             \
 130         --title="The Wireshark Network Analyzer $(VERSION)"     \
 131         --css=$(POD_CSS_URL)                                    \
 132         --noindex                                               \
 133         $< > $@
 134
 135 # This rule needs to stay separate because of the --section option.
 136 wireshark-filter.4: wireshark-filter.pod ../config.h
 137         $(AM_V_POD2MAN)$(POD2MAN)                       \
 138         --section=4                                     \
 139         --center="The Wireshark Network Analyzer"       \
 140         --release=$(VERSION)                            \
 141         $(srcdir)/wireshark-filter.pod > wireshark-filter.4
 142
 143 # These rules need to stay separate because each man page has a separate
 144 # title.  Using GNU make's pattern rules would allow these to be removed
 145 # but at the cost of portability.
 146 tshark.html: tshark.pod ../config.h $(top_srcdir)/docbook/ws.css
 147         $(AM_V_POD2HTML)$(POD2HTML)                                     \
 148         --title="tshark - The Wireshark Network Analyzer $(VERSION)"    \
 149         --css=$(POD_CSS_URL)                                            \
 150         --noindex                                                       \
 151         $(srcdir)/tshark.pod > tshark.html
 152
 153 wireshark-filter.html: wireshark-filter.pod ../config.h $(top_srcdir)/docbook/ws.css
 154         $(AM_V_POD2HTML)$(POD2HTML)                                             \
 155         --title="wireshark-filter - The Wireshark Network Analyzer $(VERSION)"  \
 156         --css=$(POD_CSS_URL)                                                    \
 157         --noindex                                                               \
 158         $(srcdir)/wireshark-filter.pod > wireshark-filter.html
 159
 160 capinfos.html: capinfos.pod ../config.h $(top_srcdir)/docbook/ws.css
 161         $(AM_V_POD2HTML)$(POD2HTML)                                     \
 162         --title="capinfos - The Wireshark Network Analyzer $(VERSION)"  \
 163         --css=$(POD_CSS_URL)                                            \
 164         --noindex                                                       \
 165         $(srcdir)/capinfos.pod > capinfos.html
 166
 167 editcap.html: editcap.pod ../config.h $(top_srcdir)/docbook/ws.css
 168         $(AM_V_POD2HTML)$(POD2HTML)                                     \
 169         --title="editcap - The Wireshark Network Analyzer $(VERSION)"   \
 170         --css=$(POD_CSS_URL)                                            \
 171         --noindex                                                       \
 172         $(srcdir)/editcap.pod > editcap.html
 173
 174 idl2wrs.html: idl2wrs.pod ../config.h $(top_srcdir)/docbook/ws.css
 175         $(AM_V_POD2HTML)$(POD2HTML)                                     \
 176         --title="idl2wrs - The Wireshark Network Analyzer $(VERSION)"   \
 177         --css=$(POD_CSS_URL)                                            \
 178         --noindex                                                       \
 179         $(srcdir)/idl2wrs.pod > idl2wrs.html
 180
 181 mergecap.html: mergecap.pod ../config.h $(top_srcdir)/docbook/ws.css
 182         $(AM_V_POD2HTML)$(POD2HTML)                                     \
 183         --title="mergecap - The Wireshark Network Analyzer $(VERSION)"  \
 184         --css=$(POD_CSS_URL)                                            \
 185         --noindex                                                       \
 186         $(srcdir)/mergecap.pod > mergecap.html
 187
 188 reordercap.html: reordercap.pod ../config.h $(top_srcdir)/docbook/ws.css
 189         $(AM_V_POD2HTML)$(POD2HTML)                                     \
 190         --title="reordercap - The Wireshark Network Analyzer $(VERSION)"        \
 191         --css=$(POD_CSS_URL)                                            \
 192         --noindex                                                       \
 193         $(srcdir)/reordercap.pod > reordercap.html
 194
 195 text2pcap.html: text2pcap.pod ../config.h $(top_srcdir)/docbook/ws.css
 196         $(AM_V_POD2HTML)$(POD2HTML)                     \
 197         --title="text2pcap - The Wireshark Network Analyzer $(VERSION)" \
 198         --css=$(POD_CSS_URL)                                            \
 199         --noindex                                                       \
 200         $(srcdir)/text2pcap.pod > text2pcap.html
 201
 202 dumpcap.html: dumpcap.pod ../config.h $(top_srcdir)/docbook/ws.css
 203         $(AM_V_POD2HTML)$(POD2HTML)                     \
 204         --title="dumpcap - The Wireshark Network Analyzer $(VERSION)"   \
 205         --css=$(POD_CSS_URL)                                            \
 206         --noindex                                                       \
 207         $(srcdir)/dumpcap.pod > dumpcap.html
 208
 209 rawshark.html: rawshark.pod ../config.h $(top_srcdir)/docbook/ws.css
 210         $(AM_V_POD2HTML)$(POD2HTML)                     \
 211         --title="rawshark - The Wireshark Network Analyzer $(VERSION)"  \
 212         --css=$(POD_CSS_URL)                                            \
 213         --noindex                                                       \
 214         $(srcdir)/rawshark.pod > rawshark.html
 215
 216 dftest.html: dftest.pod ../config.h $(top_srcdir)/docbook/ws.css
 217         $(AM_V_POD2HTML)$(POD2HTML)                     \
 218         --title="dftest - The Wireshark Network Analyzer $(VERSION)"    \
 219         --css=$(POD_CSS_URL)                                            \
 220         --noindex                                                       \
 221         $(srcdir)/dftest.pod > dftest.html
 222
 223 randpkt.html: randpkt.pod ../config.h $(top_srcdir)/docbook/ws.css
 224         $(AM_V_POD2HTML)$(POD2HTML)                     \
 225         --title="randpkt - The Wireshark Network Analyzer $(VERSION)"   \
 226         --css=$(POD_CSS_URL)                                            \
 227         --noindex                                                       \
 228         $(srcdir)/randpkt.pod > randpkt.html
 229
 230 CLEANFILES =            \
 231         wireshark.pod   \
 232         *.1             \
 233         *.4             \
 234         *.html
 235
 236 DISTCLEANFILES =                \
 237         pod2htmi.tmp            \
 238         pod2htmd.tmp            \
 239         AUTHORS-SHORT           \
 240         ../AUTHORS-SHORT        \
 241         AUTHORS-SHORT-FORMAT    \
 242         *~
 243
 244 MAINTAINERCLEANFILES = \
 245         Makefile.in
 246
 247 EXTRA_DIST =                            \
 248         Makefile.nmake                  \
 249         README.capture                  \
 250         README.design                   \
 251         README.developer                \
 252         README.display_filter           \
 253         README.heuristic                \
 254         README.idl2wrs                  \
 255         README.malloc                   \
 256         README.packaging                \
 257         README.plugins                  \
 258         README.python                   \
 259         README.regression               \
 260         README.request_response_tracking\
 261         README.stats_tree               \
 262         README.tapping                  \
 263         README.wmem                     \
 264         README.xml-output               \
 265         asn2deb.pod                     \
 266         capinfos.pod                    \
 267         dfilter2pod.pl                  \
 268         dftest.pod                      \
 269         doc.vcproj                      \
 270         dumpcap.pod                     \
 271         editcap.pod                     \
 272         eproto2sgml                     \
 273         idl2deb.pod                     \
 274         idl2wrs.pod                     \
 275         make-authors-format.pl          \
 276         make-authors-short.pl           \
 277         mergecap.pod                    \
 278         packet-PROTOABBREV.c            \
 279         perlnoutf.pl                    \
 280         randpkt.pod                     \
 281         randpkt.txt                     \
 282         rawshark.pod                    \
 283         reordercap.pod                  \
 284         sgml.doc.template               \
 285         text2pcap.pod                   \
 286         tshark.pod                      \
 287         wireshark-filter.pod            \
 288         wireshark.pod.template
 289