xref: /netbsd/share/mk/bsd.man.mk (revision 6550d01e) 
1#	$NetBSD: bsd.man.mk,v 1.106 2011/01/12 23:03:24 joerg Exp $
2#	@(#)bsd.man.mk	8.1 (Berkeley) 6/8/93
3
4.include <bsd.init.mk>
5
6##### Basic targets
7.PHONY:		catinstall maninstall catpages manpages catlinks manlinks
8.PHONY:		htmlinstall htmlpages htmllinks
9.PHONY:		lintmanpages
10realinstall:	${MANINSTALL}
11
12##### Default values
13.if ${USETOOLS} == "yes"
14TMACDEPDIR?=	${TOOLDIR}/share/groff/tmac
15.else
16TMACDEPDIR?=	/usr/share/tmac
17.endif
18
19HTMLDIR?=	${DESTDIR}${MANDIR}
20CATDEPS?=	${TMACDEPDIR}/andoc.tmac \
21		${TMACDEPDIR}/doc.tmac \
22		${TMACDEPDIR}/mdoc/doc-common \
23		${TMACDEPDIR}/mdoc/doc-ditroff \
24		${TMACDEPDIR}/mdoc/doc-nroff \
25		${TMACDEPDIR}/mdoc/doc-syms
26MANTARGET?=	cat
27
28MAN?=
29MLINKS?=
30_MNUMBERS=	1 2 3 4 5 6 7 8 9
31.SUFFIXES:	${_MNUMBERS:@N@.$N@}
32
33.if ${MKMANZ} == "no"
34MANCOMPRESS?=
35MANSUFFIX?=
36.else
37MANCOMPRESS?=	gzip -ncf
38MANSUFFIX?=	.gz
39.endif
40
41# make MANCOMPRESS a filter, so it can be inserted on an as-needed basis
42.if !empty(MANCOMPRESS)
43MANCOMPRESS:=	| ${MANCOMPRESS}
44.endif
45
46__installpage: .USE
47	@cmp -s ${.ALLSRC} ${.TARGET} > /dev/null 2>&1 || \
48	    (${_MKSHMSG_INSTALL} ${.TARGET}; \
49	     ${_MKSHECHO} "${INSTALL_FILE} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
50		${.ALLSRC} ${.TARGET}" && \
51	     ${INSTALL_FILE} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
52		${.ALLSRC} ${.TARGET})
53
54# XXX consider including bsd.links.mk and using __linkinstall instead
55__linkinstallpage: .USE
56	${_MKSHMSG_INSTALL} ${.TARGET}; \
57	${_MKSHECHO} "${INSTALL_LINK} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
58	    ${.ALLSRC} ${.TARGET}" && \
59	${INSTALL_LINK} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
60	    ${.ALLSRC} ${.TARGET}
61
62##### Build and install rules (source form pages)
63
64.if ${MKMAN} != "no"
65maninstall:	manpages manlinks
66manpages::	# ensure target exists
67MANPAGES=	${MAN:C/.$/&${MANSUFFIX}/}
68
69realall:	${MANPAGES}
70.if !empty(MANSUFFIX)
71.NOPATH:	${MANPAGES}
72.SUFFIXES:	${_MNUMBERS:@N@.$N${MANSUFFIX}@}
73
74${_MNUMBERS:@N@.$N.$N${MANSUFFIX}@}:			# build rule
75	${_MKTARGET_FORMAT}
76	cat ${.IMPSRC} ${MANCOMPRESS} > ${.TARGET}.tmp && mv ${.TARGET}.tmp ${.TARGET}
77.endif # !empty(MANSUFFIX)
78
79.for F in ${MANPAGES:S/${MANSUFFIX}$//:O:u}
80_F:=		${DESTDIR}${MANDIR}/man${F:T:E}${MANSUBDIR}/${F}${MANSUFFIX}
81
82.if ${MKUPDATE} == "no"
83${_F}!		${F}${MANSUFFIX} __installpage		# install rule
84.if !defined(BUILD) && !make(all) && !make(${F})
85${_F}!		.MADE					# no build at install
86.endif
87.else
88${_F}:		${F}${MANSUFFIX} __installpage		# install rule
89.if !defined(BUILD) && !make(all) && !make(${F})
90${_F}:		.MADE					# no build at install
91.endif
92.endif
93
94manpages::	${_F}
95.PRECIOUS:	${_F}					# keep if install fails
96.endfor
97
98manlinks::						# link install
99
100.for _src _dst in ${MLINKS}
101_l:=${DESTDIR}${MANDIR}/man${_src:T:E}${MANSUBDIR}/${_src}${MANSUFFIX}
102_t:=${DESTDIR}${MANDIR}/man${_dst:T:E}${MANSUBDIR}/${_dst}${MANSUFFIX}
103
104# Handle case conflicts carefully, when _dst occurs
105# more than once after case flattening
106.if ${MKUPDATE} == "no" || ${MLINKS:tl:M${_dst:tl:Q}:[\#]} > 1
107${_t}!		${_l} __linkinstallpage
108.else
109${_t}:		${_l} __linkinstallpage
110.endif
111
112manlinks::	${_t}
113.PRECIOUS:	${_t}
114.endfor
115.endif # ${MKMAN} != "no"
116
117##### Build and install rules (plaintext pages)
118
119.if (${MKCATPAGES} != "no") && (${MKMAN} != "no")
120catinstall:	catpages catlinks
121catpages::	# ensure target exists
122CATPAGES=	${MAN:C/\.([1-9])$/.cat\1${MANSUFFIX}/}
123
124realall:	${CATPAGES}
125.NOPATH:	${CATPAGES}
126.SUFFIXES:	${_MNUMBERS:@N@.cat$N${MANSUFFIX}@}
127.MADE:	${CATDEPS}
128
129${_MNUMBERS:@N@.$N.cat$N${MANSUFFIX}@}: ${CATDEPS}	# build rule
130	${_MKTARGET_FORMAT}
131.if ${MKMANDOC} == yes && !defined(NOMANDOC)
132	if test ""${NOMANDOC.${.IMPSRC:T}:tl:Q} != "yes"; then \
133		${TOOL_MANDOC_ASCII} ${.IMPSRC} ${MANCOMPRESS} \
134		    > ${.TARGET}.tmp && mv ${.TARGET}.tmp ${.TARGET}; \
135	else \
136		${TOOL_ROFF_ASCII} -mandoc ${.IMPSRC} ${MANCOMPRESS} \
137		    > ${.TARGET}.tmp && mv ${.TARGET}.tmp ${.TARGET}; \
138	fi
139.elif defined(USETBL)
140	${TOOL_TBL} ${.IMPSRC} | ${TOOL_ROFF_ASCII} -mandoc ${MANCOMPRESS} \
141	    > ${.TARGET}.tmp && mv ${.TARGET}.tmp ${.TARGET}
142.else
143	${TOOL_ROFF_ASCII} -mandoc ${.IMPSRC} ${MANCOMPRESS} \
144	    > ${.TARGET}.tmp && mv ${.TARGET}.tmp ${.TARGET}
145.endif
146
147.for F in ${CATPAGES:S/${MANSUFFIX}$//:O:u}
148_F:=		${DESTDIR}${MANDIR}/${F:T:E}${MANSUBDIR}/${F:R}.0${MANSUFFIX}
149
150.if ${MKUPDATE} == "no"
151${_F}!		${F}${MANSUFFIX} __installpage		# install rule
152.if !defined(BUILD) && !make(all) && !make(${F})
153${_F}!		.MADE					# no build at install
154.endif
155.else
156${_F}:		${F}${MANSUFFIX} __installpage		# install rule
157.if !defined(BUILD) && !make(all) && !make(${F})
158${_F}:		.MADE					# no build at install
159.endif
160.endif
161
162catpages::	${_F}
163.PRECIOUS:	${_F}					# keep if install fails
164.endfor
165
166catlinks::						# link install
167
168.for _src _dst in ${MLINKS}
169_l:=${DESTDIR}${MANDIR}/cat${_src:T:E}${MANSUBDIR}/${_src:R}.0${MANSUFFIX}
170_t:=${DESTDIR}${MANDIR}/cat${_dst:T:E}${MANSUBDIR}/${_dst:R}.0${MANSUFFIX}
171
172# Handle case conflicts carefully, when _dst occurs
173# more than once after case flattening
174.if ${MKUPDATE} == "no" || ${MLINKS:tl:M${_dst:tl:Q}:[\#]} > 1
175${_t}!		${_l} __linkinstallpage
176.else
177${_t}:		${_l} __linkinstallpage
178.endif
179
180catlinks::	${_t}
181.PRECIOUS:	${_t}
182.endfor
183.endif # (${MKCATPAGES} != "no") && (${MKMAN} != "no")
184
185##### Build and install rules (HTML pages)
186
187.if (${MKHTML} != "no") && (${MKMAN} != "no")		# {
188htmlinstall:	htmlpages htmllinks
189htmlpages::	# ensure target exists
190HTMLPAGES=	${MAN:C/\.([1-9])$/.html\1/}
191
192realall:	${HTMLPAGES}
193.NOPATH:	${HTMLPAGES}
194.SUFFIXES:	${_MNUMBERS:@N@.html$N@}
195
196${_MNUMBERS:@N@.$N.html$N@}: 				# build rule
197	${_MKTARGET_FORMAT}
198	${TOOL_MANDOC_HTML} ${.IMPSRC} > ${.TARGET}.tmp && \
199	    mv ${.TARGET}.tmp ${.TARGET}
200
201.for F in ${HTMLPAGES:O:u}
202# construct installed path
203_F:=		${HTMLDIR}/${F:T:E}${MANSUBDIR}/${F:R:S-/index$-/x&-}.html
204
205.if ${MKUPDATE} == "no"
206${_F}!		${F} __installpage			# install rule
207.if !defined(BUILD) && !make(all) && !make(${F})
208${_F}!		.MADE					# no build at install
209.endif
210.else
211${_F}:		${F} __installpage			# install rule
212.if !defined(BUILD) && !make(all) && !make(${F})
213${_F}:		.MADE					# no build at install
214.endif
215.endif
216
217htmlpages::	${_F}
218.PRECIOUS:	${_F}					# keep if install fails
219.endfor
220
221htmllinks::						# link install
222
223.for _src _dst in ${MLINKS}
224_l:=${HTMLDIR}/html${_src:T:E}${MANSUBDIR}/${_src:R:S-/index$-/x&-}.html
225_t:=${HTMLDIR}/html${_dst:T:E}${MANSUBDIR}/${_dst:R:S-/index$-/x&-}.html
226
227# Handle case conflicts carefully, when _dst occurs
228# more than once after case flattening
229.if ${MKUPDATE} == "no" || ${MLINKS:tl:M${_dst:tl:Q}:[\#]} > 1
230${_t}!		${_l} __linkinstallpage
231.else
232${_t}:		${_l} __linkinstallpage
233.endif
234
235htmllinks::	${_t}
236.PRECIOUS:	${_t}
237.endfor
238
239.endif							# }
240
241##### Clean rules
242.undef _F
243
244cleandir: cleanman
245.if !empty(CLEANFILES)
246	rm -f ${CLEANFILES}
247.endif
248
249cleanman: .PHONY
250.if !empty(MAN) && (${MKMAN} != "no")
251.if (${MKCATPAGES} != "no")
252	rm -f ${CATPAGES}
253.endif
254.if !empty(MANSUFFIX)
255	rm -f ${MANPAGES} ${CATPAGES:S/${MANSUFFIX}$//}
256.endif
257.if ${MKHTML} != "no"
258	rm -f ${HTMLPAGES}
259.endif
260.endif
261# (XXX ${CATPAGES:S...} cleans up old .catN files where .catN.gz now used)
262
263.if !empty(MANPAGES)
264lintmanpages: ${MANPAGES}
265	${TOOL_MANDOC_LINT} -Tlint -fstrict -Wall,stop ${.ALLSRC}
266.endif
267
268##### Pull in related .mk logic
269.include <bsd.obj.mk>
270.include <bsd.files.mk>
271.include <bsd.sys.mk>
272
273${TARGETS} catinstall maninstall htmlinstall: # ensure existence
274