Cleanup: popt library detection
[lttng-tools.git] / doc / man / Makefile.am
CommitLineData
6f6794a6 1# Man pages are only built if they are enabled at configure time.
ceb84f55
PP
2#
3# They should always be built before creating a distribution tarball.
4
5# function which adds the source directory prefix and adds a given suffix
6manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
7
8# List only the names without the .*.txt extension here:
9MAN1_NAMES = \
ba50d967 10 lttng \
7bf169bd 11 lttng-create \
9d4408b8 12 lttng-destroy \
b3903b3a 13 lttng-set-session \
44f5039e 14 lttng-save \
30ec772c 15 lttng-load \
fb58d659 16 lttng-start \
e85eccc8 17 lttng-stop \
79e094df 18 lttng-version \
b4867b3b 19 lttng-view \
4bf0a332 20 lttng-enable-channel \
2e4886b8 21 lttng-disable-channel \
882108c6 22 lttng-add-context \
89dbeff8 23 lttng-list \
882443a6 24 lttng-track \
18d6fa61 25 lttng-untrack \
afaad15a 26 lttng-status \
12397c59 27 lttng-help \
e9b06e2b 28 lttng-snapshot \
290294e8 29 lttng-enable-event \
aec4668a 30 lttng-disable-event \
11533074 31 lttng-crash \
eded6438
JD
32 lttng-metadata \
33 lttng-regenerate
ceb84f55 34MAN3_NAMES =
f5595c32 35MAN8_NAMES = lttng-sessiond lttng-relayd
aec4668a 36MAN1_NO_ASCIIDOC_NAMES =
23225252 37MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
f5595c32 38MAN8_NO_ASCIIDOC_NAMES =
ceb84f55 39
ceb84f55
PP
40# AsciiDoc sources and outputs
41MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
42MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
43MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
44MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
45MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
46
47# common AsciiDoc source files
48COMMON_TXT = \
49 $(srcdir)/common-footer.txt \
83f27f71 50 $(srcdir)/common-cmd-footer.txt \
ba50d967
PP
51 $(srcdir)/common-cmd-options-head.txt \
52 $(srcdir)/common-cmd-help-options.txt
ceb84f55
PP
53
54# config
767ab8b2 55ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
c4ee4984 56ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf
ceb84f55
PP
57XSL_FILES = \
58 manpage.xsl \
41af7458 59 manpage-callouts.xsl \
ceb84f55 60 manpage-bold-literal.xsl \
4d7f0487 61 manpage-links.xsl
ceb84f55
PP
62XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
63
64# common dependencies
fd3e1238 65COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
ceb84f55 66
a3eae3c9
PP
67# man pages destinations
68MAN1 = $(addsuffix .1,$(MAN1_NAMES))
69MAN3 = $(addsuffix .3,$(MAN3_NAMES))
70MAN8 = $(addsuffix .8,$(MAN8_NAMES))
71MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
72MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
73MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
74MAN = $(MAN1) $(MAN3) $(MAN8)
75
4fc83d94
PP
76# initially empty
77CLEANFILES =
78
79if EMBED_HELP
80MAN1_H = $(addsuffix .1.h,$(MAN1_NAMES))
81MAN3_H = $(addsuffix .3.h,$(MAN3_NAMES))
82MAN8_H = $(addsuffix .8.h,$(MAN8_NAMES))
83MAN_H = $(MAN1_H) $(MAN3_H) $(MAN8_H)
84MAN_H_RECIPE = \
85 MANWIDTH=80 @MANPROG@ --encoding=UTF-8 --no-hyphenation --no-justification --local-file $< > $@ ; \
86 $(SED) -i 's/\\/\\\\/g' $@ ; \
87 $(SED) -i 's/"/\\"/g' $@ ; \
88 $(SED) -i 's/^\(.*\)$$/"\1\\n"/' $@
89
90%.1.h: %.1
91 $(MAN_H_RECIPE)
92
93%.3.h: %.3
94 $(MAN_H_RECIPE)
95
96%.8.h: %.8
97 $(MAN_H_RECIPE)
98
99all-local: $(MAN_H)
100
101CLEANFILES += $(MAN_H)
102endif # EMBED_HELP
103
a3eae3c9
PP
104if MAN_PAGES_OPT
105# at this point, we know the user asked to build the man pages
106if HAVE_ASCIIDOC_XMLTO
ceb84f55 107# tools
c4ee4984 108ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage
ceb84f55
PP
109ADOC_DOCBOOK = $(ADOC) -b docbook
110XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
111
fd3e1238
PP
112# only add this dependency if we can build the man pages because it's
113# a file generated by the configure script, so it's more recent than
114# the pregenerated man pages in a tarball
115COMMON_DEPS += $(ASCIIDOC_ATTRS_CONF)
116
ceb84f55
PP
117# recipes
118%.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
119 $(ADOC_DOCBOOK) -o $@ $<
120
121%.1: %.1.xml $(XSL_SRC_FILES)
122 $(XTO) $<
123
124%.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
125 $(ADOC_DOCBOOK) -o $@ $<
126
127%.3: %.3.xml $(XSL_SRC_FILES)
128 $(XTO) $<
129
130%.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
131 $(ADOC_DOCBOOK) -o $@ $<
132
133%.8: %.8.xml $(XSL_SRC_FILES)
134 $(XTO) $<
135
a3eae3c9 136# only clean the generated files if we have the tools to generate them again
4fc83d94 137CLEANFILES += $(MAN_XML) $(MAN)
a3eae3c9
PP
138else # HAVE_ASCIIDOC_XMLTO
139# create man page targets used to stop the build if we want to
140# build the man pages, but we don't have the necessary tools to do so
141ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
142ERR_MSG += "Make sure both tools are installed and run the configure script again."
143
144%.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
145 @echo $(ERR_MSG)
146 @false
147
148%.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
149 @echo $(ERR_MSG)
150 @false
151
152%.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
153 @echo $(ERR_MSG)
ceb84f55 154 @false
a3eae3c9
PP
155endif # HAVE_ASCIIDOC_XMLTO
156endif # MAN_PAGES_OPT
157
158# those are always installed since they are directly written in troff
159dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
160dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
161dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
162
163if MAN_PAGES_OPT
164# building man pages: we can install and distribute them
ceb84f55
PP
165dist_man1_MANS += $(MAN1)
166dist_man3_MANS += $(MAN3)
167dist_man8_MANS += $(MAN8)
a3eae3c9
PP
168endif # MAN_PAGES_OPT
169
2f1c0906
PP
170if !MAN_PAGES_OPT
171dist-hook:
172 @echo "Error: Please enable the man pages before creating a distribution tarball."
173 @false
174endif # !MAN_PAGES_OPT
175
a3eae3c9 176# always distribute the source files
c4ee4984
PP
177EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) \
178 $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in
4fc83d94
PP
179
180# keep generated man pages that can be considered intermediate files
181.PRECIOUS: %.1 %.3 %.8
This page took 0.054086 seconds and 5 git commands to generate.