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 # MROFF_CMD command and flags to create preformatted pages
49 # Install the manual pages and their links.
52 .if !target(__<bsd.init.mk>__)
53 .error bsd.man.mk cannot be included directly.
56 MINSTALL?= ${INSTALL} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE}
58 CATDIR= ${MANDIR:H:S/$/\/cat/}
60 MROFF_CMD?= groff -Tascii -mtty-char -man -t
62 MCOMPRESS_CMD?= ${COMPRESS_CMD}
63 MCOMPRESS_EXT?= ${COMPRESS_EXT}
65 SECTIONS= 1 2 3 4 5 6 7 8 9
66 .SUFFIXES: ${SECTIONS:S/^/./g}
68 # Backwards compatibility.
70 .for sect in ${SECTIONS}
71 .if defined(MAN${sect}) && !empty(MAN${sect})
80 .if defined(NOMANCOMPRESS)
82 # Make special arrangements to filter to a temporary file at build time
84 .if defined(MANFILTER)
92 .if defined(MANFILTER)
93 .if defined(MAN) && !empty(MAN)
94 CLEANFILES+= ${MAN:T:S/$/${FILTEXTENSION}/g}
95 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g}
97 .for target in ${page:T:S/$/${FILTEXTENSION}/g}
100 ${MANFILTER} < ${.ALLSRC} > ${.TARGET}
102 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
103 .for target in ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g}
106 ${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} > ${.TARGET}
112 .if defined(MAN) && !empty(MAN)
113 CLEANFILES+= ${MAN:T:S/$/${CATEXT}/g}
114 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
116 .for target in ${page:T:S/$/${CATEXT}/g}
119 ${MROFF_CMD} ${.ALLSRC} > ${.TARGET}
130 ZEXT= ${MCOMPRESS_EXT}
132 .if defined(MAN) && !empty(MAN)
133 CLEANFILES+= ${MAN:T:S/$/${MCOMPRESS_EXT}/g}
134 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g}
136 .for target in ${page:T:S/$/${MCOMPRESS_EXT}/}
139 .if defined(MANFILTER)
140 ${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
142 ${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET}
145 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
146 .for target in ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/}
149 .if defined(MANFILTER)
150 ${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} | ${MCOMPRESS_CMD} > ${.TARGET}
152 ${MROFF_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
161 maninstall: _maninstall
163 .if defined(MAN) && !empty(MAN)
165 .if defined(NOMANCOMPRESS)
166 .if defined(MANFILTER)
168 ${MINSTALL} ${page:T:S/$/${FILTEXTENSION}/g} \
169 ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}/${page}
170 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
171 ${MINSTALL} ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \
172 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page}
176 @set `echo ${.ALLSRC} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
180 1) echo "warn: missing extension: $$1"; break;; \
182 page=$$1; shift; sect=$$1; shift; \
183 d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \
184 ${ECHO} ${MINSTALL} $${page} $${d}; \
185 ${MINSTALL} $${page} $${d}; \
187 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
189 ${MINSTALL} ${page:T:S/$/${CATEXT}/} \
190 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T}
196 ${MINSTALL} ${page:T:S/$/${MCOMPRESS_EXT}/g} \
197 ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}
198 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
199 ${MINSTALL} ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \
200 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T:S/$/${MCOMPRESS_EXT}/}
206 .if !defined(NOMLINKS) && defined(MLINKS) && !empty(MLINKS)
207 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
211 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \
213 name=$$1; shift; sect=$$1; shift; \
214 l=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
215 name=$$1; shift; sect=$$1; shift; \
216 t=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
217 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
218 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
219 ${LN} $${l}${ZEXT} $${t}${ZEXT}; \
221 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
222 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
226 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \
228 name=$$1; shift; sect=$$1; shift; \
229 l=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \
230 name=$$1; shift; sect=$$1; shift; \
231 t=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \
232 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
233 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
234 ${LN} $${l}${ZEXT} $${t}${ZEXT}; \
240 .if defined(MAN) && !empty(MAN)
244 .if defined(MANFILTER)
245 @${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} -ww -z
247 @${MROFF_CMD} -ww -z ${.ALLSRC}