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