1 # $FreeBSD: src/share/mk/bsd.man.mk,v 1.31.2.11 2002/12/19 13:48:33 ru Exp $
3 # The include file <bsd.man.mk> handles installing manual pages and
9 # DESTDIR Change the tree where the man pages gets installed. [not set]
11 # MANDIR Base path for manual installation. [${SHAREDIR}/man/man]
13 # MANOWN Manual owner. [${SHAREOWN}]
15 # MANGRP Manual group. [${SHAREGRP}]
17 # MANMODE Manual mode. [${NOBINMODE}]
19 # MANSUBDIR Subdirectory under the manual page section, i.e. "/i386"
20 # or "/tahoe" for machine specific manual pages.
22 # MAN The manual pages to be installed. For sections see
23 # variable ${SECTIONS}
25 # MCOMPRESS_CMD Program to compress man pages. Output is to
26 # stdout. [${COMPRESS_CMD}]
28 # MLINKS List of manual page links (using a suffix). The
29 # linked-to file must come first, the linked file
30 # second, and there may be multiple pairs. The files
33 # NOMANCOMPRESS If you do not want unformatted manual pages to be
34 # compressed when they are installed. [not set]
36 # NOMLINKS If you do not want install manual page links. [not set]
38 # MANFILTER command to pipe the raw man page through before compressing
39 # or installing. Can be used to do sed substitution.
41 # MANBUILDCAT create preformatted manual pages in addition to normal
44 # MANDOC_CMD command and flags to create preformatted pages
45 # MROFF_CMD groff command for manlint and mandiff
50 # Install the manual pages and their links.
53 .if !target(__<bsd.init.mk>__)
54 .error bsd.man.mk cannot be included directly.
57 _MANINSTALLFLAGS:= ${MANINSTALLFLAGS}
59 MINSTALL?= ${INSTALL} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
62 CATDIR= ${MANDIR:H:S/$/\/cat/}
64 MANDOC_CMD?= mandoc -Tascii
65 MROFF_CMD?= groff -Tascii -mtty-char -man -t
67 MCOMPRESS_CMD?= ${COMPRESS_CMD}
68 MCOMPRESS_EXT?= ${COMPRESS_EXT}
70 SECTIONS= 1 2 3 4 5 6 7 8 9
71 .SUFFIXES: ${SECTIONS:S/^/./g}
73 # Backwards compatibility.
75 .for sect in ${SECTIONS}
76 .if defined(MAN${sect}) && !empty(MAN${sect})
85 .if defined(NOMANCOMPRESS)
87 # Make special arrangements to filter to a temporary file at build time
89 .if defined(MANFILTER)
97 .if defined(MANFILTER)
98 .if defined(MAN) && !empty(MAN)
99 CLEANFILES+= ${MAN:T:S/$/${FILTEXTENSION}/g}
100 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g}
102 .for target in ${page:T:S/$/${FILTEXTENSION}/g}
105 ${MANFILTER} < ${.ALLSRC} > ${.TARGET}
107 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
108 .for target in ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g}
111 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} > ${.TARGET}
117 .if defined(MAN) && !empty(MAN)
118 CLEANFILES+= ${MAN:T:S/$/${CATEXT}/g}
119 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
121 .for target in ${page:T:S/$/${CATEXT}/g}
124 ${MANDOC_CMD} ${.ALLSRC} > ${.TARGET}
135 ZEXT= ${MCOMPRESS_EXT}
137 .if defined(MAN) && !empty(MAN)
138 CLEANFILES+= ${MAN:T:S/$/${MCOMPRESS_EXT}/g}
139 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g}
141 .for target in ${page:T:S/$/${MCOMPRESS_EXT}/}
144 .if defined(MANFILTER)
145 ${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
147 ${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET}
150 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
151 .for target in ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/}
154 .if defined(MANFILTER)
155 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} | ${MCOMPRESS_CMD} > ${.TARGET}
157 ${MANDOC_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
166 maninstall: _maninstall
168 .if defined(MAN) && !empty(MAN)
170 .if defined(NOMANCOMPRESS)
171 .if defined(MANFILTER)
173 ${MINSTALL} ${page:T:S/$/${FILTEXTENSION}/g} \
174 ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}/${page}
175 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
176 ${MINSTALL} ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \
177 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page}
181 @set `echo ${.ALLSRC} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
185 1) echo "warn: missing extension: $$1"; break;; \
187 page=$$1; shift; sect=$$1; shift; \
188 d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \
189 ${ECHO} ${MINSTALL} $${page} $${d}; \
190 ${MINSTALL} $${page} $${d}; \
192 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
194 ${MINSTALL} ${page:T:S/$/${CATEXT}/} \
195 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T}
201 ${MINSTALL} ${page:T:S/$/${MCOMPRESS_EXT}/g} \
202 ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}
203 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
204 ${MINSTALL} ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \
205 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T:S/$/${MCOMPRESS_EXT}/}
211 .if !defined(NOMLINKS) && defined(MLINKS) && !empty(MLINKS)
212 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
216 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \
218 name=$$1; shift; sect=$$1; shift; \
219 l=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
220 name=$$1; shift; sect=$$1; shift; \
221 t=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
222 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
223 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
224 ${LN} $${l}${ZEXT} $${t}${ZEXT}; \
226 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
227 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
231 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \
233 name=$$1; shift; sect=$$1; shift; \
234 l=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \
235 name=$$1; shift; sect=$$1; shift; \
236 t=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \
237 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
238 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
239 ${LN} $${l}${ZEXT} $${t}${ZEXT}; \
246 .if defined(MAN) && !empty(MAN)
249 #mandiff: ${page}diff
251 .if defined(MANFILTER)
252 # @${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} -ww -z
253 @-${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} -Tlint
255 # @${MROFF_CMD} -ww -z ${.ALLSRC}
256 @-${MANDOC_CMD} -Tlint ${.ALLSRC}
258 #${page}.out.groff: ${page}
259 # @-${MROFF_CMD} ${.ALLSRC} 2>&1 > ${.TARGET}
260 #${page}.out.mandoc: ${page}
261 # @-${MANDOC_CMD} -Werror ${.ALLSRC} 2>&1 > ${.TARGET}
262 #${page}diff: ${page}.out.groff ${page}.out.mandoc
263 # @-diff -au ${.ALLSRC}