xref: /freebsd/share/mk/bsd.man.mk (revision ce4946daa5ce852d28008dac492029500ab2ee95) 
1# $FreeBSD$
2#
3# The include file <bsd.man.mk> handles installing manual pages and
4# their links.
5#
6#
7# +++ variables +++
8#
9# DESTDIR	Change the tree where the man pages gets installed. [not set]
10#
11# MANDIR	Base path for manual installation. [${SHAREDIR}/man/man]
12#
13# MANOWN	Manual owner. [${SHAREOWN}]
14#
15# MANGRP	Manual group. [${SHAREGRP}]
16#
17# MANMODE	Manual mode. [${NOBINMODE}]
18#
19# MANSUBDIR	Subdirectory under the manual page section, i.e. "/i386"
20#		or "/tahoe" for machine specific manual pages.
21#
22# MAN		The manual pages to be installed. For sections see
23#		variable ${SECTIONS}
24#
25# MCOMPRESS_CMD	Program to compress man pages. Output is to
26#		stdout. [${COMPRESS_CMD}]
27#
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
31#		are hard-linked.
32#
33# NOMANCOMPRESS	If you do not want unformatted manual pages to be
34#		compressed when they are installed. [not set]
35#
36# NOMLINKS	If you do not want install manual page links. [not set]
37#
38# MANFILTER	command to pipe the raw man page through before compressing
39#		or installing.  Can be used to do sed substitution.
40#
41# MANBUILDCAT	create preformatted manual pages in addition to normal
42#		pages. [not set]
43#
44# MROFF_CMD	command and flags to create preformatted pages
45#
46# +++ targets +++
47#
48#	maninstall:
49#		Install the manual pages and their links.
50#
51
52MINSTALL=	${INSTALL} ${COPY} -o ${MANOWN} -g ${MANGRP} -m ${MANMODE}
53
54CATDIR=		${MANDIR:H:S/$/\/cat/}
55CATEXT=		.cat
56MROFF_CMD?=	groff -Tascii -mtty-char -man
57
58MCOMPRESS_CMD?=	${COMPRESS_CMD}
59MCOMPRESS_EXT?=	${COMPRESS_EXT}
60
61SECTIONS=	1 1aout 2 3 4 5 6 7 8 9
62.SUFFIXES:	${SECTIONS:S/^/./g}
63
64# Backwards compatibility.
65.if !defined(MAN)
66.for sect in ${SECTIONS}
67.if defined(MAN${sect}) && !empty(MAN${sect})
68MAN+=	${MAN${sect}}
69.endif
70.endfor
71.endif
72
73all-man:
74
75.if defined(NOMANCOMPRESS)
76
77COPY=		-c
78
79# Make special arrangements to filter to a temporary file at build time
80# for NOMANCOMPRESS.
81.if defined(MANFILTER)
82FILTEXTENSION=		.filt
83.else
84FILTEXTENSION=
85.endif
86
87ZEXT=
88
89.if defined(MANFILTER)
90.if defined(MAN) && !empty(MAN)
91CLEANFILES+=	${MAN:T:S/$/${FILTEXTENSION}/g}
92CLEANFILES+=	${MAN:T:S/$/${CATEXT}${FILTEXTENSION}/g}
93.for page in ${MAN}
94.for target in ${page:T:S/$/${FILTEXTENSION}/g}
95all-man: ${target}
96${target}: ${page}
97	${MANFILTER} < ${.ALLSRC} > ${.TARGET}
98.endfor
99.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
100.for target in ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g}
101all-man: ${target}
102${target}: ${page}
103	${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} > ${.TARGET}
104.endfor
105.endif
106.endfor
107.endif
108.else
109.if defined(MAN) && !empty(MAN)
110CLEANFILES+=	${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}
114all-man: ${target}
115${target}: ${page}
116	${MROFF_CMD} ${.ALLSRC} > ${.TARGET}
117.endfor
118.endfor
119.endif
120.endif
121.endif
122
123.else
124
125ZEXT=		${MCOMPRESS_EXT}
126
127.if defined(MAN) && !empty(MAN)
128CLEANFILES+=	${MAN:T:S/$/${MCOMPRESS_EXT}/g}
129CLEANFILES+=	${MAN:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g}
130.for page in ${MAN}
131.for target in ${page:T:S/$/${MCOMPRESS_EXT}/}
132all-man: ${target}
133${target}: ${page}
134.if defined(MANFILTER)
135	${MANFILTER} < ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
136.else
137	${MCOMPRESS_CMD} ${.ALLSRC} > ${.TARGET}
138.endif
139.endfor
140.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
141.for target in ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/}
142all-man: ${target}
143${target}: ${page}
144.if defined(MANFILTER)
145	${MANFILTER} < ${.ALLSRC} | ${MROFF_CMD} | ${MCOMPRESS_CMD} > ${.TARGET}
146.else
147	${MROFF_CMD} ${.ALLSRC} | ${MCOMPRESS_CMD} > ${.TARGET}
148.endif
149.endfor
150.endif
151.endfor
152.endif
153
154.endif
155
156maninstall::
157.if defined(MAN) && !empty(MAN)
158maninstall:: ${MAN}
159.if defined(NOMANCOMPRESS)
160.if defined(MANFILTER)
161.for page in ${MAN}
162	${MINSTALL} ${page:T:S/$/${FILTEXTENSION}/g} \
163		${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}/${page}
164.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
165	${MINSTALL} ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \
166		${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page}
167.endif
168.endfor
169.else
170	@set `echo ${.ALLSRC} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
171	while : ; do \
172		case $$# in \
173			0) break;; \
174			1) echo "warn: missing extension: $$1"; break;; \
175		esac; \
176		page=$$1; shift; sect=$$1; shift; \
177		d=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}; \
178		${ECHO} ${MINSTALL} $${page} $${d}; \
179		${MINSTALL} $${page} $${d}; \
180	done
181.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
182.for page in ${MAN}
183	${MINSTALL} ${page:T:S/$/${CATEXT}/} \
184		${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T}
185.endfor
186.endif
187.endif
188.else
189.for page in ${MAN}
190	${MINSTALL} ${page:T:S/$/${MCOMPRESS_EXT}/g} \
191		${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}
192.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
193	${MINSTALL} ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \
194		${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T:S/$/${MCOMPRESS_EXT}/}
195.endif
196.endfor
197.endif
198.endif
199
200.if !defined(NOMLINKS) && defined(MLINKS) && !empty(MLINKS)
201	@set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
202	while : ; do \
203		case $$# in \
204			0) break;; \
205			[123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \
206		esac; \
207		name=$$1; shift; sect=$$1; shift; \
208		l=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
209		name=$$1; shift; sect=$$1; shift; \
210		t=${DESTDIR}${MANDIR}$${sect}${MANSUBDIR}/$$name; \
211		${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
212		rm -f $${t} $${t}${MCOMPRESS_EXT}; \
213		ln $${l}${ZEXT} $${t}${ZEXT}; \
214	done
215.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
216	@set `echo ${MLINKS} " " | sed 's/\.\([^.]*\) /.\1 \1 /g'`; \
217	while : ; do \
218		case $$# in \
219			0) break;; \
220			[123]) echo "warn: empty MLINK: $$1 $$2 $$3"; break;; \
221		esac; \
222		name=$$1; shift; sect=$$1; shift; \
223		l=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \
224		name=$$1; shift; sect=$$1; shift; \
225		t=${DESTDIR}${CATDIR}$${sect}${MANSUBDIR}/$$name; \
226		${ECHO} $${t}${ZEXT} -\> $${l}${ZEXT}; \
227		rm -f $${t} $${t}${MCOMPRESS_EXT}; \
228		ln $${l}${ZEXT} $${t}${ZEXT}; \
229	done
230.endif
231.endif
232