docs/Makefile.am

   1 # nbdkit
   2 # Copyright (C) 2013-2018 Red Hat Inc.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met:
   7 #
   8 # * Redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer.
  10 #
  11 # * Redistributions in binary form must reproduce the above copyright
  12 # notice, this list of conditions and the following disclaimer in the
  13 # documentation and/or other materials provided with the distribution.
  14 #
  15 # * Neither the name of Red Hat nor the names of its contributors may be
  16 # used to endorse or promote products derived from this software without
  17 # specific prior written permission.
  18 #
  19 # THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  20 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21 # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22 # PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  23 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  28 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  29 # OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 # SUCH DAMAGE.
  31
  32 include $(top_srcdir)/common-rules.mk
  33
  34 EXTRA_DIST = \
  35         make-links.sh \
  36         nbdkit.pod \
  37         nbdkit-captive.pod \
  38         nbdkit-loop.pod \
  39         nbdkit-probing.pod \
  40         nbdkit-protocol.pod \
  41         nbdkit-service.pod \
  42         nbdkit-tls.pod \
  43         nbdkit-plugin.pod \
  44         nbdkit-filter.pod \
  45         synopsis.txt \
  46         $(NULL)
  47
  48 if HAVE_POD
  49
  50 man_MANS = \
  51         nbdkit.1 \
  52         nbdkit-captive.1 \
  53         nbdkit-loop.1 \
  54         nbdkit-probing.1 \
  55         nbdkit-protocol.1 \
  56         nbdkit-service.1 \
  57         nbdkit-tls.1 \
  58         nbdkit-plugin.3 \
  59         nbdkit-filter.3 \
  60         $(NULL)
  61 CLEANFILES += $(man_MANS)
  62
  63 nbdkit.1: nbdkit.pod plugin-links.pod lang-plugin-links.pod filter-links.pod \
  64                 synopsis.txt
  65         $(PODWRAPPER) --section=1 --man $@ \
  66             --html $(top_builddir)/html/$@.html \
  67             --insert plugin-links.pod:__PLUGIN_LINKS__ \
  68             --insert lang-plugin-links.pod:__LANG_PLUGIN_LINKS__ \
  69             --insert filter-links.pod:__FILTER_LINKS__ \
  70             --verbatim $(srcdir)/synopsis.txt:__SYNOPSIS__ \
  71             $<
  72
  73 nbdkit-captive.1: nbdkit-captive.pod
  74         $(PODWRAPPER) --section=1 --man $@ \
  75             --html $(top_builddir)/html/$@.html \
  76             $<
  77
  78 nbdkit-loop.1: nbdkit-loop.pod
  79         $(PODWRAPPER) --section=1 --man $@ \
  80             --html $(top_builddir)/html/$@.html \
  81             $<
  82
  83 nbdkit-probing.1: nbdkit-probing.pod
  84         $(PODWRAPPER) --section=1 --man $@ \
  85             --html $(top_builddir)/html/$@.html \
  86             $<
  87
  88 nbdkit-protocol.1: nbdkit-protocol.pod
  89         $(PODWRAPPER) --section=1 --man $@ \
  90             --html $(top_builddir)/html/$@.html \
  91             $<
  92
  93 nbdkit-service.1: nbdkit-service.pod
  94         $(PODWRAPPER) --section=1 --man $@ \
  95             --html $(top_builddir)/html/$@.html \
  96             $<
  97
  98 nbdkit-tls.1: nbdkit-tls.pod
  99         $(PODWRAPPER) --section=1 --man $@ \
 100             --html $(top_builddir)/html/$@.html \
 101             $<
 102
 103 nbdkit-plugin.3: nbdkit-plugin.pod plugin-links.pod lang-plugin-links.pod
 104         $(PODWRAPPER) --section=3 --man $@ \
 105             --html $(top_builddir)/html/$@.html \
 106             --insert plugin-links.pod:__PLUGIN_LINKS__ \
 107             --insert lang-plugin-links.pod:__LANG_PLUGIN_LINKS__ \
 108             $<
 109
 110 nbdkit-filter.3: nbdkit-filter.pod filter-links.pod
 111         $(PODWRAPPER) --section=3 --man $@ \
 112             --html $(top_builddir)/html/$@.html \
 113             --insert filter-links.pod:__FILTER_LINKS__ \
 114             $<
 115
 116 endif HAVE_POD
 117
 118 # All plugins.
 119 plugin-links.pod: $(top_srcdir)/configure.ac
 120         rm -f $@ $@-t
 121         $(srcdir)/make-links.sh plugin 1 $(non_lang_plugins) > $@-t
 122         echo \; >> $@-t
 123         $(srcdir)/make-links.sh plugin 3 $(lang_plugins) >> $@-t
 124         mv $@-t $@
 125
 126 # Only language plugins (in section 3).
 127 lang-plugin-links.pod: $(top_srcdir)/configure.ac
 128         rm -f $@ $@-t
 129         $(srcdir)/make-links.sh plugin 3 $(lang_plugins) >> $@-t
 130         mv $@-t $@
 131
 132 # All filters.
 133 filter-links.pod: $(top_srcdir)/configure.ac
 134         rm -f $@ $@-t
 135         $(srcdir)/make-links.sh filter 1 $(filters) > $@-t
 136         mv $@-t $@
 137
 138 DISTCLEANFILES = plugin-links.pod lang-plugin-links.pod filter-links.pod