xref: /openbsd-src/share/man/man5/mk.conf.5 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: mk.conf.5,v 1.32 2016/07/04 18:01:44 guenther Exp $
2.\"
3.\" Copyright (c) 2003 Jason McIntyre
4.\"
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd $Mdocdate: July 4 2016 $
28.Dt MK.CONF 5
29.Os
30.Sh NAME
31.Nm mk.conf
32.Nd system-specific configuration parameters
33.Sh SYNOPSIS
34.Fd .include <bsd.own.mk>
35.Sh DESCRIPTION
36To get system-specific configuration parameters,
37.In bsd.own.mk
38will try to include the file specified by the
39.Ev MAKECONF
40variable.
41If
42.Ev MAKECONF
43is not set, or no such file exists, the system make configuration file
44.Pa /etc/mk.conf
45is included, if it exists.
46By default, this file does not exist,
47and must be created from scratch.
48For more information on how the make process works,
49and details of the format of make files,
50see
51.Xr make 1 .
52.Pp
53.In bsd.own.mk
54is generally useful when building Makefiles, so that
55they use the same default owners, etc. as the rest of the tree.
56These files may define any of the variables described below.
57Additionally, see
58.Xr bsd.port.mk 5
59for a list of variables that can be set by the
60.Xr ports 7
61subsystem.
62.Sh VARIABLES
63The following variables are set by
64.In bsd.own.mk ,
65if they are not already defined.
66Defaults are in brackets.
67.Bl -tag -width INSTALL_STRIP
68.It Ev BINGRP
69Binary group.
70.Bq bin
71.It Ev BINMODE
72Binary mode.
73.Bq 555
74.It Ev BINOWN
75Binary owner.
76.Bq root
77.It Ev BSDOBJDIR
78The real path to the system 'obj' tree, so that 'make obj' will work correctly.
79.Bq Pa /usr/obj
80.It Ev BSDSRCDIR
81The real path to the system sources, so that 'make obj' will work correctly.
82.Bq Pa /usr/src
83.It Ev DIRMODE
84Mode for new directories.
85.Bq 755
86.It Ev DOCDIR
87Base path for system documentation installation.
88.Bq Pa /usr/share/doc
89.It Ev DOCGRP
90Documentation group.
91.Bq bin
92.It Ev DOCMODE
93Documentation mode.
94.Bq Ev ${NONBINMODE}
95.It Ev DOCOWN
96Documentation owner.
97.Bq root
98.It Ev INSTALL_COPY
99The old usage of this flag is obsolescent, since
100.Xr install 1
101now copies by default.
102However, it can also be used to specify that a file not be copied unless it
103is different (via the
104.Fl p
105option).
106See
107.Xr install 1
108for details.
109This is to be used when building an install script so that the entire
110system can either be installed with copies, or copy-if-different using a
111single knob.
112.Bq Fl c
113.It Ev INSTALL_STRIP
114The flag passed to the install program to cause the binary to be stripped.
115This is to be used when building an install script so that the entire
116system can be made stripped/not-stripped using a single knob.
117Note that
118.Ev INSTALL_STRIP
119is not set if
120.Ev ${DEBUG}
121is defined.
122.Bq Fl s
123.It Ev LIBDIR
124Base path for library installation.
125.Bq Pa /usr/lib
126.It Ev LIBGRP
127Library group.
128.Bq Ev ${BINGRP}
129.It Ev LIBMODE
130Library mode.
131.Bq Ev ${NONBINMODE}
132.It Ev LIBOWN
133Library owner.
134.Bq Ev ${BINOWN}
135.It Ev MANDIR
136Base path for manual installation.
137.Bq Pa /usr/share/man/man
138.It Ev MANGRP
139Manual group.
140.Bq bin
141.It Ev MANMODE
142Manual mode.
143.Bq Ev ${NONBINMODE}
144.It Ev MANOWN
145Manual owner.
146.Bq root
147.It Ev NONBINMODE
148Mode for non-executable files.
149.Bq 444
150.It Ev XOBJDIR
151The real path to the 'obj' tree for building the X Window System.
152.Bq Pa /usr/xobj
153.It Ev XSRCDIR
154The real path to the X Window System sources.
155.Bq Pa /usr/xenocara
156.El
157.Sh ADDITIONAL VARIABLES
158Additionally, the following variables may be set by
159.In bsd.own.mk
160or in a make configuration file to modify the behaviour of the system build
161process (default values are in brackets along with comments, if set by
162.In bsd.own.mk ) :
163.Bl -tag -width GLOBAL_AUTOCONF_CACHE
164.It Ev DEBUG
165Add
166.Fl g
167to assembly, C compiler and linking passes.
168Also doesn't set
169.Ev INSTALL_STRIP
170to
171.Fl s
172per default if defined.
173.It Ev GLOBAL_AUTOCONF_CACHE
174Set to the name of a file that all cached GNU autoconf test results will be
175saved in.
176Reduces redundant tests.
177Be careful!
178Redundant tests may not be redundant when installing substantially
179updated GNU programs.
180.Bq yes
181.It Ev NOPIC
182Do not build shared libraries.
183.It Ev NOPIE
184Do not build PIE objects or executables.
185.It Ev NOPROFILE
186Do not build profiled versions of system libraries.
187.It Ev PIPE
188If set to
189.Qq -pipe ,
190.Xr gcc 1
191will be given the
192.Fl pipe
193option which can speed up compiles on machines with memory to spare.
194Instead of using temp files,
195.Xr gcc 1
196uses pipes for the temporary data.
197.It Ev SKEY
198Compile in support for S/key authentication.
199.Bq yes; set unconditionally
200.It Ev SKIPDIR
201A space separated list of directories,
202relative to
203.Ev BSDSRCDIR ,
204to be skipped during "make build".
205.It Ev SUDO
206Command run by
207.Xr make 1
208when doing certain operations requiring root privileges
209(e.g. the "make install" portion of "make build").
210If set to
211.Ev /usr/bin/doas ,
212this allows one to run "make build" as a user other than root
213(assuming doas is set up for that user).
214.It Ev SYS_INCLUDE
215Copy or symlink kernel include files into
216.Pa /usr/include .
217Possible values are "symlinks" or "copies"
218(which is the same as the variable being unset).
219.It Ev WARNINGS
220Adds appropriate warning flags (defined in
221.Ev CDIAGFLAGS ,
222e.g.\&
223.Fl Wall . . . )
224to compiles.
225.Bq no
226.It Ev XENOCARA_BUILD_DRI
227Build X with Direct Rendering Infrastructure (DRI) support,
228providing some hardware acceleration.
229This is on by default for amd64/i386 architectures.
230.It Ev XENOCARA_RERUN_AUTOCONF
231Forces X builds to re-run automake and autoconf in each module before
232configuring them.
233This option requires that the automake, autoconf and libtool
234packages are installed.
235.Bq no
236.El
237.Sh FILES
238.Bl -tag -width XXXXXXXXXXXXXXX -compact
239.It Pa /etc/mk.conf
240System make configuration file.
241.It Pa /usr/share/mk/*
242System include make files.
243.El
244.Sh SEE ALSO
245.Xr make 1 ,
246.Xr bsd.port.mk 5 ,
247.Xr ports 7
248.Sh HISTORY
249The
250.Nm
251manual page first appeared in
252.Ox 3.4 .
253