[jackhill/guix/guix.git] / doc / local.mk

# GNU Guix --- Functional package management for GNU
# Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
# Copyright © 2013 Andreas Enge <andreas@enge.fr>
# Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com>
# Copyright © 2016, 2018 Mathieu Lirzin <mthl@gnu.org>
# Copyright © 2018, 2021 Julien Lepiller <julien@lepiller.eu>
#
# This file is part of GNU Guix.
#
# GNU Guix is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or (at
# your option) any later version.
#
# GNU Guix is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

# If adding a language, update the following variables, and info_TEXINFOS.
MANUAL_LANGUAGES = de es fa fi fr it ko pt_BR ru sk zh_CN
COOKBOOK_LANGUAGES = de es fa fi fr ko ru sk zh_Hans

# Arg1: A list of languages codes.
# Arg2: The file name stem.
lang_to_texinfo = $(foreach lang,$(1),%D%/$(2).$(lang).texi)

# Automake does not understand GNU Make non-standard extensions,
# unfortunately, so we cannot use the above patsubst-based function here.
info_TEXINFOS = %D%/guix.texi			\
  %D%/guix.de.texi				\
  %D%/guix.es.texi				\
  %D%/guix.fa.texi				\
  %D%/guix.fi.texi				\
  %D%/guix.fr.texi				\
  %D%/guix.it.texi				\
  %D%/guix.ko.texi				\
  %D%/guix.pt_BR.texi				\
  %D%/guix.ru.texi				\
  %D%/guix.sk.texi				\
  %D%/guix.zh_CN.texi				\
  %D%/guix-cookbook.texi			\
  %D%/guix-cookbook.de.texi			\
  %D%/guix-cookbook.es.texi			\
  %D%/guix-cookbook.fa.texi			\
  %D%/guix-cookbook.fi.texi			\
  %D%/guix-cookbook.fr.texi			\
  %D%/guix-cookbook.ko.texi			\
  %D%/guix-cookbook.ru.texi			\
  %D%/guix-cookbook.sk.texi			\
  %D%/guix-cookbook.zh_Hans.texi

%C%_guix_TEXINFOS = \
  %D%/contributing.texi \
  %D%/fdl-1.3.texi

DOT_FILES =					\
  %D%/images/bootstrap-graph.dot		\
  %D%/images/bootstrap-packages.dot		\
  %D%/images/coreutils-graph.dot		\
  %D%/images/coreutils-bag-graph.dot		\
  %D%/images/gcc-core-mesboot0-graph.dot	\
  %D%/images/service-graph.dot			\
  %D%/images/shepherd-graph.dot

DOT_VECTOR_GRAPHICS =				\
  $(DOT_FILES:%.dot=%.eps)			\
  $(DOT_FILES:%.dot=%.pdf)

EXTRA_DIST +=					\
  %D%/htmlxref.cnf				\
  $(DOT_FILES)					\
  $(DOT_VECTOR_GRAPHICS)			\
  %D%/images/coreutils-size-map.eps		\
  %D%/environment-gdb.scm			\
  %D%/package-hello.scm				\
  %D%/package-hello.json

OS_CONFIG_EXAMPLES_TEXI =			\
  %D%/os-config-bare-bones.texi			\
  %D%/os-config-desktop.texi			\
  %D%/os-config-lightweight-desktop.texi	\
  %D%/he-config-bare-bones.scm

TRANSLATED_INFO = 						\
  $(call lang_to_texinfo,$(MANUAL_LANGUAGES),guix)		\
  $(call lang_to_texinfo,$(MANUAL_LANGUAGES),contributing)	\
  $(call lang_to_texinfo,$(COOKBOOK_LANGUAGES),guix-cookbook)

# Bundle this file so that makeinfo finds it in out-of-source-tree builds.
BUILT_SOURCES        += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
EXTRA_DIST           += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
MAINTAINERCLEANFILES  = $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)

PO4A_PARAMS := -M UTF-8 -L UTF-8 #master and localized encoding
PO4A_PARAMS += -k 0 # produce an output even if the translation is not complete
PO4A_PARAMS += -f texinfo # texinfo format

# When a change to guix.texi occurs, it is not translated immediately.
# Because @pxref and @xref commands are references to sections by name, they
# should be translated. If a modification adds a reference to a section, this
# reference is not translated, which means it references a section that does not
# exist.
define xref_command
$(top_srcdir)/pre-inst-env $(GUILE) --no-auto-compile	\
  "$(top_srcdir)/build-aux/convert-xref.scm"		\
  $@.tmp $<
endef

$(srcdir)/%D%/guix.%.texi: po/doc/guix-manual.%.po $(srcdir)/%D%/contributing.%.texi guix/build/po.go
	-$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix.texi" -p "$<" -l "$@.tmp"
	-sed -i "s|guix\.info|$$(basename "$@" | sed 's|texi$$|info|')|" "$@.tmp"
	-$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command)
	-mv "$@.tmp" "$@"

$(srcdir)/%D%/guix-cookbook.%.texi: po/doc/guix-cookbook.%.po guix/build/po.go
	-$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix-cookbook.texi" -p "$<" -l "$@.tmp"
	-sed -i "s|guix-cookbook\.info|$$(basename "$@" | sed 's|texi$$|info|')|" "$@.tmp"
	-$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command)
	-mv "$@.tmp" "$@"

$(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po guix/build/po.go
	-$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/contributing.texi" -p "$<" -l "$@.tmp"
	-$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command)
	-mv "$@.tmp" "$@"

%D%/os-config-%.texi: gnu/system/examples/%.tmpl
	$(AM_V_GEN)$(MKDIR_P) "`dirname $@`";	\
	cp "$<" "$@"

infoimagedir = $(infodir)/images
dist_infoimage_DATA =				\
  $(DOT_FILES:%.dot=%.png)			\
  %D%/images/coreutils-size-map.png		\
  %D%/images/installer-network.png		\
  %D%/images/installer-partitions.png		\
  %D%/images/installer-resume.png

# Ask for warnings about cross-referenced manuals that are not listed in
# htmlxref.cnf.
AM_MAKEINFOHTMLFLAGS = --set-customization-variable CHECK_HTMLXREF=true

# Try hard to obtain an image size and aspect that's reasonable for inclusion
# in an Info or PDF document.
DOT_OPTIONS =					\
  -Gratio=.9 -Gnodesep=.005 -Granksep=.00005	\
  -Nfontsize=9 -Nheight=.1 -Nwidth=.1

.dot.png:
	$(AM_V_DOT)$(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"

.dot.pdf:
	$(AM_V_DOT)$(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"

.dot.eps:
	$(AM_V_DOT)$(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"

.png.eps:
	$(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
	mv "$@-tmp.eps" "$@"

# We cannot add new dependencies to `%D%/guix.pdf' & co. (info "(automake)
# Extending").  Using the `-local' rules is imperfect, because they may be
# triggered after the main rule.  Oh, well.
pdf-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.pdf)
info-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.png)
ps-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.eps)		\
	  $(top_srcdir)/%D%/images/coreutils-size-map.eps
dvi-local: ps-local

## ----------- ##
##  Man pages. ##
## ----------- ##

# The man pages are generated using GNU Help2man.  In makefiles rules they
# depend not on the binary, but on the source files.  This usage allows a
# manual page to be generated by the maintainer and included in the
# distribution without requiring the end-user to have 'help2man' installed.
# They are built in $(srcdir) like info manuals.

sub_commands_mans =				\
  $(srcdir)/%D%/guix-archive.1			\
  $(srcdir)/%D%/guix-build.1			\
  $(srcdir)/%D%/guix-challenge.1		\
  $(srcdir)/%D%/guix-deploy.1			\
  $(srcdir)/%D%/guix-download.1			\
  $(srcdir)/%D%/guix-edit.1			\
  $(srcdir)/%D%/guix-environment.1		\
  $(srcdir)/%D%/guix-gc.1			\
  $(srcdir)/%D%/guix-hash.1			\
  $(srcdir)/%D%/guix-import.1			\
  $(srcdir)/%D%/guix-lint.1			\
  $(srcdir)/%D%/guix-package.1			\
  $(srcdir)/%D%/guix-publish.1			\
  $(srcdir)/%D%/guix-pull.1			\
  $(srcdir)/%D%/guix-refresh.1			\
  $(srcdir)/%D%/guix-size.1			\
  $(srcdir)/%D%/guix-system.1			\
  $(srcdir)/%D%/guix-time-machine.1		\
  $(srcdir)/%D%/guix-weather.1

# Assume that cross-compiled commands cannot be executed.
if !CROSS_COMPILING

dist_man1_MANS =				\
  $(srcdir)/%D%/guix.1				\
  $(sub_commands_mans)

endif

gen_man =						\
  LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN)	\
  $(HELP2MANFLAGS)

HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)

$(srcdir)/%D%/guix.1: scripts/guix.in $(sub_commands_mans)
	-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`

# The 'case' ensures the man pages are only generated if the corresponding
# source script (the first prerequisite) has been changed.  The $(GOBJECTS)
# prerequisite is solely meant to force these docs to be made only after all
# Guile modules have been compiled.
$(srcdir)/%D%/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
	-@case '$?' in \
	  *$<*) $(AM_V_P) && set -x || echo "  HELP2MAN $@"; \
	        $(gen_man) --output="$@" "guix $*";; \
	  *)    : ;; \
	esac

if BUILD_DAEMON
if !CROSS_COMPILING

dist_man1_MANS += $(srcdir)/%D%/guix-daemon.1

$(srcdir)/%D%/guix-daemon.1: guix-daemon$(EXEEXT)
	-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`

endif
endif
Commit	Line	Data
575ed8d5	1	# GNU Guix --- Functional package management for GNU
36629097	2	# Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
62bc3c5b	3	# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
575ed8d5	4	# Copyright © 2013 Andreas Enge <andreas@enge.fr>
ce9a3042	5	# Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com>
523790d1	6	# Copyright © 2016, 2018 Mathieu Lirzin <mthl@gnu.org>
66072a00	7	# Copyright © 2018, 2021 Julien Lepiller <julien@lepiller.eu>
575ed8d5 AE	8	#
	9	# This file is part of GNU Guix.
	10	#
	11	# GNU Guix is free software; you can redistribute it and/or modify it
	12	# under the terms of the GNU General Public License as published by
	13	# the Free Software Foundation; either version 3 of the License, or (at
	14	# your option) any later version.
	15	#
	16	# GNU Guix is distributed in the hope that it will be useful, but
	17	# WITHOUT ANY WARRANTY; without even the implied warranty of
	18	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	# GNU General Public License for more details.
	20	#
	21	# You should have received a copy of the GNU General Public License
	22	# along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
	23
66072a00	24	# If adding a language, update the following variables, and info_TEXINFOS.
934b0cdf JL	25	MANUAL_LANGUAGES = de es fa fi fr it ko pt_BR ru sk zh_CN
934b0cdf JL	26	COOKBOOK_LANGUAGES = de es fa fi fr ko ru sk zh_Hans
66072a00 JL	27
	28	# Arg1: A list of languages codes.
	29	# Arg2: The file name stem.
	30	lang_to_texinfo = $(foreach lang,$(1),%D%/$(2).$(lang).texi)
	31
	32	# Automake does not understand GNU Make non-standard extensions,
	33	# unfortunately, so we cannot use the above patsubst-based function here.
de712e52	34	info_TEXINFOS = %D%/guix.texi \
3bac7e64	35	%D%/guix.de.texi \
de712e52	36	%D%/guix.es.texi \
43fb84da	37	%D%/guix.fa.texi \
934b0cdf	38	%D%/guix.fi.texi \
de712e52	39	%D%/guix.fr.texi \
d2d6c20f	40	%D%/guix.it.texi \
0f355124	41	%D%/guix.ko.texi \
c3eaff8a	42	%D%/guix.pt_BR.texi \
3bac7e64	43	%D%/guix.ru.texi \
77c6c0aa	44	%D%/guix.sk.texi \
7bc46ecc	45	%D%/guix.zh_CN.texi \
f98e83a1	46	%D%/guix-cookbook.texi \
58c59116	47	%D%/guix-cookbook.de.texi \
85430a9e	48	%D%/guix-cookbook.es.texi \
43fb84da	49	%D%/guix-cookbook.fa.texi \
934b0cdf	50	%D%/guix-cookbook.fi.texi \
0f355124	51	%D%/guix-cookbook.fr.texi \
8830930e	52	%D%/guix-cookbook.ko.texi \
6c10c96f JL	53	%D%/guix-cookbook.ru.texi \
6c10c96f JL	54	%D%/guix-cookbook.sk.texi \
8830930e	55	%D%/guix-cookbook.zh_Hans.texi
88856916	56
523790d1 ML	57	%C%_guix_TEXINFOS = \
	58	%D%/contributing.texi \
	59	%D%/fdl-1.3.texi
	60
88856916	61	DOT_FILES = \
c0d2e7b1 ML	62	%D%/images/bootstrap-graph.dot \
	63	%D%/images/bootstrap-packages.dot \
	64	%D%/images/coreutils-graph.dot \
	65	%D%/images/coreutils-bag-graph.dot \
cd5d5f53	66	%D%/images/gcc-core-mesboot0-graph.dot \
c0d2e7b1 ML	67	%D%/images/service-graph.dot \
c0d2e7b1 ML	68	%D%/images/shepherd-graph.dot
88856916 LC	69
	70	DOT_VECTOR_GRAPHICS = \
	71	$(DOT_FILES:%.dot=%.eps) \
	72	$(DOT_FILES:%.dot=%.pdf)
	73
a9424c08	74	EXTRA_DIST += \
c0d2e7b1	75	%D%/htmlxref.cnf \
88856916 LC	76	$(DOT_FILES) \
88856916 LC	77	$(DOT_VECTOR_GRAPHICS) \
c0d2e7b1 ML	78	%D%/images/coreutils-size-map.eps \
c0d2e7b1 ML	79	%D%/environment-gdb.scm \
c9f321e5 RW	80	%D%/package-hello.scm \
c9f321e5 RW	81	%D%/package-hello.json
575ed8d5	82
dd51caac	83	OS_CONFIG_EXAMPLES_TEXI = \
c0d2e7b1 ML	84	%D%/os-config-bare-bones.texi \
c0d2e7b1 ML	85	%D%/os-config-desktop.texi \
e95acc09 JL	86	%D%/os-config-lightweight-desktop.texi \
e95acc09 JL	87	%D%/he-config-bare-bones.scm
dd51caac	88
66072a00 JL	89	TRANSLATED_INFO = \
	90	$(call lang_to_texinfo,$(MANUAL_LANGUAGES),guix) \
	91	$(call lang_to_texinfo,$(MANUAL_LANGUAGES),contributing) \
	92	$(call lang_to_texinfo,$(COOKBOOK_LANGUAGES),guix-cookbook)
b9fe8fd6	93
931c132a	94	# Bundle this file so that makeinfo finds it in out-of-source-tree builds.
b9fe8fd6 JL	95	BUILT_SOURCES += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
	96	EXTRA_DIST += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
	97	MAINTAINERCLEANFILES = $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
	98
	99	PO4A_PARAMS := -M UTF-8 -L UTF-8 #master and localized encoding
	100	PO4A_PARAMS += -k 0 # produce an output even if the translation is not complete
	101	PO4A_PARAMS += -f texinfo # texinfo format
	102
	103	# When a change to guix.texi occurs, it is not translated immediately.
0623138f	104	# Because @pxref and @xref commands are references to sections by name, they
b9fe8fd6 JL	105	# should be translated. If a modification adds a reference to a section, this
	106	# reference is not translated, which means it references a section that does not
	107	# exist.
b9fe8fd6	108	define xref_command
0623138f JL	109	$(top_srcdir)/pre-inst-env $(GUILE) --no-auto-compile \
	110	"$(top_srcdir)/build-aux/convert-xref.scm" \
	111	$@.tmp $<
b9fe8fd6 JL	112	endef
b9fe8fd6 JL	113
0623138f	114	$(srcdir)/%D%/guix.%.texi: po/doc/guix-manual.%.po $(srcdir)/%D%/contributing.%.texi guix/build/po.go
b9fe8fd6 JL	115	-$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix.texi" -p "$<" -l "$@.tmp"
b9fe8fd6 JL	116	-sed -i "s\|guix\.info\|$$(basename "$@" \| sed 's\|texi$$\|info\|')\|" "$@.tmp"
c5881ff1	117	-$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command)
b9fe8fd6 JL	118	-mv "$@.tmp" "$@"
b9fe8fd6 JL	119
0623138f	120	$(srcdir)/%D%/guix-cookbook.%.texi: po/doc/guix-cookbook.%.po guix/build/po.go
7bc46ecc RW	121	-$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix-cookbook.texi" -p "$<" -l "$@.tmp"
7bc46ecc RW	122	-sed -i "s\|guix-cookbook\.info\|$$(basename "$@" \| sed 's\|texi$$\|info\|')\|" "$@.tmp"
c5881ff1	123	-$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command)
7bc46ecc RW	124	-mv "$@.tmp" "$@"
7bc46ecc RW	125
0623138f	126	$(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po guix/build/po.go
39764ef8	127	-$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/contributing.texi" -p "$<" -l "$@.tmp"
c5881ff1	128	-$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command)
b9fe8fd6	129	-mv "$@.tmp" "$@"
931c132a	130
c0d2e7b1	131	%D%/os-config-%.texi: gnu/system/examples/%.tmpl
e71ad29d	132	$(AM_V_GEN)$(MKDIR_P) "`dirname $@`"; \
931c132a LC	133	cp "$<" "$@"
931c132a LC	134
575ed8d5	135	infoimagedir = $(infodir)/images
a8f996c6	136	dist_infoimage_DATA = \
88856916	137	$(DOT_FILES:%.dot=%.png) \
e1c15e8b LC	138	%D%/images/coreutils-size-map.png \
	139	%D%/images/installer-network.png \
	140	%D%/images/installer-partitions.png \
	141	%D%/images/installer-resume.png
575ed8d5	142
227ff747 LC	143	# Ask for warnings about cross-referenced manuals that are not listed in
	144	# htmlxref.cnf.
	145	AM_MAKEINFOHTMLFLAGS = --set-customization-variable CHECK_HTMLXREF=true
	146
575ed8d5 AE	147	# Try hard to obtain an image size and aspect that's reasonable for inclusion
575ed8d5 AE	148	# in an Info or PDF document.
54461ce7 LC	149	DOT_OPTIONS = \
54461ce7 LC	150	-Gratio=.9 -Gnodesep=.005 -Granksep=.00005 \
575ed8d5 AE	151	-Nfontsize=9 -Nheight=.1 -Nwidth=.1
	152
	153	.dot.png:
4c48878d	154	$(AM_V_DOT)$(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
ce9a3042	155	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
575ed8d5	156
54461ce7	157	.dot.pdf:
4c48878d	158	$(AM_V_DOT)$(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
ce9a3042	159	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
54461ce7	160
575ed8d5	161	.dot.eps:
4c48878d	162	$(AM_V_DOT)$(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
ce9a3042	163	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
575ed8d5	164
66c8ea47	165	.png.eps:
e71ad29d	166	$(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
66c8ea47 LC	167	mv "$@-tmp.eps" "$@"
66c8ea47 LC	168
c0d2e7b1	169	# We cannot add new dependencies to `%D%/guix.pdf' & co. (info "(automake)
a9424c08 LC	170	# Extending"). Using the `-local' rules is imperfect, because they may be
a9424c08 LC	171	# triggered after the main rule. Oh, well.
88856916 LC	172	pdf-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.pdf)
	173	info-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.png)
	174	ps-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.eps) \
c0d2e7b1	175	$(top_srcdir)/%D%/images/coreutils-size-map.eps
66c8ea47	176	dvi-local: ps-local
52eca736	177
36629097 EB	178	## ----------- ##
	179	## Man pages. ##
	180	## ----------- ##
	181
39118b5e ML	182	# The man pages are generated using GNU Help2man. In makefiles rules they
	183	# depend not on the binary, but on the source files. This usage allows a
	184	# manual page to be generated by the maintainer and included in the
	185	# distribution without requiring the end-user to have 'help2man' installed.
	186	# They are built in $(srcdir) like info manuals.
	187
36629097	188	sub_commands_mans = \
c0d2e7b1 ML	189	$(srcdir)/%D%/guix-archive.1 \
	190	$(srcdir)/%D%/guix-build.1 \
	191	$(srcdir)/%D%/guix-challenge.1 \
d9e83f2a	192	$(srcdir)/%D%/guix-deploy.1 \
c0d2e7b1 ML	193	$(srcdir)/%D%/guix-download.1 \
	194	$(srcdir)/%D%/guix-edit.1 \
	195	$(srcdir)/%D%/guix-environment.1 \
	196	$(srcdir)/%D%/guix-gc.1 \
	197	$(srcdir)/%D%/guix-hash.1 \
	198	$(srcdir)/%D%/guix-import.1 \
	199	$(srcdir)/%D%/guix-lint.1 \
	200	$(srcdir)/%D%/guix-package.1 \
	201	$(srcdir)/%D%/guix-publish.1 \
	202	$(srcdir)/%D%/guix-pull.1 \
	203	$(srcdir)/%D%/guix-refresh.1 \
	204	$(srcdir)/%D%/guix-size.1 \
d9e83f2a LC	205	$(srcdir)/%D%/guix-system.1 \
	206	$(srcdir)/%D%/guix-time-machine.1 \
	207	$(srcdir)/%D%/guix-weather.1
52eca736	208
62bc3c5b LC	209	# Assume that cross-compiled commands cannot be executed.
	210	if !CROSS_COMPILING
	211
52eca736	212	dist_man1_MANS = \
c0d2e7b1	213	$(srcdir)/%D%/guix.1 \
36629097 EB	214	$(sub_commands_mans)
36629097 EB	215
62bc3c5b LC	216	endif
62bc3c5b LC	217
ff853a2a LC	218	gen_man = \
	219	LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN) \
	220	$(HELP2MANFLAGS)
	221
	222	HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)
36629097	223
c0d2e7b1	224	$(srcdir)/%D%/guix.1: scripts/guix.in $(sub_commands_mans)
92d40a68	225	-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
36629097	226
39118b5e ML	227	# The 'case' ensures the man pages are only generated if the corresponding
	228	# source script (the first prerequisite) has been changed. The $(GOBJECTS)
	229	# prerequisite is solely meant to force these docs to be made only after all
	230	# Guile modules have been compiled.
c0d2e7b1	231	$(srcdir)/%D%/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
36629097 EB	232	-@case '$?' in \
	233	$<) $(AM_V_P) && set -x \|\| echo " HELP2MAN $@"; \
	234	$(gen_man) --output="$@" "guix $*";; \
	235	*) : ;; \
	236	esac
acec3beb LC	237
acec3beb LC	238	if BUILD_DAEMON
62bc3c5b	239	if !CROSS_COMPILING
acec3beb	240
c0d2e7b1	241	dist_man1_MANS += $(srcdir)/%D%/guix-daemon.1
36629097	242
7dd05396	243	$(srcdir)/%D%/guix-daemon.1: guix-daemon$(EXEEXT)
36629097	244	-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
acec3beb LC	245
acec3beb LC	246	endif
62bc3c5b	247	endif