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 ${TRFLAGS} -mtty-char ${MACROS} -o${PAGES}
59 .for _dev in ${PRINTERDEVICE:Nascii}
60 ROFF.${_dev}?= groff -T${_dev} ${TRFLAGS} ${MACROS} -o${PAGES}
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}
102 .if ${HTML_SPLIT} == "yes"
103 UNROFFFLAGS+= split=1
106 # Compatibility mode flag for groff. Use this when formatting documents with
107 # Berkeley me macros (orig_me(7)).
110 .PATH: ${.CURDIR} ${SRCDIR}
112 .for _dev in ${PRINTERDEVICE}
113 all: ${DFILE.${_dev}}
117 .for _dev in ${PRINTERDEVICE}
118 print: ${DFILE.${_dev}}
121 .for _dev in ${PRINTERDEVICE}
122 .if defined(NO_DOCCOMPRESS)
123 ${LPR} ${DFILE.${_dev}}
125 ${DCOMPRESS_CMD} -d ${DFILE.${_dev}} | ${LPR}
130 .for _dev in ${PRINTERDEVICE:Nascii:Nps:Nhtml}
131 CLEANFILES+= ${DOC}.${_dev} ${DOC}.${_dev}${DCOMPRESS_EXT}
133 CLEANFILES+= ${DOC}.ascii ${DOC}.ascii${DCOMPRESS_EXT} \
134 ${DOC}.ps ${DOC}.ps${DCOMPRESS_EXT} \
135 ${DOC}.html ${DOC}-*.html
138 .for _dev in ${PRINTERDEVICE:Mhtml}
140 ${INSTALL} -o ${BINOWN} -g ${BINGRP} -m ${BINMODE} \
141 ${DOC}*.html ${DESTDIR}${BINDIR}/${VOLUME}
143 .for _dev in ${PRINTERDEVICE:Nhtml}
144 ${INSTALL} -o ${BINOWN} -g ${BINGRP} -m ${BINMODE} \
145 ${DFILE.${_dev}} ${DESTDIR}${BINDIR}/${VOLUME}
149 (cd ${.CURDIR}; spell ${SRCS} ) | sort | \
150 comm -23 - ${.CURDIR}/spell.ok > ${DOC}.spell
152 BINDIR?= /usr/share/doc
157 .if defined(EXTRA) && !empty(EXTRA)
158 _stamp.extra: ${EXTRA}
162 CLEANFILES+= _stamp.extra
163 .for _dev in ${PRINTERDEVICE:Nhtml}
164 .if !target(${DFILE.${_dev}})
165 .if target(_stamp.extra)
166 ${DFILE.${_dev}}: _stamp.extra
168 ${DFILE.${_dev}}: ${SRCS}
169 .if defined(NO_DOCCOMPRESS)
170 ${ROFF.${_dev}} ${.ALLSRC:N_stamp.extra} > ${.TARGET}
172 ${ROFF.${_dev}} ${.ALLSRC:N_stamp.extra} | ${DCOMPRESS_CMD} > ${.TARGET}
177 .for _dev in ${PRINTERDEVICE:Mhtml}
178 .if !target(${DFILE.html})
179 .if target(_stamp.extra)
180 ${DFILE.html}: _stamp.extra
182 ${DFILE.html}: ${SRCS}
183 .if defined(MACROS) && !empty(MACROS)
184 cd ${SRCDIR}; ${UNROFF} ${MACROS} ${UNROFFFLAGS} \
185 document=${DOC} ${SRCS}
186 .else # unroff(1) requires a macro package as an argument
187 cd ${SRCDIR}; ${UNROFF} -ms ${UNROFFFLAGS} \
188 document=${DOC} ${SRCS}
196 .include <bsd.obj.mk>