1# $FreeBSD: src/share/mk/bsd.man.mk,v 1.31.2.11 2002/12/19 13:48:33 ru Exp $ 2# 3# The include file <bsd.man.mk> handles installing manual pages and 4# their links. 5# 6# 7# +++ variables +++ 8# 9# DESTDIR Change the tree where the man pages gets installed. [not set] 10# 11# MANDIR Base path for manual installation. [${SHAREDIR}/man/man] 12# 13# MANOWN Manual owner. [${SHAREOWN}] 14# 15# MANGRP Manual group. [${SHAREGRP}] 16# 17# MANMODE Manual mode. [${NOBINMODE}] 18# 19# MANSUBDIR Subdirectory under the manual page section, i.e. "/i386" 20# or "/tahoe" for machine specific manual pages. 21# 22# MAN The manual pages to be installed. For sections see 23# variable ${SECTIONS} 24# 25# MCOMPRESS_CMD Program to compress man pages. Output is to 26# stdout. [${COMPRESS_CMD}] 27# 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 31# are hard-linked. 32# 33# NOMANCOMPRESS If you do not want unformatted manual pages to be 34# compressed when they are installed. [not set] 35# 36# NOMLINKS If you do not want install manual page links. [not set] 37# 38# MANFILTER command to pipe the raw man page through before compressing 39# or installing. Can be used to do sed substitution. 40# 41# MANBUILDCAT create preformatted manual pages in addition to normal 42# pages. [not set] 43# 44# MANDOC_CMD command and flags to create preformatted pages 45# MROFF_CMD groff command for manlint and mandiff 46# 47# +++ targets +++ 48# 49# maninstall: 50# Install the manual pages and their links. 51# 52 53.if !target(__<bsd.init.mk>__) 54.error bsd.man.mk cannot be included directly. 55.endif 56 57_MANINSTALLFLAGS:= ${MANINSTALLFLAGS} 58 59MINSTALL?= ${INSTALL} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \ 60 ${_MANINSTALLFLAGS} 61 62CATDIR= ${MANDIR:H:S/$/\/cat/} 63CATEXT= .cat 64MANDOC_CMD?= mandoc -Tascii 65MROFF_CMD?= groff -Tascii -mtty-char -man -t 66 67MCOMPRESS_CMD?= ${COMPRESS_CMD} 68MCOMPRESS_EXT?= ${COMPRESS_EXT} 69 70SECTIONS= 1 2 3 4 5 6 7 8 9 71.SUFFIXES: ${SECTIONS:S/^/./g} 72 73# Backwards compatibility. 74.if !defined(MAN) 75.for sect in ${SECTIONS} 76.if defined(MAN${sect}) && !empty(MAN${sect}) 77MAN+= ${MAN${sect}} 78.endif 79.endfor 80.endif 81 82_manpages: 83all-man: _manpages 84 85.if defined(NOMANCOMPRESS) 86 87# Make special arrangements to filter to a temporary file at build time 88# for NOMANCOMPRESS. 89.if defined(MANFILTER) 90FILTEXTENSION= .filt 91.else 92FILTEXTENSION= 93.endif 94 95ZEXT= 96 97.if defined(MANFILTER) 98.if defined(MAN) && !empty(MAN) 99CLEANFILES+= ${MAN:T:S/$/${FILTEXTENSION}/g} 100CLEANFILES+= ${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g} 101.for page in ${MAN} 102.for target in ${page:T:S/$/${FILTEXTENSION}/g} 103_manpages: ${target} 104${target}: ${page} 105 ${MANFILTER} < ${.ALLSRC} > ${.TARGET} 106.endfor 107.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 108.for target in ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g} 109_manpages: ${target} 110${target}: ${page} 111 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} > ${.TARGET} 112.endfor 113.endif 114.endfor 115.endif 116.else 117.if defined(MAN) && !empty(MAN) 118CLEANFILES+= ${MAN:T:S/$/${CATEXT}/g} 119.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 120.for page in ${MAN} 121.for target in ${page:T:S/$/${CATEXT}/g} 122_manpages: ${target} 123${target}: ${page} 124 ${MANDOC_CMD} ${.ALLSRC} > ${.TARGET} 125.endfor 126.endfor 127.else 128_manpages: ${MAN} 129.endif 130.endif 131.endif 132 133.else 134 135ZEXT= ${MCOMPRESS_EXT} 136 137.if defined(MAN) && !empty(MAN) 138CLEANFILES+= ${MAN:T:S/$/${MCOMPRESS_EXT}/g} 139CLEANFILES+= ${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} 140.for page in ${MAN} 141.for target in ${page:T:S/$/${MCOMPRESS_EXT}/} 142_manpages: ${target} 143${target}: ${page} 144.if defined(MANFILTER) 145 ${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET} 146.else 147 ${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET} 148.endif 149.endfor 150.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 151.for target in ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/} 152_manpages: ${target} 153${target}: ${page} 154.if defined(MANFILTER) 155 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} | ${MCOMPRESS_CMD} > ${.TARGET} 156.else 157 ${MANDOC_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET} 158.endif 159.endfor 160.endif 161.endfor 162.endif 163 164.endif 165 166maninstall: _maninstall 167_maninstall: 168.if defined(MAN) && !empty(MAN) 169_maninstall: ${MAN} 170.if defined(NOMANCOMPRESS) 171.if defined(MANFILTER) 172.for page in ${MAN} 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} 178.endif 179.endfor 180.else 181 @set `echo ${.ALLSRC} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \ 182 while : ; do \ 183 case $$# in \ 184 0) break;; \ 185 1) echo "warn: missing extension: $$1"; break;; \ 186 esac; \ 187 page=$$1; shift; sect=$$1; shift; \ 188 d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \ 189 ${ECHO} ${MINSTALL} $${page} $${d}; \ 190 ${MINSTALL} $${page} $${d}; \ 191 done 192.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 193.for page in ${MAN} 194 ${MINSTALL} ${page:T:S/$/${CATEXT}/} \ 195 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T} 196.endfor 197.endif 198.endif 199.else 200.for page in ${MAN} 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}/} 206.endif 207.endfor 208.endif 209.endif 210 211.if !defined(NOMLINKS) && defined(MLINKS) && !empty(MLINKS) 212 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \ 213 while : ; do \ 214 case $$# in \ 215 0) break;; \ 216 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \ 217 esac; \ 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}; \ 225 done 226.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 227 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \ 228 while : ; do \ 229 case $$# in \ 230 0) break;; \ 231 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \ 232 esac; \ 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}; \ 240 done 241.endif 242.endif 243 244manlint: 245#mandiff: 246.if defined(MAN) && !empty(MAN) 247.for page in ${MAN} 248manlint: ${page}lint 249#mandiff: ${page}diff 250${page}lint: ${page} 251.if defined(MANFILTER) 252# @${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} -ww -z 253 @-${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} -Tlint 254.else 255# @${MROFF_CMD} -ww -z ${.ALLSRC} 256 @-${MANDOC_CMD} -Tlint ${.ALLSRC} 257.endif 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} 264# @rm ${.ALLSRC} 265.endfor 266.endif 267