xref: /netbsd/share/man/man5/mk.conf.5 (revision bf9ec67e)
1.\"	$NetBSD: mk.conf.5,v 1.13 2002/05/03 08:58:46 lukem Exp $
2.\"
3.\"  Copyright (c) 1999 The NetBSD Foundation, Inc.
4.\"  All rights reserved.
5.\"
6.\"  This code is derived from software contributed to The NetBSD Foundation
7.\"  by Luke Mewburn.
8.\"
9.\"  Redistribution and use in source and binary forms, with or without
10.\"  modification, are permitted provided that the following conditions
11.\"  are met:
12.\"  1. Redistributions of source code must retain the above copyright
13.\"     notice, this list of conditions and the following disclaimer.
14.\"  2. Redistributions in binary form must reproduce the above copyright
15.\"     notice, this list of conditions and the following disclaimer in the
16.\"     documentation and/or other materials provided with the distribution.
17.\"  3. All advertising materials mentioning features or use of this software
18.\"     must display the following acknowledgement:
19.\"  	This product includes software developed by Luke Mewburn.
20.\"  4. The name of the author may not be used to endorse or promote products
21.\"     derived from this software without specific prior written permission.
22.\"
23.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24.\"  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25.\"  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26.\"  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27.\"  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28.\"  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
29.\"  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30.\"  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
31.\"  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
32.\"  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33.\"
34.Dd April 27, 2001
35.Dt MK.CONF 5
36.Os
37.\" turn off hyphenation
38.hym 999
39.Sh NAME
40.Nm mk.conf
41.Nd make configuration file
42.Sh DESCRIPTION
43The
44.Nm
45file overrides various parameters used during the build of the system.
46.Pp
47Listed below are the
48.Nm
49variables that may be set, the values to which each may be set,
50a brief description of what each variable does, and a reference to
51relevant manual pages.
52.Ss NetBSD System variables
53.Bl -tag -width NETBSDSRCDIR
54.It Sy NETBSDSRCDIR
55The path to the top level of the NetBSD sources.
56If
57.Xr make 1
58is run from within the NetBSD source tree, the default is the top
59level of that tree (as determined by the presence of
60.Pa build.sh
61and
62.Pa tools/ ) ,
63otherwise
64.Sy BSDSRCDIR
65will be used.
66.It Sy BSDOBJDIR
67The real path to the
68.Sq obj
69tree for the NetBSD source tree.
70Default:
71.Pa /usr/obj .
72.It Sy BSDSRCDIR
73The real path to the NetBSD source tree.
74Default:
75.Pa /usr/src .
76.It Sy BUILD
77If defined,
78.Sq "make install"
79checks that the targets in the source directories are up-to-date and
80re-makes them if they are out of date, instead of blindly trying to install
81out of date or non-existent targets.
82.It Sy COPTS
83Extra options for the C compiler.
84Should be appended to (e.g.,
85.Sy COPTS+=-g ) ,
86rather than explicitly set.
87.It Sy MANZ
88Install manual pages compressed with
89.Xr gzip 1 .
90.It Sy MKCATPAGES
91If
92.Sq no ,
93don't build or install the formatted manual pages.
94.It Sy MKDOC
95If
96.Sq no ,
97don't build or install the miscellaneous documentation.
98.It Sy MKINFO
99If
100.Sq no ,
101don't build or install the TeXinfo Info documentation.
102.It Sy MKLINT
103If
104.Sq no ,
105don't build or install the lint libraries.
106.It Sy MKMAN
107If
108.Sq no ,
109don't build or install the manual pages.
110Sets
111.Sy MKCATPAGES=no .
112.It Sy MKNLS
113If
114.Sq no ,
115don't build or install the NLS (Native Language Support) files.
116.It Sy MKOBJ
117If
118.Sq no ,
119don't create objdirs.
120.It Sy MKPIC
121If
122.Sq no ,
123don't build or install shared libraries.
124.It Sy MKPICINSTALL
125If
126.Sq no ,
127don't install the
128.Sq *_pic.a
129libraries.
130.It Sy MKPROFILE
131If
132.Sq no ,
133don't build or install the
134.Sq *_p.a
135profiling libraries.
136.It Sy MKSHARE
137If
138.Sq no ,
139set
140.Sy MKCATPAGES=no ,
141.Sy MKDOC=no ,
142.Sy MKINFO=no ,
143.Sy MKMAN=no ,
144.Sy MKNLS=no .
145.It Sy OBJMACHINE
146If defined, creates objdirs of the form
147.Pa obj.\*[Lt]arch\*[Gt] ,
148where
149.Sq \*[Lt]arch\*[Gt]
150is the current architecture (as per
151.Sq "uname -m" ) .
152.It Sy UPDATE
153If defined,
154.Sq "make install"
155only installs targets that are more recently modified in the source
156directories that their installed counterparts.
157.It Sy UNPRIVED
158If defined,
159.Sq "make install"
160will not attempt to set the ownership or permissions of the target
161file, and will instead attempt to log the information to
162.Pa ${DESTDIR}/METALOG .
163.El
164.Ss Pkgsrc system variables
165Please see
166.Xr packages 7
167for more variables used internally by the package system and
168.Pa /usr/pkgsrc/mk/bsd.pkg.defaults.mk
169for package-specific examples.
170.Sh FILES
171.Bl -tag -width /etc/mk.conf
172.It Pa /etc/mk.conf
173This file.
174.It Pa /usr/pkgsrc/mk/bsd.pkg.defaults.mk
175Examples for settings regarding the pkgsrc collection.
176.El
177.Sh SEE ALSO
178.Xr make 1 ,
179.Xr packages 7
180.Sh HISTORY
181The
182.Nm
183file appeared in
184.Nx 1.2 .
185