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