doc/man/Makefile.am

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