freebsd-skq/share/mk/bsd.man.mk
Peter Wemm d5dcd8e63f Add a hook ``MANFILTER''. This optionally specifies a command to
pipe the man page source through before compressing or installing.
This can be used to do do (eg) sed substitution on man pages from
3rd party packages (in particular, ncurses and bind-4.9.4)

This should not affect anything already in the source tree.
1996-08-11 12:31:57 +00:00

145 lines
3.4 KiB
Makefile

# $Id: bsd.man.mk,v 1.13 1996/06/22 06:01:56 phk Exp $
#
# The include file <bsd.man.mk> handles installing manual pages and
# their links. <bsd.man.mk> includes the file named "../Makefile.inc"
# if it exists.
#
#
# +++ variables +++
#
# DESTDIR Change the tree where the man pages gets installed. [not set]
#
# MANDIR Base path for manual installation. [${SHAREDIR}/man/man]
#
# MANOWN Manual owner. [${SHAREOWN}]
#
# MANGRP Manual group. [${SHAREGRP}]
#
# MANMODE Manual mode. [${NOBINMODE}]
#
# MANSUBDIR Subdirectory under the manual page section, i.e. "/i386"
# or "/tahoe" for machine specific manual pages.
#
# MAN${sect} The manual pages to be installed. For sections see
# variable ${SECTIONS}
#
# _MANPAGES List of all man pages to be installed.
# (``_MANPAGES=$MAN1 $MAN2 ... $MANn'')
#
# MCOMPRESS Program to compress man pages. Output is to
# stdout. [gzip -c]
#
# MLINKS List of manual page links (using a suffix). The
# linked-to file must come first, the linked file
# second, and there may be multiple pairs. The files
# are hard-linked.
#
# NOMANCOMPRESS If you do not want unformatted manual pages to be
# compressed when they are installed. [not set]
#
# MANFILTER command to pipe the raw man page though before compressing
# or installing. Can be used to do sed substitution.
#
# +++ targets +++
#
# maninstall:
# Install the manual pages and their links.
#
.if exists(${.CURDIR}/../Makefile.inc)
.include "${.CURDIR}/../Makefile.inc"
.endif
MANSRC?= ${.CURDIR}
MINSTALL= ${INSTALL} ${COPY} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE}
MCOMPRESS= gzip -c
ZEXTENSION= .gz
SECTIONS= 1 2 3 3f 4 5 6 7 8 9 n
.undef _MANPAGES
.for sect in ${SECTIONS}
.if defined(MAN${sect}) && !empty(MAN${sect})
.SUFFIXES: .${sect}
.PATH.${sect}: ${MANSRC}
_MANPAGES+= ${MAN${sect}}
.endif
.endfor
all-man: ${MANDEPEND}
.if defined(NOMANCOMPRESS)
COPY= -c
ZEXT=
.if defined(MANFILTER)
.for sect in ${SECTIONS}
.if defined(MAN${sect}) && !empty(MAN${sect})
CLEANFILES+= ${MAN${sect}}
.for page in ${MAN${sect}}
.for target in ${page}
all-man: ${target}
${target}: ${page}
${MANFILT} < ${.ALLSRC} > ${.TARGET}
.endfor
.endfor
.endif
.endfor
.endif
.else
ZEXT= ${ZEXTENSION}
.for sect in ${SECTIONS}
.if defined(MAN${sect}) && !empty(MAN${sect})
CLEANFILES+= ${MAN${sect}:T:S/$/${ZEXTENSION}/g}
.for page in ${MAN${sect}}
.for target in ${page:T:S/$/${ZEXTENSION}/}
all-man: ${target}
${target}: ${page}
.if defined(MANFILT)
${MANFILT} < ${.ALLSRC} | ${MCOMPRESS} > ${.TARGET}
.else
${MCOMPRESS} ${.ALLSRC} > ${.TARGET}
.endif
.endfor
.endfor
.endif
.endfor
.endif
maninstall::
.for sect in ${SECTIONS}
.if defined(MAN${sect}) && !empty(MAN${sect})
maninstall:: ${MAN${sect}}
.if defined(NOMANCOMPRESS)
${MINSTALL} ${.ALLSRC} ${DESTDIR}${MANDIR}${sect}${MANSUBDIR}
.else
${MINSTALL} ${.ALLSRC:T:S/$/${ZEXTENSION}/g} \
${DESTDIR}${MANDIR}${sect}${MANSUBDIR}
.endif
.endif
.endfor
.if defined(MLINKS) && !empty(MLINKS)
@set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
while : ; do \
case $$# in \
0) break;; \
[123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \
esac; \
name=$$1; shift; sect=$$1; shift; \
l=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
name=$$1; shift; sect=$$1; shift; \
t=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
rm -f $${t} $${t}${ZEXTENSION}; \
ln $${l}${ZEXT} $${t}${ZEXT}; \
done
.endif