xref: /freebsd/share/mk/bsd.info.mk (revision 230f8c40e55e3462e90151e30f61bd0fdd4dcda3)
1#	$FreeBSD$
2#
3# The include file <bsd.info.mk> handles installing GNU (tech)info files.
4# Texinfo is a documentation system that uses a single source
5# file to produce both on-line information and printed output.
6# <bsd.info.mk> includes the files <bsd.dep.mk> and <bsd.obj.mk>.
7#
8#
9# +++ variables +++
10#
11# CLEANFILES	Additional files to remove for the clean and cleandir targets.
12#
13# DESTDIR	Change the tree where the info files gets installed. [not set]
14#
15# DISTRIBUTION	Name of distribution. [info]
16#
17# GZIPCMD	Program to compress info files. Output is to
18#		stdout. [gzip -c]
19#
20# INFO		???
21#
22# INFODIR	Base path for GNU's hypertext system
23#		called Info (see info(1)). [${SHAREDIR}/info]
24#
25# INFODIRFILE	Top level node/index for info files. [dir]
26#
27# INFOGRP	Info group. [${SHAREGRP}]
28#
29# INFOMODE	Info mode. [${NOBINMODE}]
30#
31# INFOOWN	Info owner. [${SHAREOWN}]
32#
33# INFOSECTION	??? [Miscellaneous]
34#
35# INFOTMPL	??? [/usr/share/info/dir-tmpl]
36#
37# INSTALLINFO	??? [install-info]
38#
39# INSTALLINFODIRS	???
40#
41# MAKEINFO	A program for converting GNU Texinfo files into Info
42#		file. [makeinfo]
43#
44# MAKEINFOFLAGS		Options for ${MAKEINFO} command. [--no-split]
45#
46# NOINFO	Do not make or install info files. [not set]
47#
48# NOINFOCOMPRESS	If you do not want info files be
49#			compressed when they are installed. [not set]
50#
51#
52# +++ targets +++
53#
54#	clean:
55#		remove *.info* Errs errs mklog ${CLEANFILES}
56#
57#	depend:
58#		Dummy target, do nothing.
59#
60#	distribute:
61#		This is a variant of install, which will
62#		put the stuff into the right "distribution".
63#
64#	install:
65#		Install the info files.
66#
67#	maninstall:
68#		Dummy target, do nothing.
69#
70#
71# bsd.obj.mk: cleandir and obj
72
73MAKEINFO?=	makeinfo
74MAKEINFOFLAGS+=	--no-split # simplify some things, e.g., compression
75SRCDIR?=	${.CURDIR}
76INFODIRFILE?=   dir
77INFOTMPL?=      /usr/share/info/dir-tmpl
78INSTALLINFO?=   install-info
79INFOSECTION?=   Miscellaneous
80
81.MAIN: all
82
83.SUFFIXES: .gz .info .texi .texinfo
84.texi.info:
85	${MAKEINFO} ${MAKEINFOFLAGS} -I ${.CURDIR} -I ${SRCDIR} ${.IMPSRC} -o ${.TARGET}
86.texinfo.info:
87	${MAKEINFO} ${MAKEINFOFLAGS} -I ${.CURDIR} -I ${SRCDIR} ${.IMPSRC} -o ${.TARGET}
88
89.PATH: ${.CURDIR} ${SRCDIR}
90
91IFILENS= ${INFO:S/$/.info/g}
92
93.if !defined(NOINFO)
94.if !defined(NOINFOCOMPRESS)
95IFILES=	${INFO:S/$/.info.gz/g}
96all: ${IFILES} _SUBDIR
97.else
98IFILES=	${IFILENS}
99all: ${IFILES} _SUBDIR
100.endif
101.else
102all:
103.endif
104
105GZIPCMD?=	gzip -c
106
107.for x in ${INFO:S/$/.info/g}
108${x:S/$/.gz/}:	${x}
109	${GZIPCMD} ${.ALLSRC} > ${.TARGET}
110.endfor
111
112# What to do if there's no dir file there.  This is really gross!!!
113${DESTDIR}${INFODIR}/${INFODIRFILE}:
114	@(cd /usr/src/share/info; make install)
115
116.for x in ${INFO}
117INSTALLINFODIRS+= ${x:S/$/-install/}
118${x:S/$/-install/}: ${DESTDIR}${INFODIR}/${INFODIRFILE}
119	${INSTALLINFO} --defsection=${INFOSECTION} \
120		       --defentry=${INFOENTRY_${x}} \
121		       ${x}.info ${DESTDIR}${INFODIR}/${INFODIRFILE}
122.endfor
123
124.PHONY: ${INSTALLINFODIRS}
125
126# The default is "info" and it can never be "bin"
127DISTRIBUTION?=	info
128.if ${DISTRIBUTION} == "bin"
129DISTRIBUTION=	info
130.endif
131
132.if !target(distribute)
133distribute: _SUBDIR
134	cd ${.CURDIR} ; $(MAKE) install DESTDIR=${DISTDIR}/${DISTRIBUTION} SHARED=copies
135.endif
136
137.if defined(SRCS)
138${INFO}.info: ${SRCS}
139	${MAKEINFO} ${MAKEINFOFLAGS} -I ${.CURDIR} -I ${SRCDIR} ${SRCS:S/^/${SRCDIR}\//g} -o ${INFO}.info
140.endif
141
142depend: _SUBDIR
143	@echo -n
144
145clean: _SUBDIR
146	rm -f ${INFO:S/$/.info*/g} Errs errs mklog ${CLEANFILES}
147
148.if !defined(NOINFO) && defined(INFO)
149install: ${INSTALLINFODIRS} _SUBDIR
150	${INSTALL} ${COPY} -o ${INFOOWN} -g ${INFOGRP} -m ${INFOMODE} \
151		${IFILES} ${DESTDIR}${INFODIR}
152.else
153install:
154.endif
155
156.if !target(maninstall)
157maninstall: _SUBDIR
158.endif
159
160.include <bsd.dep.mk>
161.include <bsd.obj.mk>
162