#       $NetBSD: bsd.man.mk,v 1.122 2020/11/10 21:47:49 kamil Exp $
#       @(#)bsd.man.mk  8.1 (Berkeley) 6/8/93

include <bsd.init.mk>

##### Basic targets
PHONY:          catinstall maninstall catpages manpages catlinks manlinks
PHONY:          htmlinstall htmlpages htmllinks
PHONY:          lintmanpages
realinstall:    ${MANINSTALL}

# If our install destination is case-preserving, but case-insensitive
# then we do filesystem comparisons in lower case to make sure that
# we always refresh the target when needed. In general we don't
# want to do this, otherwise things like _exit.2 -> _Exit.2 get
# installed on each build even when they don't need to. Note that
# the CASE_INSENSITIVE_DEST macro is currently not defined anywhere,
# and the expansion does not really work because of make(1).
if defined(CASE_INSENSITIVE_DEST)
_FLATTEN?=tl:
endif

##### Default values
if ${USETOOLS} == "yes"
TMACDEPDIR?=    ${TOOLDIR}/share/groff/tmac
else
TMACDEPDIR?=    /usr/share/tmac
endif

HTMLDIR?=       ${DESTDIR}${MANDIR}
if ${MKMANDOC} == yes && !defined(NOMANDOC)
CATDEPS?=
else
CATDEPS?=       ${TMACDEPDIR}/andoc.tmac \
               ${TMACDEPDIR}/doc.tmac \
               ${TMACDEPDIR}/mdoc/doc-common \
               ${TMACDEPDIR}/mdoc/doc-ditroff \
               ${TMACDEPDIR}/mdoc/doc-nroff \
               ${TMACDEPDIR}/mdoc/doc-syms
endif
MANTARGET?=     cat

MAN?=
MLINKS?=
_MSECTIONS=     1 2 3 4 5 6 7 8 9
_MSECTIONS+=    3lua 9lua
_MSECTIONREGEX= ${_MSECTIONS:ts|} # e.g. 1|2|3|...
SUFFIXES:       ${_MSECTIONS:@N@.$N@}

if ${MKMANZ} == "no"
MANCOMPRESS?=
MANSUFFIX?=
else
MANCOMPRESS?=   ${TOOL_GZIP_N} -cf
MANSUFFIX?=     .gz
endif

# make MANCOMPRESS a filter, so it can be inserted on an as-needed basis
if !empty(MANCOMPRESS)
MANCOMPRESS:=   | ${MANCOMPRESS}
endif

__installpage: .USE
       @cmp -s ${.ALLSRC} ${.TARGET} > /dev/null 2>&1 || \
           (${_MKSHMSG_INSTALL} ${.TARGET}; \
            ${_MKSHECHO} "${INSTALL_FILE} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
               ${.ALLSRC} ${.TARGET}" && \
            ${INSTALL_FILE} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
               ${.ALLSRC} ${.TARGET})

# XXX consider including bsd.links.mk and using __linkinstall instead
__linkinstallpage: .USE
       ${_MKSHMSG_INSTALL} ${.TARGET}; \
       ${_MKSHECHO} "${INSTALL_LINK} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
           ${.ALLSRC} ${.TARGET}" && \
       ${INSTALL_LINK} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE} \
           ${.ALLSRC} ${.TARGET}

##### Build and install rules (source form pages)

if ${MKMAN} != "no"
maninstall:     manpages manlinks
manpages::      # ensure target exists
MANPAGES=       ${MAN:C/.$/&${MANSUFFIX}/}

realall:        ${MANPAGES}
if !empty(MANSUFFIX)
NOPATH: ${MANPAGES}
SUFFIXES:       ${_MSECTIONS:@N@.$N${MANSUFFIX}@}

${_MSECTIONS:@N@.$N.$N${MANSUFFIX}@}:                   # build rule
       ${_MKTARGET_FORMAT}
       cat ${.IMPSRC} ${MANCOMPRESS} > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}
endif # !empty(MANSUFFIX)

for F in ${MANPAGES:S/${MANSUFFIX}$//:O:u}
_F:=            ${DESTDIR}${MANDIR}/man${F:T:E}${MANSUBDIR}/${F}${MANSUFFIX}

if ${MKUPDATE} == "no"
${_F}!          ${F}${MANSUFFIX} __installpage          # install rule
if !defined(BUILD) && !make(all) && !make(${F})
${_F}!          .MADE                                   # no build at install
endif
else
${_F}:          ${F}${MANSUFFIX} __installpage          # install rule
if !defined(BUILD) && !make(all) && !make(${F})
${_F}:          .MADE                                   # no build at install
endif
endif

manpages::      ${_F}
PRECIOUS:       ${_F}                                   # keep if install fails
endfor

manlinks::                                              # link install

for _src _dst in ${MLINKS}
_l:=${DESTDIR}${MANDIR}/man${_src:T:E}${MANSUBDIR}/${_src}${MANSUFFIX}
_t:=${DESTDIR}${MANDIR}/man${_dst:T:E}${MANSUBDIR}/${_dst}${MANSUFFIX}

# Handle case conflicts carefully, when _dst occurs
# more than once after case flattening
if ${MKUPDATE} == "no" || ${MLINKS:${_FLATTEN}M${_dst:${_FLATTEN}Q}:[\#]} > 1
${_t}!          ${_l} __linkinstallpage
else
${_t}:          ${_l} __linkinstallpage
endif

manlinks::      ${_t}
PRECIOUS:       ${_t}
endfor
endif # ${MKMAN} != "no"

##### Build and install rules (plaintext pages)

if (${MKCATPAGES} != "no") && (${MKMAN} != "no")
catinstall:     catpages catlinks
catpages::      # ensure target exists
CATPAGES=       ${MAN:C/\.(${_MSECTIONREGEX})\$/.cat\1${MANSUFFIX}/}

realall:        ${CATPAGES}
NOPATH: ${CATPAGES}
SUFFIXES:       ${_MSECTIONS:@[email protected]$N${MANSUFFIX}@}
MADE:   ${CATDEPS}

${_MSECTIONS:@N@.$N.cat$N${MANSUFFIX}@}: ${CATDEPS}     # build rule
       ${_MKTARGET_FORMAT}
if ${MKMANDOC} == yes && !defined(NOMANDOC)
       if test ""${NOMANDOC.${.IMPSRC:T}:tl:Q} != "yes"; then \
               ${TOOL_MANDOC_ASCII} ${.IMPSRC} ${MANCOMPRESS} \
                   > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}; \
       else \
               ${TOOL_ROFF_ASCII} -mandoc ${.IMPSRC} ${MANCOMPRESS} \
                   > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}; \
       fi
elif defined(USETBL)
       ${TOOL_TBL} ${.IMPSRC} | ${TOOL_ROFF_ASCII} -mandoc ${MANCOMPRESS} \
           > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}
else
       ${TOOL_ROFF_ASCII} -mandoc ${.IMPSRC} ${MANCOMPRESS} \
           > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}
endif

for F in ${CATPAGES:S/${MANSUFFIX}$//:O:u}
_F:=            ${DESTDIR}${MANDIR}/${F:T:E}${MANSUBDIR}/${F:R}.0${MANSUFFIX}

if ${MKUPDATE} == "no"
${_F}!          ${F}${MANSUFFIX} __installpage          # install rule
if !defined(BUILD) && !make(all) && !make(${F})
${_F}!          .MADE                                   # no build at install
endif
else
${_F}:          ${F}${MANSUFFIX} __installpage          # install rule
if !defined(BUILD) && !make(all) && !make(${F})
${_F}:          .MADE                                   # no build at install
endif
endif

catpages::      ${_F}
PRECIOUS:       ${_F}                                   # keep if install fails
endfor

catlinks::                                              # link install

for _src _dst in ${MLINKS}
_l:=${DESTDIR}${MANDIR}/cat${_src:T:E}${MANSUBDIR}/${_src:R}.0${MANSUFFIX}
_t:=${DESTDIR}${MANDIR}/cat${_dst:T:E}${MANSUBDIR}/${_dst:R}.0${MANSUFFIX}

# Handle case conflicts carefully, when _dst occurs
# more than once after case flattening
if ${MKUPDATE} == "no" || ${MLINKS:${_FLATTEN}M${_dst:${_FLATTEN}Q}:[\#]} > 1
${_t}!          ${_l} __linkinstallpage
else
${_t}:          ${_l} __linkinstallpage
endif

catlinks::      ${_t}
PRECIOUS:       ${_t}
endfor
endif # (${MKCATPAGES} != "no") && (${MKMAN} != "no")

##### Build and install rules (HTML pages)

if (${MKHTML} != "no") && (${MKMAN} != "no")            # {
htmlinstall:    htmlpages htmllinks
htmlpages::     # ensure target exists
HTMLPAGES=      ${MAN:C/\.(${_MSECTIONREGEX})\$/.html\1/}

HTMLLINKS=      ${MANSUBDIR:?../:}../html%S/%N.html
HTMLSTYLE=      ${MANSUBDIR:?../:}../style.css

realall:        ${HTMLPAGES}
NOPATH: ${HTMLPAGES}
SUFFIXES:       ${_MSECTIONS:@[email protected]$N@}

${_MSECTIONS:@N@.$N.html$N@}:                           # build rule
       ${_MKTARGET_FORMAT}
if ${MKMANDOC} == yes && !defined(NOMANDOC)
       if test ""${NOMANDOC.${.IMPSRC:T}:tl:Q} != "yes"; then \
           ${TOOL_MANDOC_HTML} -Oman=${HTMLLINKS},style=${HTMLSTYLE} \
               ${.IMPSRC} > ${.TARGET}.tmp && \
               ${MV} ${.TARGET}.tmp ${.TARGET}; \
       else \
               ${TOOL_ROFF_HTML} ${.IMPSRC} ${MANCOMPRESS} \
                   > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}; \
       fi
elif defined(USETBL)
       ${TOOL_TBL} ${.IMPSRC} | ${TOOL_ROFF_HTML} ${MANCOMPRESS} \
           > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}
else
       ${TOOL_ROFF_HTML} ${.IMPSRC} ${MANCOMPRESS} \
           > ${.TARGET}.tmp && ${MV} ${.TARGET}.tmp ${.TARGET}
endif

for F in ${HTMLPAGES:O:u}
# construct installed path
_F:=            ${HTMLDIR}/${F:T:E}${MANSUBDIR}/${F:R:S-/index$-/x&-}.html

if ${MKUPDATE} == "no"
${_F}!          ${F} __installpage                      # install rule
if !defined(BUILD) && !make(all) && !make(${F})
${_F}!          .MADE                                   # no build at install
endif
else
${_F}:          ${F} __installpage                      # install rule
if !defined(BUILD) && !make(all) && !make(${F})
${_F}:          .MADE                                   # no build at install
endif
endif

htmlpages::     ${_F}
PRECIOUS:       ${_F}                                   # keep if install fails
endfor

htmllinks::                                             # link install

for _src _dst in ${MLINKS}
_l:=${HTMLDIR}/html${_src:T:E}${MANSUBDIR}/${_src:R:S-/index$-/x&-}.html
_t:=${HTMLDIR}/html${_dst:T:E}${MANSUBDIR}/${_dst:R:S-/index$-/x&-}.html

# Handle case conflicts carefully, when _dst occurs
# more than once after case flattening
if ${MKUPDATE} == "no" || ${MLINKS:${_FLATTEN}M${_dst:${_FLATTEN}Q}:[\#]} > 1
${_t}!          ${_l} __linkinstallpage
else
${_t}:          ${_l} __linkinstallpage
endif

htmllinks::     ${_t}
PRECIOUS:       ${_t}
endfor

endif                                                   # }

##### Clean rules
undef _F

if !empty(MAN) && (${MKMAN} != "no")
if (${MKCATPAGES} != "no")
CLEANDIRFILES+= ${CATPAGES}
endif
if !empty(MANSUFFIX)
CLEANDIRFILES+= ${MANPAGES} ${CATPAGES:S/${MANSUFFIX}$//}
endif
if ${MKHTML} != "no"
CLEANDIRFILES+= ${HTMLPAGES}
endif
endif
# (XXX ${CATPAGES:S...} cleans up old .catN files where .catN.gz now used)

if !empty(MANPAGES)
lintmanpages: ${MANPAGES}
       ${TOOL_MANDOC_LINT} -Tlint -fstrict -Wall,stop ${.ALLSRC}
endif

##### describe
describe:
for _M in ${MANPAGES}
       @echo $$(basename ${_M}) - \
               $$(${TOOL_SED} < ${${_M}:P} -n -e '/^\.Nd /{;s/^....//;p;}')
endfor


##### Pull in related .mk logic
include <bsd.obj.mk>
include <bsd.files.mk>
include <bsd.sys.mk>
include <bsd.clean.mk>

${TARGETS} catinstall maninstall htmlinstall: # ensure existence