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} -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}
65 # Backwards compatibility.
67 .for __sect in ${SECTIONS}
68 .if defined(MAN${__sect}) && !empty(MAN${__sect})
77 .if ${MK_MANCOMPRESS} == "no"
79 # Make special arrangements to filter to a temporary file at build time
80 # for MK_MANCOMPRESS == no.
81 .if defined(MANFILTER)
89 .if defined(MANFILTER)
90 .if defined(MAN) && !empty(MAN)
91 CLEANFILES+= ${MAN:T:S/$/${FILTEXTENSION}/g}
92 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g}
94 .for __target in ${__page:T:S/$/${FILTEXTENSION}/g}
95 _manpages: ${__target}
96 ${__target}: ${__page}
97 ${MANFILTER} < ${.ALLSRC} > ${.TARGET}
99 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
100 .for __target in ${__page:T:S/$/${CATEXT}${FILTEXTENSION}/g}
101 _manpages: ${__target}
102 ${__target}: ${__page}
103 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} > ${.TARGET}
108 .else # !defined(MANFILTER)
109 .if defined(MAN) && !empty(MAN)
110 CLEANFILES+= ${MAN:T:S/$/${CATEXT}/g}
111 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
112 .for __page in ${MAN}
113 .for __target in ${__page:T:S/$/${CATEXT}/g}
114 _manpages: ${__target}
115 ${__target}: ${__page}
116 ${MANDOC_CMD} ${.ALLSRC} > ${.TARGET}
123 .endif # defined(MANFILTER)
125 .else # ${MK_MANCOMPRESS} == "yes"
127 ZEXT= ${MCOMPRESS_EXT}
129 .if defined(MAN) && !empty(MAN)
130 .if ${MK_STAGING_MAN} == "yes"
131 STAGE_TARGETS+= stage_files
132 _mansets:= ${MAN:E:O:u:M*[1-9]:@s@man$s@}
133 STAGE_SETS+= ${_mansets}
135 stage_files.man${_page:T:E}: ${_page}
136 STAGE_DIR.man${_page:T:E}?= ${STAGE_OBJTOP}${MANDIR}${_page:T:E}${MANSUBDIR}
140 STAGE_TARGETS+= stage_links
141 STAGE_LINKS.mlinks:= ${MLINKS:@f@${f:S,^,${MANDIR}${f:E}${MANSUBDIR}/,}@}
142 stage_links.mlinks: ${_mansets:@s@stage_files.$s@}
146 CLEANFILES+= ${MAN:T:S/$/${MCOMPRESS_EXT}/g}
147 CLEANFILES+= ${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g}
148 .for __page in ${MAN}
149 .for __target in ${__page:T:S/$/${MCOMPRESS_EXT}/}
150 _manpages: ${__target}
151 ${__target}: ${__page}
152 .if defined(MANFILTER)
153 ${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
155 ${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET}
158 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
159 .for __target in ${__page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/}
160 _manpages: ${__target}
161 ${__target}: ${__page}
162 .if defined(MANFILTER)
163 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} | ${MCOMPRESS_CMD} > ${.TARGET}
165 ${MANDOC_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
172 .endif # ${MK_MANCOMPRESS} == "no"
174 maninstall: _maninstall
176 .if defined(MAN) && !empty(MAN)
178 .if ${MK_MANCOMPRESS} == "no"
179 .if defined(MANFILTER)
180 .for __page in ${MAN}
181 ${MINSTALL} ${__page:T:S/$/${FILTEXTENSION}/g} \
182 ${DESTDIR}${MANDIR}${__page:E}${MANSUBDIR}/${__page}
183 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
184 ${MINSTALL} ${__page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \
185 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page}
188 .else # !defined(MANFILTER)
189 @set ${.ALLSRC:C/\.([^.]*)$/.\1 \1/}; \
193 1) echo "warn: missing extension: $$1"; break;; \
195 page=$$1; shift; sect=$$1; shift; \
196 d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \
197 ${ECHO} ${MINSTALL} $${page} $${d}; \
198 ${MINSTALL} $${page} $${d}; \
200 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
201 .for __page in ${MAN}
202 ${MINSTALL} ${__page:T:S/$/${CATEXT}/} \
203 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page:T}
206 .endif # defined(MANFILTER)
207 .else # ${MK_MANCOMPRESS} == "yes"
208 .for __page in ${MAN}
209 ${MINSTALL} ${__page:T:S/$/${MCOMPRESS_EXT}/g} \
210 ${DESTDIR}${MANDIR}${__page:E}${MANSUBDIR}/
211 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
212 ${MINSTALL} ${__page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \
213 ${DESTDIR}${CATDIR}${__page:E}${MANSUBDIR}/${__page:T:S/$/${MCOMPRESS_EXT}/}
216 .endif # ${MK_MANCOMPRESS} == "no"
219 .if !defined(NO_MLINKS) && defined(MLINKS) && !empty(MLINKS)
220 .for _oname _osect _dname _dsect in ${MLINKS:C/\.([^.]*)$/.\1 \1/}
221 @l=${DESTDIR}${MANDIR}${_osect}${MANSUBDIR}/${_oname}; \
222 t=${DESTDIR}${MANDIR}${_dsect}${MANSUBDIR}/${_dname}; \
223 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
224 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
225 ${INSTALL_LINK} $${l}${ZEXT} $${t}${ZEXT}
227 .if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
228 .for _oname _osect _dname _dsect in ${MLINKS:C/\.([^.]*)$/.\1 \1/}
229 @l=${DESTDIR}${MANDIR}${_osect}${MANSUBDIR}/${_oname}; \
230 t=${DESTDIR}${MANDIR}${_dsect}${MANSUBDIR}/${_dname}; \
231 ${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
232 rm -f $${t} $${t}${MCOMPRESS_EXT}; \
233 ${INSTALL_LINK} $${l}${ZEXT} $${t}${ZEXT}
239 .if defined(MAN) && !empty(MAN)
240 .for __page in ${MAN}
241 manlint: ${__page}lint
242 ${__page}lint: ${__page}
243 .if defined(MANFILTER)
244 ${MANFILTER} < ${.ALLSRC} | ${MANDOC_CMD} -Tlint
246 ${MANDOC_CMD} -Tlint ${.ALLSRC}