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 \
25 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
26 MAN3_NO_ASCIIDOC_NAMES =
27 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
29 # man pages destinations
30 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
31 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
32 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
33 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
34 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
35 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
36 MAN = $(MAN1) $(MAN3) $(MAN8)
38 # those are always installed since they are written in troff
39 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
40 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
41 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
43 # only build man pages if it was enabled
46 dist_man1_MANS += $(MAN1)
47 dist_man3_MANS += $(MAN3)
48 dist_man8_MANS += $(MAN8)
50 # AsciiDoc sources and outputs
51 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
52 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
53 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
54 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
55 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
57 # common AsciiDoc source files
59 $(srcdir)/common-footer.txt \
60 $(srcdir)/common-cmd-footer.txt \
61 $(srcdir)/common-cmd-options-head.txt \
62 $(srcdir)/common-cmd-help-options.txt
65 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
69 manpage-bold-literal.xsl \
71 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
74 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
77 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
78 -a lttng_version=$(PACKAGE_VERSION)
79 ADOC_DOCBOOK = $(ADOC) -b docbook
80 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
83 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
84 $(ADOC_DOCBOOK) -o $@ $<
86 %.1: %.1.xml $(XSL_SRC_FILES)
89 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
90 $(ADOC_DOCBOOK) -o $@ $<
92 %.3: %.3.xml $(XSL_SRC_FILES)
95 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
96 $(ADOC_DOCBOOK) -o $@ $<
98 %.8: %.8.xml $(XSL_SRC_FILES)
106 # we are in the Git repo: the man pages should be built for distribution
109 @echo 'Error: Please build the man pages before creating a tarball.'
113 # we are in the tarball, hence the man pages are already built
114 dist_man1_MANS += $(MAN1)
115 dist_man3_MANS += $(MAN3)
116 dist_man8_MANS += $(MAN8)
118 endif # BUILD_MAN_PAGES