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_man@   \
  73         @rawshark_man@
  74 man4_MANS = @wiresharkfilter_man@
  75 man_MANS =
  76
  77 pkgdata_DATA = AUTHORS-SHORT $(top_srcdir)/docbook/ws.css wireshark.html \
  78         tshark.html wireshark-filter.html capinfos.html editcap.html \
  79         idl2wrs.html mergecap.html text2pcap.html dumpcap.html rawshark.html
  80
  81 #
  82 # Build the short version of the authors file for the about dialog
  83 #
  84 AUTHORS-SHORT: $(top_srcdir)/AUTHORS $(srcdir)/make-authors-short.pl
  85         $(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-short.pl < $(top_srcdir)/AUTHORS > AUTHORS-SHORT
  86
  87 # Put a copy in the top-level directory so Help->About, when run from the
  88 # build directory, can find it.
  89 ../AUTHORS-SHORT: AUTHORS-SHORT
  90         cp AUTHORS-SHORT ..
  91
  92 #
  93 # Build the short version of the authors file with formatting codes for the
  94 # man page
  95 # (Depending on ../AUTHORS-SHORT is a bit of a hack to get the file copied
  96 # down there.)
  97 #
  98 AUTHORS-SHORT-FORMAT: ../AUTHORS-SHORT $(srcdir)/make-authors-format.pl
  99         $(PERL) $(srcdir)/perlnoutf.pl $(srcdir)/make-authors-format.pl < AUTHORS-SHORT > AUTHORS-SHORT-FORMAT
 100
 101 wireshark.pod: $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT
 102         cat $(srcdir)/wireshark.pod.template AUTHORS-SHORT-FORMAT > wireshark.pod
 103
 104 wireshark.1: wireshark.pod ../config.h
 105         $(POD2MAN)                                      \
 106         --center="The Wireshark Network Analyzer"       \
 107         --release=$(VERSION)                            \
 108         wireshark.pod  > wireshark.1
 109
 110 wireshark.html: wireshark.pod ../config.h $(top_srcdir)/docbook/ws.css
 111         $(POD2HTML)                                             \
 112         --title="The Wireshark Network Analyzer $(VERSION)"     \
 113         --css=$(top_srcdir)/docbook/ws.css                      \
 114         --noindex                                               \
 115         wireshark.pod > wireshark.html
 116
 117 tshark.1: tshark.pod ../config.h
 118         $(POD2MAN)                                      \
 119         --center="The Wireshark Network Analyzer"       \
 120         --release=$(VERSION)                            \
 121         $(srcdir)/tshark.pod > tshark.1
 122
 123 tshark.html: tshark.pod ../config.h $(top_srcdir)/docbook/ws.css
 124         $(POD2HTML)                                                     \
 125         --title="tshark - The Wireshark Network Analyzer $(VERSION)"    \
 126         --css=$(top_srcdir)/docbook/ws.css                              \
 127         --noindex                                                       \
 128         $(srcdir)/tshark.pod > tshark.html
 129
 130 wireshark-filter.4: wireshark-filter.pod ../config.h
 131         $(POD2MAN)                                      \
 132         --section=4                                     \
 133         --center="The Wireshark Network Analyzer"       \
 134         --release=$(VERSION)                            \
 135         wireshark-filter.pod > wireshark-filter.4
 136
 137 wireshark-filter.html: wireshark-filter.pod ../config.h $(top_srcdir)/docbook/ws.css
 138         $(POD2HTML)                                                             \
 139         --title="wireshark-filter - The Wireshark Network Analyzer $(VERSION)"  \
 140         --css=$(top_srcdir)/docbook/ws.css                                      \
 141         --noindex                                                               \
 142         wireshark-filter.pod > wireshark-filter.html
 143
 144 wireshark-filter.pod: wireshark-filter.pod.template  ../tshark
 145         WIRESHARK_RUN_FROM_BUILD_DIRECTORY=1 ../tshark -G fields | \
 146         $(PERL) $(srcdir)/dfilter2pod.pl $(srcdir)/wireshark-filter.pod.template > wireshark-filter.pod
 147
 148 capinfos.1: capinfos.pod ../config.h
 149         $(POD2MAN)                                      \
 150         --center="The Wireshark Network Analyzer"       \
 151         --release=$(VERSION)                            \
 152         $(srcdir)/capinfos.pod > capinfos.1
 153
 154 capinfos.html: capinfos.pod ../config.h $(top_srcdir)/docbook/ws.css
 155         $(POD2HTML)                                                     \
 156         --title="capinfos - The Wireshark Network Analyzer $(VERSION)"  \
 157         --css=$(top_srcdir)/docbook/ws.css                              \
 158         --noindex                                                       \
 159         $(srcdir)/capinfos.pod > capinfos.html
 160
 161 editcap.1: editcap.pod ../config.h
 162         $(POD2MAN)                                      \
 163         --center="The Wireshark Network Analyzer"       \
 164         --release=$(VERSION)                            \
 165         $(srcdir)/editcap.pod > editcap.1
 166
 167 editcap.html: editcap.pod ../config.h $(top_srcdir)/docbook/ws.css
 168         $(POD2HTML)                                                     \
 169         --title="editcap - The Wireshark Network Analyzer $(VERSION)"   \
 170         --css=$(top_srcdir)/docbook/ws.css                              \
 171         --noindex                                                       \
 172         $(srcdir)/editcap.pod > editcap.html
 173
 174 idl2wrs.1: idl2wrs.pod ../config.h
 175         $(POD2MAN)                                      \
 176         --center="The Wireshark Network Analyzer"       \
 177         --release=$(VERSION)                            \
 178         $(srcdir)/idl2wrs.pod > idl2wrs.1
 179
 180 idl2wrs.html: idl2wrs.pod ../config.h $(top_srcdir)/docbook/ws.css
 181         $(POD2HTML)                                                     \
 182         --title="idl2wrs - The Wireshark Network Analyzer $(VERSION)"   \
 183         --css=$(top_srcdir)/docbook/ws.css                              \
 184         --noindex                                                       \
 185         $(srcdir)/idl2wrs.pod > idl2wrs.html
 186
 187 mergecap.1: mergecap.pod ../config.h
 188         $(POD2MAN)                                      \
 189         --center="The Wireshark Network Analyzer"       \
 190         --release=$(VERSION)                            \
 191         $(srcdir)/mergecap.pod > mergecap.1
 192
 193 mergecap.html: mergecap.pod ../config.h $(top_srcdir)/docbook/ws.css
 194         $(POD2HTML)                                                     \
 195         --title="mergecap - The Wireshark Network Analyzer $(VERSION)"  \
 196         --css=$(top_srcdir)/docbook/ws.css                              \
 197         --noindex                                                       \
 198         $(srcdir)/mergecap.pod > mergecap.html
 199
 200 text2pcap.1: text2pcap.pod ../config.h
 201         $(POD2MAN)                                      \
 202         --center="The Wireshark Network Analyzer"       \
 203         --release=$(VERSION)                            \
 204         $(srcdir)/text2pcap.pod > text2pcap.1
 205
 206 text2pcap.html: text2pcap.pod ../config.h $(top_srcdir)/docbook/ws.css
 207         $(POD2HTML)                     \
 208         --title="text2pcap - The Wireshark Network Analyzer $(VERSION)" \
 209         --css=$(top_srcdir)/docbook/ws.css                              \
 210         --noindex                                                       \
 211         $(srcdir)/text2pcap.pod > text2pcap.html
 212
 213 dumpcap.1: dumpcap.pod ../config.h
 214         $(POD2MAN)                                      \
 215         --center="The Wireshark Network Analyzer"       \
 216         --release=$(VERSION)                            \
 217         $(srcdir)/dumpcap.pod > dumpcap.1
 218
 219 dumpcap.html: dumpcap.pod ../config.h $(top_srcdir)/docbook/ws.css
 220         $(POD2HTML)                     \
 221         --title="dumpcap - The Wireshark Network Analyzer $(VERSION)"   \
 222         --css=$(top_srcdir)/docbook/ws.css                              \
 223         --noindex                                                       \
 224         $(srcdir)/dumpcap.pod > dumpcap.html
 225
 226 rawshark.1: rawshark.pod ../config.h
 227         $(POD2MAN)                                      \
 228         --center="The Wireshark Network Analyzer"       \
 229         --release=$(VERSION)                            \
 230         $(srcdir)/rawshark.pod > rawshark.1
 231
 232 rawshark.html: rawshark.pod ../config.h $(top_srcdir)/docbook/ws.css
 233         $(POD2HTML)                     \
 234         --title="rawshark - The Wireshark Network Analyzer $(VERSION)"  \
 235         --css=$(top_srcdir)/docbook/ws.css                              \
 236         --noindex                                                       \
 237         $(srcdir)/rawshark.pod > rawshark.html
 238
 239 CLEANFILES =            \
 240         wireshark-filter.pod \
 241         wireshark.pod \
 242         wireshark-filter.4 \
 243         wireshark-filter.html \
 244         wireshark.1     \
 245         wireshark.html  \
 246         capinfos.1      \
 247         capinfos.html   \
 248         editcap.1       \
 249         editcap.html    \
 250         mergecap.1      \
 251         mergecap.html   \
 252         tshark.1        \
 253         tshark.html     \
 254         text2pcap.1     \
 255         text2pcap.html  \
 256         dumpcap.1       \
 257         dumpcap.html    \
 258         idl2wrs.1       \
 259         idl2wrs.html    \
 260         rawshark.1      \
 261         rawshark.html
 262
 263 DISTCLEANFILES =                \
 264         pod2htmi.tmp            \
 265         pod2htmd.tmp            \
 266         AUTHORS-SHORT           \
 267         ../AUTHORS-SHORT        \
 268         AUTHORS-SHORT-FORMAT    \
 269         *~
 270
 271 MAINTAINERCLEANFILES = \
 272         Makefile.in
 273
 274 EXTRA_DIST = \
 275         Makefile.nmake  \
 276         README.binarytrees      \
 277         README.capture  \
 278         README.design   \
 279         README.developer        \
 280         README.display_filter   \
 281         README.idl2wrs  \
 282         README.malloc   \
 283         README.packaging        \
 284         README.plugins  \
 285         README.python \
 286         README.regression   \
 287         README.request_response_tracking        \
 288         README.stats_tree       \
 289         README.tapping  \
 290         README.xml-output       \
 291         doc.vcproj              \
 292         make-authors-format.pl  \
 293         make-authors-short.pl   \
 294         perlnoutf.pl            \
 295         capinfos.pod            \
 296         dfilter2pod.pl  \
 297         dumpcap.pod             \
 298         editcap.pod             \
 299         eproto2sgml             \
 300         idl2wrs.pod             \
 301         mergecap.pod    \
 302         randpkt.txt             \
 303         rawshark.pod    \
 304         sgml.doc.template       \
 305         text2pcap.pod   \
 306         tshark.pod              \
 307         wireshark-filter.pod.template \
 308         wireshark.pod.template
 309