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:
14 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
15 MAN3_NO_ASCIIDOC_NAMES =
16 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
18 # man pages destinations
19 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
20 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
21 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
22 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
23 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
24 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
25 MAN = $(MAN1) $(MAN3) $(MAN8)
27 # those are always installed since they are written in troff
28 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
29 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
30 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
32 # only build man pages if it was enabled
35 dist_man1_MANS += $(MAN1)
36 dist_man3_MANS += $(MAN3)
37 dist_man8_MANS += $(MAN8)
39 # AsciiDoc sources and outputs
40 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
41 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
42 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
43 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
44 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
46 # common AsciiDoc source files
48 $(srcdir)/common-footer.txt \
49 $(srcdir)/common-cmd-footer.txt \
50 $(srcdir)/common-cmd-options-head.txt
53 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
57 manpage-bold-literal.xsl \
59 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
62 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
65 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
66 -a lttng_version=$(PACKAGE_VERSION)
67 ADOC_DOCBOOK = $(ADOC) -b docbook
68 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
71 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
72 $(ADOC_DOCBOOK) -o $@ $<
74 %.1: %.1.xml $(XSL_SRC_FILES)
77 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
78 $(ADOC_DOCBOOK) -o $@ $<
80 %.3: %.3.xml $(XSL_SRC_FILES)
83 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
84 $(ADOC_DOCBOOK) -o $@ $<
86 %.8: %.8.xml $(XSL_SRC_FILES)
94 # we are in the Git repo: the man pages should be built for distribution
97 @echo 'Error: Please build the man pages before creating a tarball.'
101 # we are in the tarball, hence the man pages are already built
102 dist_man1_MANS += $(MAN1)
103 dist_man3_MANS += $(MAN3)
104 dist_man8_MANS += $(MAN8)
106 endif # BUILD_MAN_PAGES