doc/man: create lttng-status(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 MAN3_NAMES =
30 MAN8_NAMES =
31 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
32 MAN3_NO_ASCIIDOC_NAMES =
33 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd lttng-sessiond
34
35 # man pages destinations
36 MAN1 = $(call manaddsuffix,.1,$(MAN1_NAMES))
37 MAN3 = $(call manaddsuffix,.3,$(MAN3_NAMES))
38 MAN8 = $(call manaddsuffix,.8,$(MAN8_NAMES))
39 MAN1_NO_ASCIIDOC = $(call manaddsuffix,.1,$(MAN1_NO_ASCIIDOC_NAMES))
40 MAN3_NO_ASCIIDOC = $(call manaddsuffix,.3,$(MAN3_NO_ASCIIDOC_NAMES))
41 MAN8_NO_ASCIIDOC = $(call manaddsuffix,.8,$(MAN8_NO_ASCIIDOC_NAMES))
42 MAN = $(MAN1) $(MAN3) $(MAN8)
43
44 # those are always installed since they are written in troff
45 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
46 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
47 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
48
49 # only build man pages if it was enabled
50 if BUILD_MAN_PAGES
51 # dist + install
52 dist_man1_MANS += $(MAN1)
53 dist_man3_MANS += $(MAN3)
54 dist_man8_MANS += $(MAN8)
55
56 # AsciiDoc sources and outputs
57 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
58 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
59 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
60 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
61 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
62
63 # common AsciiDoc source files
64 COMMON_TXT = \
65 $(srcdir)/common-footer.txt \
66 $(srcdir)/common-cmd-footer.txt \
67 $(srcdir)/common-cmd-options-head.txt \
68 $(srcdir)/common-cmd-help-options.txt
69
70 # config
71 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
72 XSL_FILES = \
73 manpage.xsl \
74 manpage-base.xsl \
75 manpage-bold-literal.xsl \
76 manpage-ulinks.xsl
77 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
78
79 # common dependencies
80 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT)
81
82 # tools
83 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -d manpage \
84 -a lttng_version=$(PACKAGE_VERSION)
85 ADOC_DOCBOOK = $(ADOC) -b docbook
86 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
87
88 # recipes
89 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
90 $(ADOC_DOCBOOK) -o $@ $<
91
92 %.1: %.1.xml $(XSL_SRC_FILES)
93 $(XTO) $<
94
95 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
96 $(ADOC_DOCBOOK) -o $@ $<
97
98 %.3: %.3.xml $(XSL_SRC_FILES)
99 $(XTO) $<
100
101 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
102 $(ADOC_DOCBOOK) -o $@ $<
103
104 %.8: %.8.xml $(XSL_SRC_FILES)
105 $(XTO) $<
106
107 clean-local:
108 rm -rf $(MAN_XML)
109 rm -rf $(MAN)
110 else
111 if IN_GIT_REPO
112 # we are in the Git repo: the man pages should be built for distribution
113 dist-hook:
114 @echo
115 @echo 'Error: Please build the man pages before creating a tarball.'
116 @echo
117 @false
118 else
119 # we are in the tarball, hence the man pages are already built
120 dist_man1_MANS += $(MAN1)
121 dist_man3_MANS += $(MAN3)
122 dist_man8_MANS += $(MAN8)
123 endif # IN_GIT_REPO
124 endif # BUILD_MAN_PAGES
This page took 0.035412 seconds and 6 git commands to generate.