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 MINSTALL?= ${INSTALL} ${TAG_ARGS} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE}
55 CATDIR= ${MANDIR:H:S/$/\/cat/}
57 MANDOC_CMD?= mandoc -Tascii
59 MCOMPRESS_CMD?= ${COMPRESS_CMD}
60 MCOMPRESS_EXT?= ${COMPRESS_EXT}
62 SECTIONS= 1 2 3 4 5 6 7 8 9
63 .SUFFIXES: ${SECTIONS:S/^/./g}
66 # Backwards compatibility.
68 .for __sect in ${SECTIONS}
69 .if defined(MAN${__sect}) && !empty(MAN${__sect})
78 .if ${MK_MANCOMPRESS} == "no"
80 # Make special arrangements to filter to a temporary file at build time
81 # for MK_MANCOMPRESS == no.
82 .if defined(MANFILTER)
90 .if defined(MANFILTER)
91 .if defined(MAN) && !empty(MAN)
92 CLEANFILES+= ${MAN:T:S/$/${FILTEXTENSION}/g}
93 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g}
95 .for __target in ${__page:T:S/$/${FILTEXTENSION}/g}
96 _manpages: ${__target}
97 ${__target}: ${__page}
98 ${MANFILTER} < ${.ALLSRC} > ${.TARGET}
100 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
101 .for __target in ${__page:T:S/$/${CATEXT}${FILTEXTENSION}/g}
102 _manpages: ${__target}
103 ${__target}: ${__page}
104 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} > ${.TARGET}
109 .else # !defined(MANFILTER)
110 .if defined(MAN) && !empty(MAN)
111 CLEANFILES+= ${MAN:T:S/$/${CATEXT}/g}
112 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
113 .for __page in ${MAN}
114 .for __target in ${__page:T:S/$/${CATEXT}/g}
115 _manpages: ${__target}
116 ${__target}: ${__page}
117 ${MANDOC_CMD} ${.ALLSRC} > ${.TARGET}
124 .endif # defined(MANFILTER)
126 .else # ${MK_MANCOMPRESS} == "yes"
128 ZEXT= ${MCOMPRESS_EXT}
130 .if defined(MAN) && !empty(MAN)
131 .if ${MK_STAGING_MAN} == "yes"
132 STAGE_TARGETS+= stage_files
133 _mansets:= ${MAN:E:O:u:M*[1-9]:@s@man$s@}
134 STAGE_SETS+= ${_mansets}
136 stage_files.man${_page:T:E}: ${_page}
137 STAGE_DIR.man${_page:T:E}?= ${STAGE_OBJTOP}${MANDIR}${_page:T:E}${MANSUBDIR}
141 STAGE_TARGETS+= stage_links
142 STAGE_LINKS.mlinks:= ${MLINKS:@f@${f:S,^,${MANDIR}${f:E}${MANSUBDIR}/,}@}
143 stage_links.mlinks: ${_mansets:@s@stage_files.$s@}
147 CLEANFILES+= ${MAN:T:S/$/${MCOMPRESS_EXT}/g}
148 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g}
149 .for __page in ${MAN}
150 .for __target in ${__page:T:S/$/${MCOMPRESS_EXT}/}
151 _manpages: ${__target}
152 ${__target}: ${__page}
153 .if defined(MANFILTER)
154 ${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
156 ${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET}
159 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
160 .for __target in ${__page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/}
161 _manpages: ${__target}
162 ${__target}: ${__page}
163 .if defined(MANFILTER)
164 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} | ${MCOMPRESS_CMD} > ${.TARGET}
166 ${MANDOC_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
173 .endif # ${MK_MANCOMPRESS} == "no"
175 maninstall: _maninstall
177 .if defined(MAN) && !empty(MAN)
179 .if ${MK_MANCOMPRESS} == "no"
180 .if defined(MANFILTER)
181 .for __page in ${MAN}
182 ${MINSTALL} ${__page:T:S/$/${FILTEXTENSION}/g} \
183 ${DESTDIR}${MANDIR}${__page:E}${MANSUBDIR}/${__page}
184 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
185 ${MINSTALL} ${__page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \
186 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page}
189 .else # !defined(MANFILTER)
190 @set ${.ALLSRC:C/\.([^.]*)$/.\1 \1/}; \
194 1) echo "warn: missing extension: $$1"; break;; \
196 page=$$1; shift; sect=$$1; shift; \
197 d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \
198 ${ECHO} ${MINSTALL} $${page} $${d}; \
199 ${MINSTALL} $${page} $${d}; \
201 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
202 .for __page in ${MAN}
203 ${MINSTALL} ${__page:T:S/$/${CATEXT}/} \
204 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page:T}
207 .endif # defined(MANFILTER)
208 .else # ${MK_MANCOMPRESS} == "yes"
209 .for __page in ${MAN}
210 ${MINSTALL} ${__page:T:S/$/${MCOMPRESS_EXT}/g} \
211 ${DESTDIR}${MANDIR}${__page:E}${MANSUBDIR}/
212 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
213 ${MINSTALL} ${__page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \
214 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page:T:S/$/${MCOMPRESS_EXT}/}
217 .endif # ${MK_MANCOMPRESS} == "no"
220 .if !defined(NO_MLINKS) && defined(MLINKS) && !empty(MLINKS)
221 .for _oname _osect _dname _dsect in ${MLINKS:C/\.([^.]*)$/.\1 \1/}
222 @l=${DESTDIR}${MANDIR}${_osect}${MANSUBDIR}/${_oname}; \
223 t=${DESTDIR}${MANDIR}${_dsect}${MANSUBDIR}/${_dname}; \
224 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
225 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
226 ${INSTALL_LINK} ${TAG_ARGS} $${l}${ZEXT} $${t}${ZEXT}
228 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
229 .for _oname _osect _dname _dsect in ${MLINKS:C/\.([^.]*)$/.\1 \1/}
230 @l=${DESTDIR}${MANDIR}${_osect}${MANSUBDIR}/${_oname}; \
231 t=${DESTDIR}${MANDIR}${_dsect}${MANSUBDIR}/${_dname}; \
232 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
233 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
234 ${INSTALL_LINK} ${TAG_ARGS} $${l}${ZEXT} $${t}${ZEXT}
240 .if defined(MAN) && !empty(MAN)
241 .for __page in ${MAN}
242 manlint: ${__page}lint
243 ${__page}lint: ${__page}
244 .if defined(MANFILTER)
245 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} -Tlint
247 ${MANDOC_CMD} -Tlint ${.ALLSRC}