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 \
36 MAN8_NAMES = lttng-sessiond lttng-relayd
37 MAN1_NO_ASCIIDOC_NAMES =
38 MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
39 MAN8_NO_ASCIIDOC_NAMES =
41 # man pages destinations
42 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
43 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
44 MAN8 = $(addsuffix .8,$(MAN8_NAMES))
45 MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
46 MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
47 MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
48 MAN = $(MAN1) $(MAN3) $(MAN8)
50 # those are always installed since they are written in troff
51 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
52 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
53 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
55 # only build man pages if it was enabled
58 dist_man1_MANS += $(MAN1)
59 dist_man3_MANS += $(MAN3)
60 dist_man8_MANS += $(MAN8)
62 # AsciiDoc sources and outputs
63 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
64 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
65 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
66 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
67 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
69 # common AsciiDoc source files
71 $(srcdir)/common-footer.txt \
72 $(srcdir)/common-cmd-footer.txt \
73 $(srcdir)/common-cmd-options-head.txt \
74 $(srcdir)/common-cmd-help-options.txt
77 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
81 manpage-bold-literal.xsl \
83 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
86 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
89 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
90 -a lttng_version=$(PACKAGE_VERSION)
91 ADOC_DOCBOOK = $(ADOC) -b docbook
92 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
95 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
96 $(ADOC_DOCBOOK) -o $@ $<
98 %.1: %.1.xml $(XSL_SRC_FILES)
101 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
102 $(ADOC_DOCBOOK) -o $@ $<
104 %.3: %.3.xml $(XSL_SRC_FILES)
107 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
108 $(ADOC_DOCBOOK) -o $@ $<
110 %.8: %.8.xml $(XSL_SRC_FILES)
118 # we are in the Git repo: the man pages should be built for distribution
121 @echo 'Error: Please build the man pages before creating a tarball.'
125 # we are in the tarball, hence the man pages are already built
126 dist_man1_MANS += $(MAN1)
127 dist_man3_MANS += $(MAN3)
128 dist_man8_MANS += $(MAN8)
130 endif # BUILD_MAN_PAGES