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