xref: /netbsd/share/man/man5/mk.conf.5 (revision c4a72b64)
1.\"	$NetBSD: mk.conf.5,v 1.15 2002/08/27 14:46:23 lukem Exp $
2.\"
3.\"  Copyright (c) 1999-2002 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 August 28, 2002
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 MKDYNAMICROOT
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 MKDYNAMICROOT
99If
100.Sq no ,
101link programs in
102.Pa /bin
103and
104.Pa /sbin
105statically.
106Otherwise, link everything dynamically,
107and install shared libraries required by
108.Pa /bin
109and
110.Pa /sbin
111and the shared linker
112.Xr ld.elf_so 1
113into
114.Pa /lib .
115.It Sy MKINFO
116If
117.Sq no ,
118don't build or install the TeXinfo Info documentation.
119.It Sy MKLINT
120If
121.Sq no ,
122don't build or install the lint libraries.
123.It Sy MKMAN
124If
125.Sq no ,
126don't build or install the manual pages.
127Sets
128.Sy MKCATPAGES=no .
129.It Sy MKNLS
130If
131.Sq no ,
132don't build or install the NLS (Native Language Support) files.
133.It Sy MKOBJ
134If
135.Sq no ,
136don't create objdirs.
137.It Sy MKPIC
138If
139.Sq no ,
140don't build or install shared libraries.
141.It Sy MKPICINSTALL
142If
143.Sq no ,
144don't install the
145.Sq *_pic.a
146libraries.
147.It Sy MKPROFILE
148If
149.Sq no ,
150don't build or install the
151.Sq *_p.a
152profiling libraries.
153.It Sy MKSHARE
154If
155.Sq no ,
156set
157.Sy MKCATPAGES=no ,
158.Sy MKDOC=no ,
159.Sy MKINFO=no ,
160.Sy MKMAN=no ,
161.Sy MKNLS=no .
162.It Sy OBJMACHINE
163If defined, creates objdirs of the form
164.Pa obj.\*[Lt]arch\*[Gt] ,
165where
166.Sq \*[Lt]arch\*[Gt]
167is the current architecture (as per
168.Sq "uname -m" ) .
169.It Sy UPDATE
170If defined,
171.Sq "make install"
172only installs targets that are more recently modified in the source
173directories that their installed counterparts.
174.It Sy UNPRIVED
175If defined,
176.Sq "make install"
177will not attempt to set the ownership or permissions of the target
178file, and will instead attempt to log the information to
179.Pa ${DESTDIR}/METALOG .
180.El
181.Ss Pkgsrc system variables
182Please see
183.Xr packages 7
184for more variables used internally by the package system and
185.Pa ${PKGSRCDIR}/mk/bsd.pkg.defaults.mk
186for package-specific examples.
187.Sh FILES
188.Bl -tag -width /etc/mk.conf
189.It Pa /etc/mk.conf
190This file.
191.It Pa ${PKGSRCDIR}/mk/bsd.pkg.defaults.mk
192Examples for settings regarding the pkgsrc collection.
193.El
194.Sh SEE ALSO
195.Xr make 1 ,
196.Xr packages 7
197.Sh HISTORY
198The
199.Nm
200file appeared in
201.Nx 1.2 .
202