1 # Man pages are only built if they are enabled at configure time.
3 # They should always be built before creating a distribution tarball.
5 # function which adds the source directory prefix and adds a given suffix
6 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
8 # List only the names without the .*.txt extension here:
20 lttng-enable-channel \
21 lttng-disable-channel \
35 lttng-enable-rotation \
36 lttng-disable-rotation \
39 MAN8_NAMES = lttng-sessiond lttng-relayd
40 MAN1_NO_ASCIIDOC_NAMES =
41 MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
42 MAN8_NO_ASCIIDOC_NAMES =
44 # AsciiDoc sources and outputs
45 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
46 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
47 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
48 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
49 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
51 # common AsciiDoc source files
53 $(srcdir)/common-footer.txt \
54 $(srcdir)/common-cmd-footer.txt \
55 $(srcdir)/common-cmd-options-head.txt \
56 $(srcdir)/common-cmd-help-options.txt
59 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
60 ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf
61 XSL_FILE = $(srcdir)/manpage.xsl
64 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
66 # man pages destinations
67 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
68 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
69 MAN8 = $(addsuffix .8,$(MAN8_NAMES))
70 MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
71 MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
72 MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
73 MAN = $(MAN1) $(MAN3) $(MAN8)
79 mantoh_verbose = $(mantoh_verbose_@AM_V@)
80 mantoh_verbose_ = $(mantoh_verbose_@AM_DEFAULT_V@)
81 mantoh_verbose_0 = @echo " MANTOH " $@;
83 MAN1_H = $(addsuffix .1.h,$(MAN1_NAMES))
84 MAN3_H = $(addsuffix .3.h,$(MAN3_NAMES))
85 MAN8_H = $(addsuffix .8.h,$(MAN8_NAMES))
86 MAN_H = $(MAN1_H) $(MAN3_H) $(MAN8_H)
89 MANWIDTH=80 @MANPROG@ --encoding=UTF-8 --no-hyphenation --no-justification --local-file $< > $@ ; \
90 $(SED) -i 's/\\/\\\\/g' $@ ; \
91 $(SED) -i 's/"/\\"/g' $@ ; \
92 $(SED) -i 's/^\(.*\)$$/"\1\\n"/' $@
105 CLEANFILES += $(MAN_H)
109 # at this point, we know the user asked to build the man pages
110 if HAVE_ASCIIDOC_XMLTO
112 asciidoc_verbose = $(asciidoc_verbose_@AM_V@)
113 asciidoc_verbose_ = $(asciidoc_verbose_@AM_DEFAULT_V@)
114 asciidoc_verbose_0 = @echo " ASCIIDOC " $@;
116 xmlto_verbose = $(xmlto_verbose_@AM_V@)
117 xmlto_verbose_ = $(xmlto_verbose_@AM_DEFAULT_V@)
118 xmlto_verbose_0 = @echo " XMLTO " $@;
121 ADOC = $(asciidoc_verbose)$(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage
122 ADOC_DOCBOOK = $(ADOC) -b docbook
123 XTO = $(xmlto_verbose)$(XMLTO) -m $(XSL_FILE) man
125 # only add this dependency if we can build the man pages because it's
126 # a file generated by the configure script, so it's more recent than
127 # the pregenerated man pages in a tarball
128 COMMON_DEPS += $(ASCIIDOC_ATTRS_CONF)
131 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
132 $(ADOC_DOCBOOK) -o $@ $<
134 %.1: %.1.xml $(XSL_FILE)
135 $(XTO) $< 2>/dev/null
137 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
138 $(ADOC_DOCBOOK) -o $@ $<
140 %.3: %.3.xml $(XSL_FILE)
141 $(XTO) $< 2>/dev/null
143 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
144 $(ADOC_DOCBOOK) -o $@ $<
146 %.8: %.8.xml $(XSL_FILE)
147 $(XTO) $< 2>/dev/null
149 # only clean the generated files if we have the tools to generate them again
150 CLEANFILES += $(MAN_XML) $(MAN)
151 else # HAVE_ASCIIDOC_XMLTO
152 # create man page targets used to stop the build if we want to
153 # build the man pages, but we don't have the necessary tools to do so
154 ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
155 ERR_MSG += "Make sure both tools are installed and run the configure script again."
157 %.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
161 %.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
165 %.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
168 endif # HAVE_ASCIIDOC_XMLTO
169 endif # MAN_PAGES_OPT
171 # those are always installed since they are directly written in troff
172 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
173 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
174 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
177 # building man pages: we can install and distribute them
178 dist_man1_MANS += $(MAN1)
179 dist_man3_MANS += $(MAN3)
180 dist_man8_MANS += $(MAN8)
181 endif # MAN_PAGES_OPT
185 @echo "Error: Please enable the man pages before creating a distribution tarball."
187 endif # !MAN_PAGES_OPT
189 # always distribute the source files
190 EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_FILE) \
191 $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in
193 # keep generated man pages that can be considered intermediate files
194 .PRECIOUS: %.1 %.3 %.8