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-release-notes-1.4.pod \
  42         nbdkit-release-notes-1.6.pod \
  43         nbdkit-release-notes-1.8.pod \
  44         nbdkit-release-notes-1.10.pod \
  45         nbdkit-release-notes-1.12.pod \
  46         nbdkit-release-notes-1.14.pod \
  47         nbdkit-release-notes-1.16.pod \
  48         nbdkit-security.pod \
  49         nbdkit-service.pod \
  50         nbdkit-tls.pod \
  51         nbdkit-plugin.pod \
  52         nbdkit-filter.pod \
  53         synopsis.txt \
  54         $(NULL)
  55
  56 if HAVE_POD
  57
  58 man_MANS = \
  59         nbdkit.1 \
  60         nbdkit-captive.1 \
  61         nbdkit-loop.1 \
  62         nbdkit-probing.1 \
  63         nbdkit-protocol.1 \
  64         nbdkit-release-notes-1.4.1 \
  65         nbdkit-release-notes-1.6.1 \
  66         nbdkit-release-notes-1.8.1 \
  67         nbdkit-release-notes-1.10.1 \
  68         nbdkit-release-notes-1.12.1 \
  69         nbdkit-release-notes-1.14.1 \
  70         nbdkit-release-notes-1.16.1 \
  71         nbdkit-security.1 \
  72         nbdkit-service.1 \
  73         nbdkit-tls.1 \
  74         nbdkit-plugin.3 \
  75         nbdkit-filter.3 \
  76         $(NULL)
  77 CLEANFILES += $(man_MANS)
  78
  79 nbdkit.1: nbdkit.pod plugin-links.pod lang-plugin-links.pod filter-links.pod \
  80                 synopsis.txt
  81         $(PODWRAPPER) --section=1 --man $@ \
  82             --html $(top_builddir)/html/$@.html \
  83             --insert plugin-links.pod:__PLUGIN_LINKS__ \
  84             --insert lang-plugin-links.pod:__LANG_PLUGIN_LINKS__ \
  85             --insert filter-links.pod:__FILTER_LINKS__ \
  86             --verbatim $(srcdir)/synopsis.txt:__SYNOPSIS__ \
  87             $<
  88
  89 nbdkit-captive.1: nbdkit-captive.pod
  90         $(PODWRAPPER) --section=1 --man $@ \
  91             --html $(top_builddir)/html/$@.html \
  92             $<
  93
  94 nbdkit-loop.1: nbdkit-loop.pod
  95         $(PODWRAPPER) --section=1 --man $@ \
  96             --html $(top_builddir)/html/$@.html \
  97             $<
  98
  99 nbdkit-probing.1: nbdkit-probing.pod
 100         $(PODWRAPPER) --section=1 --man $@ \
 101             --html $(top_builddir)/html/$@.html \
 102             $<
 103
 104 nbdkit-protocol.1: nbdkit-protocol.pod
 105         $(PODWRAPPER) --section=1 --man $@ \
 106             --html $(top_builddir)/html/$@.html \
 107             $<
 108
 109 nbdkit-release-notes-1.4.1: nbdkit-release-notes-1.4.pod
 110         $(PODWRAPPER) --section=1 --man $@ \
 111             --html $(top_builddir)/html/$@.html \
 112             $<
 113
 114 nbdkit-release-notes-1.6.1: nbdkit-release-notes-1.6.pod
 115         $(PODWRAPPER) --section=1 --man $@ \
 116             --html $(top_builddir)/html/$@.html \
 117             $<
 118
 119 nbdkit-release-notes-1.8.1: nbdkit-release-notes-1.8.pod
 120         $(PODWRAPPER) --section=1 --man $@ \
 121             --html $(top_builddir)/html/$@.html \
 122             $<
 123
 124 nbdkit-release-notes-1.10.1: nbdkit-release-notes-1.10.pod
 125         $(PODWRAPPER) --section=1 --man $@ \
 126             --html $(top_builddir)/html/$@.html \
 127             $<
 128
 129 nbdkit-release-notes-1.12.1: nbdkit-release-notes-1.12.pod
 130         $(PODWRAPPER) --section=1 --man $@ \
 131             --html $(top_builddir)/html/$@.html \
 132             $<
 133
 134 nbdkit-release-notes-1.14.1: nbdkit-release-notes-1.14.pod
 135         $(PODWRAPPER) --section=1 --man $@ \
 136             --html $(top_builddir)/html/$@.html \
 137             $<
 138
 139 nbdkit-release-notes-1.16.1: nbdkit-release-notes-1.16.pod
 140         $(PODWRAPPER) --section=1 --man $@ \
 141             --html $(top_builddir)/html/$@.html \
 142             $<
 143
 144 nbdkit-security.1: nbdkit-security.pod
 145         $(PODWRAPPER) --section=1 --man $@ \
 146             --html $(top_builddir)/html/$@.html \
 147             $<
 148
 149 nbdkit-service.1: nbdkit-service.pod
 150         $(PODWRAPPER) --section=1 --man $@ \
 151             --html $(top_builddir)/html/$@.html \
 152             $<
 153
 154 nbdkit-tls.1: nbdkit-tls.pod
 155         $(PODWRAPPER) --section=1 --man $@ \
 156             --html $(top_builddir)/html/$@.html \
 157             $<
 158
 159 nbdkit-plugin.3: nbdkit-plugin.pod plugin-links.pod lang-plugin-links.pod
 160         $(PODWRAPPER) --section=3 --man $@ \
 161             --html $(top_builddir)/html/$@.html \
 162             --insert plugin-links.pod:__PLUGIN_LINKS__ \
 163             --insert lang-plugin-links.pod:__LANG_PLUGIN_LINKS__ \
 164             $<
 165
 166 nbdkit-filter.3: nbdkit-filter.pod filter-links.pod
 167         $(PODWRAPPER) --section=3 --man $@ \
 168             --html $(top_builddir)/html/$@.html \
 169             --insert filter-links.pod:__FILTER_LINKS__ \
 170             $<
 171
 172 endif HAVE_POD
 173
 174 # All plugins.
 175 plugin-links.pod: $(top_srcdir)/configure.ac
 176         rm -f $@ $@-t
 177         $(srcdir)/make-links.sh plugin 1 $(non_lang_plugins) > $@-t
 178         echo \; >> $@-t
 179         $(srcdir)/make-links.sh plugin 3 $(lang_plugins) >> $@-t
 180         mv $@-t $@
 181
 182 # Only language plugins (in section 3).
 183 lang-plugin-links.pod: $(top_srcdir)/configure.ac
 184         rm -f $@ $@-t
 185         $(srcdir)/make-links.sh plugin 3 $(lang_plugins) >> $@-t
 186         mv $@-t $@
 187
 188 # All filters.
 189 filter-links.pod: $(top_srcdir)/configure.ac
 190         rm -f $@ $@-t
 191         $(srcdir)/make-links.sh filter 1 $(filters) > $@-t
 192         mv $@-t $@
 193
 194 DISTCLEANFILES = plugin-links.pod lang-plugin-links.pod filter-links.pod