xref: /netbsd-src/share/man/man5/mk.conf.5 (revision 220b5c059a84c51ea44107ea8951a57ffaecdc8c)
1.\"	$NetBSD: mk.conf.5,v 1.10 2001/11/27 16:17:35 wiz 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 November 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 OBJMACHINE
54.It Sy BSDOBJDIR
55The real path to the system
56.Sq obj
57tree, so that
58.Sq "make obj"
59will work correctly.
60Default:
61.Pa /usr/obj .
62.It Sy BSDSRCDIR
63The real path to the system sources, so that
64.Sq "make obj"
65will work correctly.
66Default:
67.Pa /usr/src .
68.It Sy BUILD
69If defined,
70.Sq "make install"
71checks that the targets in the source directories are up-to-date and
72re-makes them if they are out of date, instead of blindly trying to install
73out of date or non-existent targets.
74.It Sy COPTS
75Extra options for the C compiler.
76Should be appended to (e.g.,
77.Sy COPTS+=-g ) ,
78rather than explicitly set.
79.It Sy MANZ
80Install manual pages compressed with
81.Xr gzip 1 .
82.It Sy MKCATPAGES
83If
84.Sq no ,
85don't build or install the formatted manual pages.
86.It Sy MKDOC
87If
88.Sq no ,
89don't build or install the miscellaneous documentation.
90.It Sy MKINFO
91If
92.Sq no ,
93don't build or install the TeXinfo Info documentation.
94.It Sy MKLINT
95If
96.Sq no ,
97don't build or install the lint libraries.
98.It Sy MKMAN
99If
100.Sq no ,
101don't build or install the manual pages.
102Sets
103.Sy MKCATPAGES=no .
104.It Sy MKNLS
105If
106.Sq no ,
107don't build or install the NLS (Native Language Support) files.
108.It Sy MKOBJ
109If
110.Sq no ,
111don't create objdirs.
112.It Sy MKPIC
113If
114.Sq no ,
115don't build or install shared libraries.
116.It Sy MKPICINSTALL
117If
118.Sq no ,
119don't install the
120.Sq *_pic.a
121libraries.
122.It Sy MKPROFILE
123If
124.Sq no ,
125don't build or install the
126.Sq *_p.a
127profiling libraries.
128.It Sy MKSHARE
129If
130.Sq no ,
131set
132.Sy MKCATPAGES=no ,
133.Sy MKDOC=no ,
134.Sy MKINFO=no ,
135.Sy MKMAN=no ,
136.Sy MKNLS=no .
137.It Sy OBJMACHINE
138If defined, creates objdirs of the form
139.Pa obj.<arch> ,
140where
141.Sq <arch>
142is the current architecture (as per
143.Sq "uname -m" ) .
144.It Sy UPDATE
145If defined,
146.Sq "make install"
147only installs targets that are more recently modified in the source
148directories that their installed counterparts.
149.El
150.Ss Pkgsrc system variables
151Please see
152.Xr packages 7
153for more variables used internally by the package system and
154.Pa /usr/pkgsrc/mk/bsd.pkg.defaults.mk
155for package-specific examples.
156.Sh FILES
157.Bl -tag -width /etc/mk.conf
158.It Pa /etc/mk.conf
159This file.
160.It Pa /usr/pkgsrc/mk/bsd.pkg.defaults.mk
161Examples for settings regarding the pkgsrc collection.
162.El
163.Sh SEE ALSO
164.Xr make 1 ,
165.Xr packages 7
166.Sh HISTORY
167The
168.Nm
169file appeared in
170.Nx 1.2 .
171