9c7f125d00e08ff3a195186b275cddb370fab3c4
[lttng-tools.git] / doc / man / Makefile.am
1 # Man pages are only built if they are enabled at configure time.
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
6 manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2)))
7
8 # List only the names without the .*.txt extension here:
9 MAN1_NAMES = \
10 lttng \
11 lttng-create \
12 lttng-destroy \
13 lttng-set-session \
14 lttng-save \
15 lttng-load \
16 lttng-start \
17 lttng-stop \
18 lttng-version \
19 lttng-view \
20 lttng-enable-channel \
21 lttng-disable-channel \
22 lttng-add-context \
23 lttng-list \
24 lttng-track \
25 lttng-untrack \
26 lttng-status \
27 lttng-help \
28 lttng-snapshot \
29 lttng-enable-event \
30 lttng-disable-event \
31 lttng-crash \
32 lttng-metadata \
33 lttng-regenerate
34 MAN3_NAMES =
35 MAN8_NAMES = lttng-sessiond lttng-relayd
36 MAN1_NO_ASCIIDOC_NAMES =
37 MAN3_NO_ASCIIDOC_NAMES = lttng-health-check
38 MAN8_NO_ASCIIDOC_NAMES =
39
40 # AsciiDoc sources and outputs
41 MAN1_TXT = $(call manaddsuffix,.1.txt,$(MAN1_NAMES))
42 MAN3_TXT = $(call manaddsuffix,.3.txt,$(MAN3_NAMES))
43 MAN8_TXT = $(call manaddsuffix,.8.txt,$(MAN8_NAMES))
44 MAN_TXT = $(MAN1_TXT) $(MAN3_TXT) $(MAN8_TXT)
45 MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
46
47 # common AsciiDoc source files
48 COMMON_TXT = \
49 $(srcdir)/common-footer.txt \
50 $(srcdir)/common-cmd-footer.txt \
51 $(srcdir)/common-cmd-options-head.txt \
52 $(srcdir)/common-cmd-help-options.txt
53
54 # config
55 ASCIIDOC_CONF = $(srcdir)/asciidoc.conf
56 ASCIIDOC_ATTRS_CONF = $(builddir)/asciidoc-attrs.conf
57 XSL_FILES = \
58 manpage.xsl \
59 manpage-callouts.xsl \
60 manpage-bold-literal.xsl \
61 manpage-links.xsl
62 XSL_SRC_FILES = $(addprefix $(srcdir)/xsl/,$(XSL_FILES))
63
64 # common dependencies
65 COMMON_DEPS = $(ASCIIDOC_CONF) $(COMMON_TXT) $(ASCIIDOC_ATTRS_CONF)
66
67 # man pages destinations
68 MAN1 = $(addsuffix .1,$(MAN1_NAMES))
69 MAN3 = $(addsuffix .3,$(MAN3_NAMES))
70 MAN8 = $(addsuffix .8,$(MAN8_NAMES))
71 MAN1_NO_ASCIIDOC = $(addsuffix .1,$(MAN1_NO_ASCIIDOC_NAMES))
72 MAN3_NO_ASCIIDOC = $(addsuffix .3,$(MAN3_NO_ASCIIDOC_NAMES))
73 MAN8_NO_ASCIIDOC = $(addsuffix .8,$(MAN8_NO_ASCIIDOC_NAMES))
74 MAN = $(MAN1) $(MAN3) $(MAN8)
75
76 if MAN_PAGES_OPT
77 # at this point, we know the user asked to build the man pages
78 if HAVE_ASCIIDOC_XMLTO
79 # tools
80 ADOC = $(ASCIIDOC) -f $(ASCIIDOC_CONF) -f $(ASCIIDOC_ATTRS_CONF) -d manpage
81 ADOC_DOCBOOK = $(ADOC) -b docbook
82 XTO = $(XMLTO) -m $(firstword $(XSL_SRC_FILES)) man
83
84 # recipes
85 %.1.xml: $(srcdir)/%.1.txt $(COMMON_DEPS)
86 $(ADOC_DOCBOOK) -o $@ $<
87
88 %.1: %.1.xml $(XSL_SRC_FILES)
89 $(XTO) $<
90
91 %.3.xml: $(srcdir)/%.3.txt $(COMMON_DEPS)
92 $(ADOC_DOCBOOK) -o $@ $<
93
94 %.3: %.3.xml $(XSL_SRC_FILES)
95 $(XTO) $<
96
97 %.8.xml: $(srcdir)/%.8.txt $(COMMON_DEPS)
98 $(ADOC_DOCBOOK) -o $@ $<
99
100 %.8: %.8.xml $(XSL_SRC_FILES)
101 $(XTO) $<
102
103 # only clean the generated files if we have the tools to generate them again
104 CLEANFILES = $(MAN_XML) $(MAN)
105 else # HAVE_ASCIIDOC_XMLTO
106 # create man page targets used to stop the build if we want to
107 # build the man pages, but we don't have the necessary tools to do so
108 ERR_MSG = "Error: Cannot build target because asciidoc or xmlto tool is missing."
109 ERR_MSG += "Make sure both tools are installed and run the configure script again."
110
111 %.1: $(srcdir)/%.1.txt $(COMMON_DEPS)
112 @echo $(ERR_MSG)
113 @false
114
115 %.3: $(srcdir)/%.3.txt $(COMMON_DEPS)
116 @echo $(ERR_MSG)
117 @false
118
119 %.8: $(srcdir)/%.8.txt $(COMMON_DEPS)
120 @echo $(ERR_MSG)
121 @false
122 endif # HAVE_ASCIIDOC_XMLTO
123 endif # MAN_PAGES_OPT
124
125 # those are always installed since they are directly written in troff
126 dist_man1_MANS = $(MAN1_NO_ASCIIDOC)
127 dist_man3_MANS = $(MAN3_NO_ASCIIDOC)
128 dist_man8_MANS = $(MAN8_NO_ASCIIDOC)
129
130 if MAN_PAGES_OPT
131 # building man pages: we can install and distribute them
132 dist_man1_MANS += $(MAN1)
133 dist_man3_MANS += $(MAN3)
134 dist_man8_MANS += $(MAN8)
135 endif # MAN_PAGES_OPT
136
137 if !MAN_PAGES_OPT
138 dist-hook:
139 @echo "Error: Please enable the man pages before creating a distribution tarball."
140 @false
141 endif # !MAN_PAGES_OPT
142
143 # always distribute the source files
144 EXTRA_DIST = $(MAN_TXT) $(COMMON_TXT) $(XSL_SRC_FILES) \
145 $(ASCIIDOC_CONF) $(ASCIIDOC_ATTRS_CONF).in
This page took 0.04634 seconds and 3 git commands to generate.