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 \
28 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
29 MAN3_NO_ASCIIDOC_NAMES =
30 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
32 # man pages destinations
33 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
34 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
35 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
36 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
37 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
38 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
39 MAN = $(MAN1) $(MAN3) $(MAN8)
41 # those are always installed since they are written in troff
42 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
43 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
44 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
46 # only build man pages if it was enabled
49 dist_man1_MANS += $(MAN1)
50 dist_man3_MANS += $(MAN3)
51 dist_man8_MANS += $(MAN8)
53 # AsciiDoc sources and outputs
54 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
55 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
56 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
57 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
58 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
60 # common AsciiDoc source files
62 $(srcdir)/common-footer.txt \
63 $(srcdir)/common-cmd-footer.txt \
64 $(srcdir)/common-cmd-options-head.txt \
65 $(srcdir)/common-cmd-help-options.txt
68 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
72 manpage-bold-literal.xsl \
74 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
77 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
80 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
81 -a lttng_version=$(PACKAGE_VERSION)
82 ADOC_DOCBOOK = $(ADOC) -b docbook
83 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
86 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
87 $(ADOC_DOCBOOK) -o $@ $<
89 %.1: %.1.xml $(XSL_SRC_FILES)
92 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
93 $(ADOC_DOCBOOK) -o $@ $<
95 %.3: %.3.xml $(XSL_SRC_FILES)
98 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
99 $(ADOC_DOCBOOK) -o $@ $<
101 %.8: %.8.xml $(XSL_SRC_FILES)
109 # we are in the Git repo: the man pages should be built for distribution
112 @echo 'Error: Please build the man pages before creating a tarball.'
116 # we are in the tarball, hence the man pages are already built
117 dist_man1_MANS += $(MAN1)
118 dist_man3_MANS += $(MAN3)
119 dist_man8_MANS += $(MAN8)
121 endif # BUILD_MAN_PAGES