mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-03 09:01:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
wayland/doc/man/Makefile.am

53 lines
1.3 KiB
Text
Raw Normal View History

man: add man-page infrastructure This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-24 13:18:38 +02:00
#
# This generates man-pages out of the Docbook XML files. Simply add your files
# to the $MANPAGES array. If aliases are created, please add them to the
# MANPAGES_ALIASES array so they get installed correctly.
#
MANPAGES = \
wl_display_connect.3
MANPAGES_ALIASES = \
wl_display_connect_to_fd.3
XML_FILES = \
${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,$(MANPAGES)}}}}
man: fix compilation without xsltproc We really shouldn't add the man-pages when HAVE_XSLTPROC is not true so move it into the if-clause. But declare the automake-variables outside of the if-clause to avoid automake complaints. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-26 16:41:50 +02:00
CLEANFILES =
EXTRA_DIST =
man_MANS =
man: add man-page infrastructure This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-24 13:18:38 +02:00
if HAVE_XSLTPROC
man, configure.ac: Only generate man pages if we can do it offline Instead of relying on downloading the stylesheet from the Internet for generating man pages, only generate them if the stylesheet is available locally. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-12-01 17:33:23 +01:00
if HAVE_MANPAGES_STYLESHEET
man: add man-page infrastructure This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-24 13:18:38 +02:00
man: fix compilation without xsltproc We really shouldn't add the man-pages when HAVE_XSLTPROC is not true so move it into the if-clause. But declare the automake-variables outside of the if-clause to avoid automake complaints. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-26 16:41:50 +02:00
CLEANFILES += $(MANPAGES) $(MANPAGES_ALIASES)
EXTRA_DIST += $(MANPAGES) $(MANPAGES_ALIASES) $(XML_FILES)
man_MANS += $(MANPAGES) $(MANPAGES_ALIASES)
man: add man-page infrastructure This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-24 13:18:38 +02:00
XSLTPROC_FLAGS = \
--stringparam man.authors.section.enabled 0 \
--stringparam man.copyright.section.enabled 0 \
--stringparam funcsynopsis.style ansi \
man, configure.ac: Only generate man pages if we can do it offline Instead of relying on downloading the stylesheet from the Internet for generating man pages, only generate them if the stylesheet is available locally. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-12-01 17:33:23 +01:00
--stringparam man.output.quietly 1 \
--nonet
man: add man-page infrastructure This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-24 13:18:38 +02:00
XSLTPROC_PROCESS_MAN = \
$(AM_V_GEN)$(MKDIR_P) $(dir $@) && \
man, configure.ac: Only generate man pages if we can do it offline Instead of relying on downloading the stylesheet from the Internet for generating man pages, only generate them if the stylesheet is available locally. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-12-01 17:33:23 +01:00
$(XSLTPROC) -o $@ $(XSLTPROC_FLAGS) $(MANPAGES_STYLESHEET) $< && \
man: add man-page infrastructure This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-24 13:18:38 +02:00
$(SED) -i -e 's/^\.so \(.*\)\.\(.\)$$/\.so man\2\/\1\.\2/' $(MANPAGES_ALIASES)
%.1: %.xml
$(XSLTPROC_PROCESS_MAN)
%.3: %.xml
$(XSLTPROC_PROCESS_MAN)
%.5: %.xml
$(XSLTPROC_PROCESS_MAN)
%.7: %.xml
$(XSLTPROC_PROCESS_MAN)
man: fix compilation without xsltproc We really shouldn't add the man-pages when HAVE_XSLTPROC is not true so move it into the if-clause. But declare the automake-variables outside of the if-clause to avoid automake complaints. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-26 16:41:50 +02:00
wl_display_connect_to_fd.3: wl_display_connect.3
man, configure.ac: Only generate man pages if we can do it offline Instead of relying on downloading the stylesheet from the Internet for generating man pages, only generate them if the stylesheet is available locally. Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2012-12-01 17:33:23 +01:00
endif # HAVE_MANPAGES_STYLESHEET
man: add man-page infrastructure This adds a man-page infrastructure based on Docbook XML files. This allows us to integrate the man-pages into the publican books later. An example page for wl_display_connect() (with an alias wl_display_connect_to_fd()) is also added. Feel free to add more man-pages. Function calls are put in man3 and overview pages into man7. All pages (including aliases) have to be added to the Makefile. Docbook does generate aliases automatically from the additional names that were put in the XML file. However, a small SED script is needed to fixup the include-paths in the generated troff files. If someone knows how to avoid that (or even install them gzip'ped), please fix it up. Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2012-09-24 13:18:38 +02:00
endif # HAVE_XSLTPROC
Reference in a new issue Copy permalink