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