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 # NO_MLINKS If you do not want install manual page links. [not set]
35 # MANFILTER command to pipe the raw man page through before compressing
36 # or installing. Can be used to do sed substitution.
38 # MANBUILDCAT create preformatted manual pages in addition to normal
41 # MANDOC_CMD command and flags to create preformatted pages
46 # Install the manual pages and their links.
49 .if !target(__<bsd.init.mk>__)
50 .error bsd.man.mk cannot be included directly.
53 .if ${MK_MANSPLITPKG} == "no"
54 MINSTALL?= ${INSTALL} ${TAG_ARGS} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE}
56 MINSTALL?= ${INSTALL} ${TAG_ARGS:D${TAG_ARGS},man} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE}
59 CATDIR= ${MANDIR:H:S/$/\/cat/}
61 MANDOC_CMD?= mandoc -Tascii
63 MCOMPRESS_CMD?= ${COMPRESS_CMD}
64 MCOMPRESS_EXT?= ${COMPRESS_EXT}
66 SECTIONS= 1 2 3 4 5 6 7 8 9
67 .SUFFIXES: ${SECTIONS:S/^/./g}
70 # Backwards compatibility.
72 .for __sect in ${SECTIONS}
73 .if defined(MAN${__sect}) && !empty(MAN${__sect})
81 .if ${MK_MANCOMPRESS} == "no"
83 # Make special arrangements to filter to a temporary file at build time
84 # for MK_MANCOMPRESS == no.
85 .if defined(MANFILTER)
93 .if defined(MANFILTER)
94 .if defined(MAN) && !empty(MAN)
95 CLEANFILES+= ${MAN:T:S/$/${FILTEXTENSION}/g}
96 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g}
98 .for __target in ${__page:T:S/$/${FILTEXTENSION}/g}
100 ${__target}: ${__page}
101 ${MANFILTER} < ${.ALLSRC} > ${.TARGET}
103 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
104 .for __target in ${__page:T:S/$/${CATEXT}${FILTEXTENSION}/g}
106 ${__target}: ${__page}
107 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} > ${.TARGET}
112 .else # !defined(MANFILTER)
113 .if defined(MAN) && !empty(MAN)
114 CLEANFILES+= ${MAN:T:S/$/${CATEXT}/g}
115 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
116 .for __page in ${MAN}
117 .for __target in ${__page:T:S/$/${CATEXT}/g}
119 ${__target}: ${__page}
120 ${MANDOC_CMD} ${.ALLSRC} > ${.TARGET}
127 .endif # defined(MANFILTER)
129 .else # ${MK_MANCOMPRESS} == "yes"
131 ZEXT= ${MCOMPRESS_EXT}
133 .if defined(MAN) && !empty(MAN)
134 .if ${MK_STAGING_MAN} == "yes"
135 STAGE_TARGETS+= stage_files
136 _mansets:= ${MAN:E:O:u:M*[1-9]:@s@man$s@}
137 STAGE_SETS+= ${_mansets}
139 stage_files.man${_page:T:E}: ${_page}
140 STAGE_DIR.man${_page:T:E}?= ${STAGE_OBJTOP}${MANDIR}${_page:T:E}${MANSUBDIR}
144 STAGE_TARGETS+= stage_links
145 STAGE_LINKS.mlinks:= ${MLINKS:@f@${f:S,^,${MANDIR}${f:E}${MANSUBDIR}/,}@}
146 stage_links.mlinks: ${_mansets:@s@stage_files.$s@}
150 CLEANFILES+= ${MAN:T:S/$/${MCOMPRESS_EXT}/g}
151 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g}
152 .for __page in ${MAN}
153 .for __target in ${__page:T:S/$/${MCOMPRESS_EXT}/}
155 ${__target}: ${__page}
156 .if defined(MANFILTER)
157 ${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
159 ${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET}
162 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
163 .for __target in ${__page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/}
165 ${__target}: ${__page}
166 .if defined(MANFILTER)
167 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} | ${MCOMPRESS_CMD} > ${.TARGET}
169 ${MANDOC_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
176 .endif # ${MK_MANCOMPRESS} == "no"
178 .if !defined(NO_MLINKS) && defined(MLINKS) && !empty(MLINKS)
179 .for _oname _osect _dname _dsect in ${MLINKS:C/\.([^.]*)$/.\1 \1/}
180 _MANLINKS+= ${MANDIR}${_osect}${MANSUBDIR}/${_oname} \
181 ${MANDIR}${_dsect}${MANSUBDIR}/${_dname}
182 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
183 _MANLINKS+= ${CATDIR}${_osect}${MANSUBDIR}/${_oname} \
184 ${CATDIR}${_dsect}${MANSUBDIR}/${_dname}
190 .if defined(MAN) && !empty(MAN)
192 .if ${MK_MANCOMPRESS} == "no"
193 .if defined(MANFILTER)
194 .for __page in ${MAN}
195 ${MINSTALL} ${__page:T:S/$/${FILTEXTENSION}/g} \
196 ${DESTDIR}${MANDIR}${__page:E}${MANSUBDIR}/${__page}
197 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
198 ${MINSTALL} ${__page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \
199 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page}
202 .else # !defined(MANFILTER)
203 @set ${.ALLSRC:C/\.([^.]*)$/.\1 \1/}; \
207 1) echo "warn: missing extension: $$1"; break;; \
209 page=$$1; shift; sect=$$1; shift; \
210 d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \
211 ${ECHO} ${MINSTALL} $${page} $${d}; \
212 ${MINSTALL} $${page} $${d}; \
214 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
215 .for __page in ${MAN}
216 ${MINSTALL} ${__page:T:S/$/${CATEXT}/} \
217 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page:T}
220 .endif # defined(MANFILTER)
221 .else # ${MK_MANCOMPRESS} == "yes"
222 .for __page in ${MAN}
223 ${MINSTALL} ${__page:T:S/$/${MCOMPRESS_EXT}/g} \
224 ${DESTDIR}${MANDIR}${__page:E}${MANSUBDIR}/
225 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
226 ${MINSTALL} ${__page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \
227 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page:T:S/$/${MCOMPRESS_EXT}/}
230 .endif # ${MK_MANCOMPRESS} == "no"
232 .for l t in ${_MANLINKS}
233 .if ${MK_MANSPLITPKG} == "no"
234 rm -f ${DESTDIR}${t} ${DESTDIR}${t}${MCOMPRESS_EXT}; \
235 ${INSTALL_MANLINK} ${TAG_ARGS} ${DESTDIR}${l}${ZEXT} ${DESTDIR}${t}${ZEXT}
237 rm -f ${DESTDIR}${t} ${DESTDIR}${t}${MCOMPRESS_EXT}; \
238 ${INSTALL_MANLINK} ${TAG_ARGS:D${TAG_ARGS},man} ${DESTDIR}${l}${ZEXT} ${DESTDIR}${t}${ZEXT}
243 .if defined(MAN) && !empty(MAN)
244 .for __page in ${MAN}
245 manlint: ${__page}lint
246 ${__page}lint: ${__page}
247 .if defined(MANFILTER)
248 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} -Tlint
250 ${MANDOC_CMD} -Tlint ${.ALLSRC}