Expose monitor timer interval to lttngctl and client
[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
76if MAN_PAGES_OPT
77# at this point, we know the user asked to build the man pages
78if HAVE_ASCIIDOC_XMLTO
ceb84f55 79# tools
c4ee4984 80ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage
ceb84f55
PP
81ADOC_DOCBOOK = $(ADOC) -b docbook
82XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
83
fd3e1238
PP
84# only add this dependency if we can build the man pages because it's
85# a file generated by the configure script, so it's more recent than
86# the pregenerated man pages in a tarball
87COMMON_DEPS += $(ASCIIDOC_ATTRS_CONF)
88
ceb84f55
PP
89# recipes
90%.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
91 $(ADOC_DOCBOOK) -o $@ $<
92
93%.1: %.1.xml $(XSL_SRC_FILES)
94 $(XTO) $<
95
96%.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
97 $(ADOC_DOCBOOK) -o $@ $<
98
99%.3: %.3.xml $(XSL_SRC_FILES)
100 $(XTO) $<
101
102%.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
103 $(ADOC_DOCBOOK) -o $@ $<
104
105%.8: %.8.xml $(XSL_SRC_FILES)
106 $(XTO) $<
107
a3eae3c9
PP
108# only clean the generated files if we have the tools to generate them again
109CLEANFILES = $(MAN_XML) $(MAN)
110else # HAVE_ASCIIDOC_XMLTO
111# create man page targets used to stop the build if we want to
112# build the man pages, but we don't have the necessary tools to do so
113ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
114ERR_MSG += "Make sure both tools are installed and run the configure script again."
115
116%.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
117 @echo $(ERR_MSG)
118 @false
119
120%.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
121 @echo $(ERR_MSG)
122 @false
123
124%.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
125 @echo $(ERR_MSG)
ceb84f55 126 @false
a3eae3c9
PP
127endif # HAVE_ASCIIDOC_XMLTO
128endif # MAN_PAGES_OPT
129
130# those are always installed since they are directly written in troff
131dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
132dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
133dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
134
135if MAN_PAGES_OPT
136# building man pages: we can install and distribute them
ceb84f55
PP
137dist_man1_MANS += $(MAN1)
138dist_man3_MANS += $(MAN3)
139dist_man8_MANS += $(MAN8)
a3eae3c9
PP
140endif # MAN_PAGES_OPT
141
2f1c0906
PP
142if !MAN_PAGES_OPT
143dist-hook:
144 @echo "Error: Please enable the man pages before creating a distribution tarball."
145 @false
146endif # !MAN_PAGES_OPT
147
a3eae3c9 148# always distribute the source files
c4ee4984
PP
149EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) \
150 $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in
This page took 0.049374 seconds and 5 git commands to generate.