doc/man/Makefile.am

   1 # Man pages are only built if they are enabled at configure time.
   2 #
   3 # They should always be built before creating a distribution tarball.
   4
   5 # function which adds the source directory prefix and adds a given suffix
   6 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
   7
   8 # List only the names without the .*.txt extension here:
   9 MAN1_NAMES = \
  10         lttng \
  11         lttng-create \
  12         lttng-destroy \
  13         lttng-set-session \
  14         lttng-save \
  15         lttng-load \
  16         lttng-start \
  17         lttng-stop \
  18         lttng-version \
  19         lttng-view \
  20         lttng-enable-channel \
  21         lttng-disable-channel \
  22         lttng-add-context \
  23         lttng-list \
  24         lttng-track \
  25         lttng-untrack \
  26         lttng-status \
  27         lttng-help \
  28         lttng-snapshot \
  29         lttng-enable-event \
  30         lttng-disable-event \
  31         lttng-crash \
  32         lttng-metadata \
  33         lttng-regenerate
  34 MAN3_NAMES =
  35 MAN8_NAMES = lttng-sessiond lttng-relayd
  36 MAN1_NO_ASCIIDOC_NAMES =
  37 MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
  38 MAN8_NO_ASCIIDOC_NAMES =
  39
  40 # AsciiDoc sources and outputs
  41 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
  42 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
  43 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
  44 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
  45 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
  46
  47 # common AsciiDoc source files
  48 COMMON_TXT = \
  49         $(srcdir)/common-footer.txt \
  50         $(srcdir)/common-cmd-footer.txt \
  51         $(srcdir)/common-cmd-options-head.txt \
  52         $(srcdir)/common-cmd-help-options.txt
  53
  54 # config
  55 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
  56 ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf
  57 XSL_FILES = \
  58         manpage.xsl \
  59         manpage-callouts.xsl \
  60         manpage-bold-literal.xsl \
  61         manpage-links.xsl
  62 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
  63
  64 # common dependencies
  65 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
  66
  67 # man pages destinations
  68 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
  69 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
  70 MAN8 = $(addsuffix .8,$(MAN8_NAMES))
  71 MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
  72 MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
  73 MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
  74 MAN = $(MAN1) $(MAN3) $(MAN8)
  75
  76 # initially empty
  77 CLEANFILES =
  78
  79 if EMBED_HELP
  80 mantoh_verbose = $(mantoh_verbose_@AM_V@)
  81 mantoh_verbose_ = $(mantoh_verbose_@AM_DEFAULT_V@)
  82 mantoh_verbose_0 = @echo "  MANTOH    " $@;
  83
  84 MAN1_H = $(addsuffix .1.h,$(MAN1_NAMES))
  85 MAN3_H = $(addsuffix .3.h,$(MAN3_NAMES))
  86 MAN8_H = $(addsuffix .8.h,$(MAN8_NAMES))
  87 MAN_H = $(MAN1_H) $(MAN3_H) $(MAN8_H)
  88 MAN_H_RECIPE = \
  89         $(mantoh_verbose_0)\
  90         MANWIDTH=80 @MANPROG@ --encoding=UTF-8 --no-hyphenation --no-justification --local-file $< > $@ ; \
  91         $(SED) -i 's/\\/\\\\/g' $@ ; \
  92         $(SED) -i 's/"/\\"/g' $@ ; \
  93         $(SED) -i 's/^\(.*\)$$/"\1\\n"/' $@
  94
  95 %.1.h: %.1
  96         $(MAN_H_RECIPE)
  97
  98 %.3.h: %.3
  99         $(MAN_H_RECIPE)
 100
 101 %.8.h: %.8
 102         $(MAN_H_RECIPE)
 103
 104 all-local: $(MAN_H)
 105
 106 CLEANFILES += $(MAN_H)
 107 endif # EMBED_HELP
 108
 109 if MAN_PAGES_OPT
 110 # at this point, we know the user asked to build the man pages
 111 if HAVE_ASCIIDOC_XMLTO
 112
 113 asciidoc_verbose = $(asciidoc_verbose_@AM_V@)
 114 asciidoc_verbose_ = $(asciidoc_verbose_@AM_DEFAULT_V@)
 115 asciidoc_verbose_0 = @echo "  ASCIIDOC  " $@;
 116
 117 xmlto_verbose = $(xmlto_verbose_@AM_V@)
 118 xmlto_verbose_ = $(xmlto_verbose_@AM_DEFAULT_V@)
 119 xmlto_verbose_0 = @echo "  XMLTO     " $@;
 120
 121 # tools
 122 ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage
 123 ADOC_DOCBOOK = $(ADOC) -b docbook
 124 XTO = $(xmlto_verbose)$(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
 125
 126 # only add this dependency if we can build the man pages because it's
 127 # a file generated by the configure script, so it's more recent than
 128 # the pregenerated man pages in a tarball
 129 COMMON_DEPS += $(ASCIIDOC_ATTRS_CONF)
 130
 131 # recipes
 132 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
 133         $(ADOC_DOCBOOK) -o $@ $<
 134
 135 %.1: %.1.xml $(XSL_SRC_FILES)
 136         $(XTO) $< 2>/dev/null
 137
 138 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
 139         $(ADOC_DOCBOOK) -o $@ $<
 140
 141 %.3: %.3.xml $(XSL_SRC_FILES)
 142         $(XTO) $< 2>/dev/null
 143
 144 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
 145         $(ADOC_DOCBOOK) -o $@ $<
 146
 147 %.8: %.8.xml $(XSL_SRC_FILES)
 148         $(XTO) $< 2>/dev/null
 149
 150 # only clean the generated files if we have the tools to generate them again
 151 CLEANFILES += $(MAN_XML) $(MAN)
 152 else # HAVE_ASCIIDOC_XMLTO
 153 # create man page targets used to stop the build if we want to
 154 # build the man pages, but we don't have the necessary tools to do so
 155 ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
 156 ERR_MSG += "Make sure both tools are installed and run the configure script again."
 157
 158 %.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
 159         @echo $(ERR_MSG)
 160         @false
 161
 162 %.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
 163         @echo $(ERR_MSG)
 164         @false
 165
 166 %.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
 167         @echo $(ERR_MSG)
 168         @false
 169 endif # HAVE_ASCIIDOC_XMLTO
 170 endif # MAN_PAGES_OPT
 171
 172 # those are always installed since they are directly written in troff
 173 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
 174 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
 175 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
 176
 177 if MAN_PAGES_OPT
 178 # building man pages: we can install and distribute them
 179 dist_man1_MANS += $(MAN1)
 180 dist_man3_MANS += $(MAN3)
 181 dist_man8_MANS += $(MAN8)
 182 endif # MAN_PAGES_OPT
 183
 184 if !MAN_PAGES_OPT
 185 dist-hook:
 186         @echo "Error: Please enable the man pages before creating a distribution tarball."
 187         @false
 188 endif # !MAN_PAGES_OPT
 189
 190 # always distribute the source files
 191 EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) \
 192         $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in
 193
 194 # keep generated man pages that can be considered intermediate files
 195 .PRECIOUS: %.1 %.3 %.8