1 # Man pages are only built if the --enable-build-man-pages option was passed
2 # to the configure script.
4 # They should always be built before creating a distribution tarball.
6 # function which adds the source directory prefix and adds a given suffix
7 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
9 # List only the names without the .*.txt extension here:
21 lttng-enable-channel \
22 lttng-disable-channel \
29 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
30 MAN3_NO_ASCIIDOC_NAMES =
31 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
33 # man pages destinations
34 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
35 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
36 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
37 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
38 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
39 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
40 MAN = $(MAN1) $(MAN3) $(MAN8)
42 # those are always installed since they are written in troff
43 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
44 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
45 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
47 # only build man pages if it was enabled
50 dist_man1_MANS += $(MAN1)
51 dist_man3_MANS += $(MAN3)
52 dist_man8_MANS += $(MAN8)
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))
61 # common AsciiDoc source files
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
69 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
73 manpage-bold-literal.xsl \
75 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
78 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
81 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
82 -a lttng_version=$(PACKAGE_VERSION)
83 ADOC_DOCBOOK = $(ADOC) -b docbook
84 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
87 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
88 $(ADOC_DOCBOOK) -o $@ $<
90 %.1: %.1.xml $(XSL_SRC_FILES)
93 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
94 $(ADOC_DOCBOOK) -o $@ $<
96 %.3: %.3.xml $(XSL_SRC_FILES)
99 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
100 $(ADOC_DOCBOOK) -o $@ $<
102 %.8: %.8.xml $(XSL_SRC_FILES)
110 # we are in the Git repo: the man pages should be built for distribution
113 @echo 'Error: Please build the man pages before creating a tarball.'
117 # we are in the tarball, hence the man pages are already built
118 dist_man1_MANS += $(MAN1)
119 dist_man3_MANS += $(MAN3)
120 dist_man8_MANS += $(MAN8)
122 endif # BUILD_MAN_PAGES