summaryrefslogtreecommitdiff
path: root/docs/man/ghc.mk
blob: 0c1014b452a3f633648f68d21f29a64dd84b2adc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

ifeq "$(BUILD_MAN)" ""
ifeq "$(strip $(XSLTPROC))" ""
BUILD_MAN = NO
else
BUILD_MAN = YES
endif
endif

# The commands which should be mentioned in the man page
MAN_GHC_COMMANDS = ghc ghci

# The man page we are generating
MAN_PAGE = ghc

# The manual section
MAN_SECTION = 1

MAN_PATH = docs/man/$(MAN_PAGE).$(MAN_SECTION)

ifneq "$(BINDIST)" "YES"
$(MAN_PATH): docs/man/flags.xsl docs/man/flags.xml
	$(XSLTPROC) $(XSLTPROC_OPTS) $^ > $@
endif

# Insert the commands and the library directory into the man page
docs/man/flags.xsl: docs/man/gen_flags.xsl.sh
	$(SHELL) $< "$(MAN_GHC_COMMANDS)" "$(libdir)" > $@

# Re-use the flags documentation from the user's guide by injecting some
# entities after the XML declaration to make it a stand-alone document.
docs/man/flags.xml: docs/users_guide/flags.xml
	$(call removeFiles,$@)
	head -n 1 $< >> $@
	echo "<!DOCTYPE sect1 [<!ENTITY ndash  \"-\"> \
	                       <!ENTITY ldquo  \"\`\"> \
	                       <!ENTITY rdquo  \"'\">]>" >> $@
# "sed 1d" == "tail -n +2", but Solaris apparently rejects the latter
	sed 1d $< >> $@

ifeq "$(BUILD_MAN)" "YES"
ifeq "$(phase)" "final"
$(eval $(call all-target,docs/man,$(MAN_PATH)))
endif

INSTALL_MANPAGES += $(MAN_PATH)

install: install_man

.PHONY: install_man
install_man: $(MAN_PATH)
	$(call INSTALL_DIR,"$(DESTDIR)$(mandir)")
	$(call INSTALL_DIR,"$(DESTDIR)$(mandir)/man$(MAN_SECTION)")
	$(call INSTALL_MAN,$(INSTALL_OPTS),$(MAN_PATH),"$(DESTDIR)$(mandir)/man$(MAN_SECTION)")
endif

$(eval $(call clean-target,docs/man,,$(MAN_PATH) docs/man/flags.xsl docs/man/flags.xml))