doc/man: create lttng-disable-event(1) and update/fix content
[lttng-tools.git] / doc / man / Makefile.am
1 # Man pages are only built if the --enable-build-man-pages option was passed
2 # to the configure script.
3 #
4 # They should always be built before creating a distribution tarball.
5
6 # function which adds the source directory prefix and adds a given suffix
7 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
8
9 # List only the names without the .*.txt extension here:
10 MAN1_NAMES = \
11 lttng \
12 lttng-create \
13 lttng-destroy \
14 lttng-set-session \
15 lttng-save \
16 lttng-load \
17 lttng-start \
18 lttng-stop \
19 lttng-version \
20 lttng-view \
21 lttng-enable-channel \
22 lttng-disable-channel \
23 lttng-add-context \
24 lttng-list \
25 lttng-calibrate \
26 lttng-track \
27 lttng-untrack \
28 lttng-status \
29 lttng-help \
30 lttng-snapshot \
31 lttng-enable-event \
32 lttng-disable-event
33 MAN3_NAMES =
34 MAN8_NAMES =
35 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
36 MAN3_NO_ASCIIDOC_NAMES =
37 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
38
39 # man pages destinations
40 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
41 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
42 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
43 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
44 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
45 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
46 MAN = $(MAN1) $(MAN3) $(MAN8)
47
48 # those are always installed since they are written in troff
49 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
50 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
51 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
52
53 # only build man pages if it was enabled
54 if BUILD_MAN_PAGES
55 # dist + install
56 dist_man1_MANS += $(MAN1)
57 dist_man3_MANS += $(MAN3)
58 dist_man8_MANS += $(MAN8)
59
60 # AsciiDoc sources and outputs
61 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
62 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
63 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
64 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
65 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
66
67 # common AsciiDoc source files
68 COMMON_TXT = \
69 $(srcdir)/common-footer.txt \
70 $(srcdir)/common-cmd-footer.txt \
71 $(srcdir)/common-cmd-options-head.txt \
72 $(srcdir)/common-cmd-help-options.txt
73
74 # config
75 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
76 XSL_FILES = \
77 manpage.xsl \
78 manpage-base.xsl \
79 manpage-bold-literal.xsl \
80 manpage-ulinks.xsl
81 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
82
83 # common dependencies
84 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
85
86 # tools
87 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
88 -a lttng_version=$(PACKAGE_VERSION)
89 ADOC_DOCBOOK = $(ADOC) -b docbook
90 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
91
92 # recipes
93 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
94 $(ADOC_DOCBOOK) -o $@ $<
95
96 %.1: %.1.xml $(XSL_SRC_FILES)
97 $(XTO) $<
98
99 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
100 $(ADOC_DOCBOOK) -o $@ $<
101
102 %.3: %.3.xml $(XSL_SRC_FILES)
103 $(XTO) $<
104
105 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
106 $(ADOC_DOCBOOK) -o $@ $<
107
108 %.8: %.8.xml $(XSL_SRC_FILES)
109 $(XTO) $<
110
111 clean-local:
112 rm -rf $(MAN_XML)
113 rm -rf $(MAN)
114 else
115 if IN_GIT_REPO
116 # we are in the Git repo: the man pages should be built for distribution
117 dist-hook:
118 @echo
119 @echo 'Error: Please build the man pages before creating a tarball.'
120 @echo
121 @false
122 else
123 # we are in the tarball, hence the man pages are already built
124 dist_man1_MANS += $(MAN1)
125 dist_man3_MANS += $(MAN3)
126 dist_man8_MANS += $(MAN8)
127 endif # IN_GIT_REPO
128 endif # BUILD_MAN_PAGES
This page took 0.045986 seconds and 4 git commands to generate.