1 # from: @(#)bsd.doc.mk 5.3 (Berkeley) 1/2/91
4 # The include file <bsd.doc.mk> handles installing BSD troff documents.
9 # DCOMPRESS_CMD Program to compress troff documents. Output is to stdout.
12 # DESTDIR Change the tree where the documents get installed. [not set]
14 # DOC Document name. [paper]
16 # EXTRA Extra files (not SRCS) that make up the document. [not set]
18 # LPR Printer command. [lpr]
20 # MACROS Macro packages used to build the document. [not set]
22 # NO_DOCCOMPRESS If you do not want formatted troff documents to be
23 # compressed when they are installed. [not set]
25 # PRINTERDEVICE Indicates which output formats will be generated
26 # (ascii, ps, html). [ascii]
28 # SRCDIR Directory where source files live. [${.CURDIR}]
30 # SRCS List of source files. [not set]
32 # TRFLAGS Additional flags to groff(1). [not set]
34 # USE_EQN If set, preprocess with eqn(1). [not set]
36 # USE_PIC If set, preprocess with pic(1). [not set]
38 # USE_REFER If set, preprocess with refer(1). [not set]
40 # USE_SOELIM If set, preprocess with soelim(1). [not set]
42 # USE_TBL If set, preprocess with tbl(1). [not set]
44 # VOLUME Volume the document belongs to. [not set]
46 .include <bsd.init.mk>
56 .for _dev in ${PRINTERDEVICE:Mascii}
57 ROFF.ascii?= groff -Tascii -P-c ${TRFLAGS} -mtty-char ${MACROS} ${PAGES:C/^/-o/1}
59 .for _dev in ${PRINTERDEVICE:Nascii}
60 ROFF.${_dev}?= groff -T${_dev} ${TRFLAGS} ${MACROS} ${PAGES:C/^/-o/1}
74 .if defined(USE_REFER)
77 .if defined(USE_SOELIM)
84 DCOMPRESS_EXT?= ${COMPRESS_EXT}
85 DCOMPRESS_CMD?= ${COMPRESS_CMD}
86 .for _dev in ${PRINTERDEVICE:Mhtml}
87 DFILE.html= ${DOC}.html
89 .for _dev in ${PRINTERDEVICE:Nhtml}
90 .if defined(NO_DOCCOMPRESS)
91 DFILE.${_dev}= ${DOC}.${_dev}
93 DFILE.${_dev}= ${DOC}.${_dev}${DCOMPRESS_EXT}
100 .if ${HTML_SPLIT} == "yes"
101 UNROFFFLAGS+= split=1
104 # Compatibility mode flag for groff. Use this when formatting documents with
105 # Berkeley me macros (orig_me(7)).
108 .PATH: ${.CURDIR} ${SRCDIR}
110 .for _dev in ${PRINTERDEVICE}
111 all: ${DFILE.${_dev}}
115 .for _dev in ${PRINTERDEVICE}
116 print: ${DFILE.${_dev}}
119 .for _dev in ${PRINTERDEVICE}
120 .if defined(NO_DOCCOMPRESS)
121 ${LPR} ${DFILE.${_dev}}
123 ${DCOMPRESS_CMD} -d ${DFILE.${_dev}} | ${LPR}
128 .for _dev in ${PRINTERDEVICE:Nascii:Nps:Nhtml}
129 CLEANFILES+= ${DOC}.${_dev} ${DOC}.${_dev}${DCOMPRESS_EXT}
131 CLEANFILES+= ${DOC}.ascii ${DOC}.ascii${DCOMPRESS_EXT} \
132 ${DOC}.ps ${DOC}.ps${DCOMPRESS_EXT} \
133 ${DOC}.html ${DOC}-*.html
136 .if ${PRINTERDEVICE:Mhtml}
138 ${INSTALL} -o ${BINOWN} -g ${BINGRP} -m ${BINMODE} \
139 ${DOC}*.html ${DESTDIR}${BINDIR}/${VOLUME}
141 .for _dev in ${PRINTERDEVICE:Nhtml}
142 ${INSTALL} -o ${BINOWN} -g ${BINGRP} -m ${BINMODE} \
143 ${DFILE.${_dev}} ${DESTDIR}${BINDIR}/${VOLUME}
147 (cd ${.CURDIR}; spell ${SRCS} ) | sort | \
148 comm -23 - ${.CURDIR}/spell.ok > ${DOC}.spell
150 BINDIR?= /usr/share/doc
155 .if defined(EXTRA) && !empty(EXTRA)
156 _stamp.extra: ${EXTRA}
160 CLEANFILES+= _stamp.extra
161 .for _dev in ${PRINTERDEVICE:Nhtml}
162 .if !target(${DFILE.${_dev}})
163 .if target(_stamp.extra)
164 ${DFILE.${_dev}}: _stamp.extra
166 ${DFILE.${_dev}}: ${SRCS}
167 .if defined(NO_DOCCOMPRESS)
168 ${ROFF.${_dev}} ${.ALLSRC:N_stamp.extra} > ${.TARGET}
170 ${ROFF.${_dev}} ${.ALLSRC:N_stamp.extra} | ${DCOMPRESS_CMD} > ${.TARGET}
175 .for _dev in ${PRINTERDEVICE:Mhtml}
176 .if !target(${DFILE.html})
177 .if target(_stamp.extra)
178 ${DFILE.html}: _stamp.extra
180 ${DFILE.html}: ${SRCS}
181 .if defined(MACROS) && !empty(MACROS)
182 cd ${SRCDIR}; ${UNROFF} ${MACROS} ${UNROFFFLAGS} \
183 document=${DOC} ${SRCS}
184 .else # unroff(1) requires a macro package as an argument
185 cd ${SRCDIR}; ${UNROFF} -ms ${UNROFFFLAGS} \
186 document=${DOC} ${SRCS}
193 .include <bsd.obj.mk>