1# $FreeBSD$ 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# MROFF_CMD command and flags to create preformatted pages 45# 46# +++ targets +++ 47# 48# maninstall: 49# Install the manual pages and their links. 50# 51 52.if !target(__<bsd.init.mk>__) 53.error bsd.man.mk cannot be included directly. 54.endif 55 56MINSTALL= ${INSTALL} ${COPY} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} 57 58CATDIR= ${MANDIR:H:S/$/\/cat/} 59CATEXT= .cat 60MROFF_CMD?= groff -Tascii -mtty-char -man -t 61 62MCOMPRESS_CMD?= ${COMPRESS_CMD} 63MCOMPRESS_EXT?= ${COMPRESS_EXT} 64 65SECTIONS= 1 1aout 2 3 4 5 6 7 8 9 66.SUFFIXES: ${SECTIONS:S/^/./g} 67 68# Backwards compatibility. 69.if !defined(MAN) 70.for sect in ${SECTIONS} 71.if defined(MAN${sect}) && !empty(MAN${sect}) 72MAN+= ${MAN${sect}} 73.endif 74.endfor 75.endif 76 77all-man: 78 79.if defined(NOMANCOMPRESS) 80 81# Make special arrangements to filter to a temporary file at build time 82# for NOMANCOMPRESS. 83.if defined(MANFILTER) 84FILTEXTENSION= .filt 85.else 86FILTEXTENSION= 87.endif 88 89ZEXT= 90 91.if defined(MANFILTER) 92.if defined(MAN) && !empty(MAN) 93CLEANFILES+= ${MAN:T:S/$/${FILTEXTENSION}/g} 94CLEANFILES+= ${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g} 95.for page in ${MAN} 96.for target in ${page:T:S/$/${FILTEXTENSION}/g} 97all-man: ${target} 98${target}: ${page} 99 ${MANFILTER} < ${.ALLSRC} > ${.TARGET} 100.endfor 101.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 102.for target in ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g} 103all-man: ${target} 104${target}: ${page} 105 ${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} > ${.TARGET} 106.endfor 107.endif 108.endfor 109.endif 110.else 111.if defined(MAN) && !empty(MAN) 112CLEANFILES+= ${MAN:T:S/$/${CATEXT}/g} 113.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 114.for page in ${MAN} 115.for target in ${page:T:S/$/${CATEXT}/g} 116all-man: ${target} 117${target}: ${page} 118 ${MROFF_CMD} ${.ALLSRC} > ${.TARGET} 119.endfor 120.endfor 121.endif 122.endif 123.endif 124 125.else 126 127ZEXT= ${MCOMPRESS_EXT} 128 129.if defined(MAN) && !empty(MAN) 130CLEANFILES+= ${MAN:T:S/$/${MCOMPRESS_EXT}/g} 131CLEANFILES+= ${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} 132.for page in ${MAN} 133.for target in ${page:T:S/$/${MCOMPRESS_EXT}/} 134all-man: ${target} 135${target}: ${page} 136.if defined(MANFILTER) 137 ${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET} 138.else 139 ${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET} 140.endif 141.endfor 142.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 143.for target in ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/} 144all-man: ${target} 145${target}: ${page} 146.if defined(MANFILTER) 147 ${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} | ${MCOMPRESS_CMD} > ${.TARGET} 148.else 149 ${MROFF_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET} 150.endif 151.endfor 152.endif 153.endfor 154.endif 155 156.endif 157 158maninstall: 159.if defined(MAN) && !empty(MAN) 160maninstall: ${MAN} 161.if defined(NOMANCOMPRESS) 162.if defined(MANFILTER) 163.for page in ${MAN} 164 ${MINSTALL} ${page:T:S/$/${FILTEXTENSION}/g} \ 165 ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}/${page} 166.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 167 ${MINSTALL} ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \ 168 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page} 169.endif 170.endfor 171.else 172 @set `echo ${.ALLSRC} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \ 173 while : ; do \ 174 case $$# in \ 175 0) break;; \ 176 1) echo "warn: missing extension: $$1"; break;; \ 177 esac; \ 178 page=$$1; shift; sect=$$1; shift; \ 179 d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \ 180 ${ECHO} ${MINSTALL} $${page} $${d}; \ 181 ${MINSTALL} $${page} $${d}; \ 182 done 183.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 184.for page in ${MAN} 185 ${MINSTALL} ${page:T:S/$/${CATEXT}/} \ 186 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T} 187.endfor 188.endif 189.endif 190.else 191.for page in ${MAN} 192 ${MINSTALL} ${page:T:S/$/${MCOMPRESS_EXT}/g} \ 193 ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR} 194.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 195 ${MINSTALL} ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \ 196 ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T:S/$/${MCOMPRESS_EXT}/} 197.endif 198.endfor 199.endif 200.endif 201 202.if !defined(NOMLINKS) && defined(MLINKS) && !empty(MLINKS) 203 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \ 204 while : ; do \ 205 case $$# in \ 206 0) break;; \ 207 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \ 208 esac; \ 209 name=$$1; shift; sect=$$1; shift; \ 210 l=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \ 211 name=$$1; shift; sect=$$1; shift; \ 212 t=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \ 213 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \ 214 rm -f $${t} $${t}${MCOMPRESS_EXT}; \ 215 ln $${l}${ZEXT} $${t}${ZEXT}; \ 216 done 217.if defined(MANBUILDCAT) && !empty(MANBUILDCAT) 218 @set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \ 219 while : ; do \ 220 case $$# in \ 221 0) break;; \ 222 [123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \ 223 esac; \ 224 name=$$1; shift; sect=$$1; shift; \ 225 l=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \ 226 name=$$1; shift; sect=$$1; shift; \ 227 t=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \ 228 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \ 229 rm -f $${t} $${t}${MCOMPRESS_EXT}; \ 230 ln $${l}${ZEXT} $${t}${ZEXT}; \ 231 done 232.endif 233.endif 234 235manlint: 236.if defined(MAN) && !empty(MAN) 237.for page in ${MAN} 238manlint: ${page}lint 239${page}lint: ${page} 240.if defined(MANFILTER) 241 ${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} -ww -z 242.else 243 ${MROFF_CMD} -ww -z ${.ALLSRC} 244.endif 245.endfor 246.endif 247