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