Skip site navigation (1)Skip section navigation (2)
Date:      8 Nov 2000 01:26:36 -0000
From:      mwm@mired.org
To:        FreeBSD-gnats-submit@freebsd.org
Subject:   docs/22676: No man pages for Make.conf or /usr/src/sys/Makefile
Message-ID:  <20001108012636.9528.qmail@guru.mired.org>

next in thread | raw e-mail | index | archive | help

>Number:         22676
>Category:       docs
>Synopsis:       No man pages for Make.conf or /usr/src/sys/Makefile
>Confidential:   no
>Severity:       non-critical
>Priority:       high
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Nov 07 17:30:10 PST 2000
>Closed-Date:
>Last-Modified:
>Originator:     Mike Meyer
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
Meyer consulting
>Environment:
System: FreeBSD guru.mired.org 5.0-CURRENT FreeBSD 5.0-CURRENT #1: Sat Nov 4 19:39:06 CST 2000 root@:/usr/obj/sharetmp/src/sys/GURU i386

>Description:

In a fit (of some kind), I wrote man pages for make.conf and and
build. Jkh took a look, and said:

From: Jordan Hubbard <jkh@winston.osd.bsdi.com>
To: Mike Meyer <mwm@mired.org>
Subject: Re: make.conf man page? 
Date: Tue, 07 Nov 2000 13:59:32 -0800

Look good to me, submit 'em as PRs so somebody from the docs team can
commit them.  I'm too busy with 4.2 to even contemplate it at the
moment. :)


>How-To-Repeat:

Try "man make.conf" or "man build".

>Fix:

Commit the two man pages in the attached shar file.

# This is a shell archive.  Save it in a file, remove anything before
# this line, and then unpack it by entering "sh file".  Note, it may
# create directories; files and directories will be owned by you and
# have default permissions.
#
# This archive contains:
#
#	manpages
#	manpages/make.conf.5
#	manpages/build.7
#
echo c - manpages
mkdir -p manpages > /dev/null 2>&1
echo x - manpages/make.conf.5
sed 's/^X//' >manpages/make.conf.5 << 'END-of-manpages/make.conf.5'
X.\" Copyright (c) 2000
X.\"	Mike W. Meyer
X.\"
X.\" Redistribution and use in source and binary forms, with or without
X.\" modification, are permitted provided that the following conditions
X.\" are met:
X.\" 1. Redistributions of source code must retain the above copyright
X.\"    notice, this list of conditions and the following disclaimer.
X.\" 2. Redistributions in binary form must reproduce the above copyright
X.\"    notice, this list of conditions and the following disclaimer in the
X.\"    documentation and/or other materials provided with the distribution.
X.\"
X.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
X.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
X.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
X.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
X.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
X.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
X.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
X.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
X.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
X.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
X.\" SUCH DAMAGE.
X.\"
X.\" $FreeBSD:$
X.\"
X.Dd Nov 3, 2000
X.Dt MAKE.CONF 5
X.Os
X.Sh NAME
X.Nm make.conf
X.Nd system build information.
X.Sh DESCRIPTION
XThe file
X.Nm
Xcontains settings that control the compilation of the FreeBSD sources
Xand ported applications. The file 
X.Nm
Xis generally created by the system administrator when the values need
Xto be changed from their defaults.
X.Pp
XThe purpose of
X.Nm
Xis not to run commands or perform compilation actions
Xdirectly.  Instead, it is included by the
Xvarious makefiles in
X.Pa /usr/src,
X.Pa /usr/ports
Xand
X.Pa /usr/doc
Xwhich conditionalize their
Xinternal actions according to the settings found there.
X.Pp
XThe
X.Pa /etc/make.conf
Xfile is included from the the appropriate Makefile
Xwhich specifies the default settings for all the available options.
XOptions need only be specified in 
X.Pa /etc/make.conf
Xwhen the system administrator wishes to override these defaults.
X.Pp
XThe build procedures occur in four broad areas: the world, the kernel,
Xdocumentations and ports. Variables set in
X.Nm
Xmay be applicable during builds in one, two, or all four of these
Xareas. They may be specified for a particular build via the
X.Op -D
Xoption of
X.Xr make 1 .
X.Pp
XThe following lists provides a name and short description for each
Xvariable you can use during the indicated builds. The values of
Xvariables flagged as
Xbool
Xare ignored; the variable being
Xset at all (even to 
X.Li Dq FALSE
Xor
X.Li Dq NO )
Xcause it to
Xbe treated as if it were set.
X.Pp
XThe following list provides a name and short description for variables
Xthat are used for all builds, or are used by the
Xmakefiles for things other than builds.
X.Bl -tag -width Ar
X.It Ar CFLAGS
X(str) Controls the compiler setting when compiling C code.
XOptimization levels above
X.Op -O ( -O2 , ...)
Xare not supported. BDECFLAGS
Xis provided as a set of gcc settings suggested by Bruce Evans
Xfor developgin and testing changs. They can be used by:
X.Bd -literal -offset indent
XCXFLAGS+=${BDECFLAGS}
X.Ed
X.It Ar CVS_UPDATE
X(bool) Set this to use cvs to update your ports with
X.Cm "make update" .
X.It Ar CXXFLAGS
X(str) Controls the compiler settings when compiling C++ code.
XCXXFLAGS is initially set to the value of CFLAGS. If you want to
Xadd to the CXXFLAGS value, use 
X.Dq Li +=
Xinstead of
X.Dq Li = .
X.It Ar INSTALL
X(str) the default install command. To have commands compared before doing
Xthe install, use
X.Bd -literal -offset indent
XINSTALL="install -C"
X.Ed
X.It Ar LOCAL_DIRS
X(str) List any directories that should be entered when doing
Xmake's in
X.Pa /usr/src 
Xin this variable.
X.It Ar MTREE_FOLLOWS_SYMLINKS
X(str) Set this to
X.Dq Li -L
Xto cause mtree to follow symlinks.
X.It Ar NO_DOCUPDATE
X(bool) Set this to not update the doc tree during
X.Cm "make update" .
X.It Ar NO_PORTSUPDATE
X(bool) Set this to not update the ports tree during
X.Cm "make update" .
X.It Ar SUP_UPDATE
X(bool) Set this to use cvsup to update your ports with
X.Cm "make update" .
X.It Ar SUP
X(str) The location of the cvsup command for
X.Cm "make update" .
X.It Ar SUPFLAGS
X(str) The flag for the sup command when doing
X.Cm "make update" .
XThis defaults to 
X.Op "-g -L 2" .
X.It Ar SUPHOST
X(str) The hostname of the sup server to use when doing
X.Cm "make update" .
X.It Ar SUPFILE
X(str) The first supfile to use when doing a
X.Cm "make update" .
XThis defaults to
X.Pa /usr/share/examples/cvsup/standard-supfile .
X.It Ar SUPFILE1
X(str) The second supfile to use when doing a
X.Cm "make update" .
XThis defaults to
X.Pa /usr/share/examples/cvsup/secure-supfile .
X.It Ar SUPFILE2
X(str) The third supfile to use when doing a
X.Cm "make update" .
XThis defaults to
X.Pa /usr/share/examples/cvsup/secure-supfile .
X.It Ar PORTSSUPFILE
X(str) The ports supfile to use when doing a
X.Cm "make update" .
XThis defaults to
X.Pa /usr/share/examples/cvsup/ports-supfile .
X.It Ar DOCSUPFILE
X(str) The documentation supfile to use when doing a
X.Cm "make update" .
XThis defaults to
X.Pa /usr/share/examples/cvsup/doc-supfile .
X.El
X.Pp
XThe following list provides a name and short description for variables
Xthat are only used doing a kernel build:
X.Bl -tag -width Ar
X.It Ar BOOT_COMCONSOLE_PORT
X(str) The port address to use for the console if the boot blocks have
Xbeen configured to use a serial console instead of the keyboard/video card.
X.It Ar BOOT_COMCONSOLE_SPEED
X(int) The baud rate to use for the console if the boot blocks have
Xbeen configured to use a serial console instead of the keyboard/video card.
X.It Ar BOOTWAIT
X(int) Controls the amount of time the kernel waits for a console keypress
Xbefore booting the default kernel. The value is approximately
Xmilliseconds. Keypresses are accepted by the BIOS before booting from disk,
Xmaking it possible to give custom boot parameters even when this is
Xset to 0.
X.It Ar COPTFLAGS
X(str) Controls the compiler settings when building the
Xkernel. Optimization levels above
X.Op -O 
X.Op -O2 ,
X...) are not supported.
X.It Ar NO_KERNELCONFIG
X(bool) Set this to skip running
X.Xr config 8
Xduring
X.Cm "${MAKE} buildkernel" .
X.It Ar NO_KERNELDEPEND
X(bool) Set this to skip running 
X.Cm "${MAKE} depend"
Xduring
X.Cm "${MAKE} buildkernel" .
X.It Ar NO_MODULES
X(bool) Set to  not build modules with the kernel.
X.El
X.Pp
XThe following list provides a name and short description for variables
Xthat are used during the world build:
X.Bl -tag -width Ar
X.It Ar COMPAT1X
X(bool) Set to install the 
X.Fx
X1 compatibility libraries.
X.It Ar COMPAT20
X(bool) Set to install the
X.Fx 2.0
Xcompatibility libraries.
X.It Ar COMPAT21
X(bool) Set to install the
X.Fx 2.1
Xcompatibility libraries.
X.It Ar COMPAT22
X(bool) Set to install the
X.Fx 2.2
Xcompatibility libraries.
X.It Ar COMPAT3X
X(bool) Set to install the
X.Fx
X3 compatibility libraries.
X.It Ar ENABLE_SUIDPERL
X(bool) Set to enable the installation of an suid perl binary.
X.It Ar FETCH_CMD
X(str) Command to use to fetch files. Normally
X.Xr fetch 1 .
X.It Ar MAKE_IDEA
X(bool) Set to build the IDEA encryption code. This code is patented in
Xthe USA and many european countries. It is 
X.Em "YOUR RESPONSIBILITY"
Xto determine if you can legally use IDEA.
X.It Ar MAKE_KERBEROS4
X(bool) Set this to build KerberosIV (KTH eBones).
X.It Ar MAKE_KERBEROS5
X(bool) Set this to build Kerberos5 (KTH Heimdal).
X.Em WARNING!
XThis is still experimental code. If you need stable Kerberos5, use the
Xport(s).
X.It Ar MODULES_WITH_WORLD
X(bool) Set to build modules with the system instead of the kernel.
X.It Ar NO_CVS
X(bool) Set to not build CVS.
X.It Ar NO_BIND
X(bool) Set to  not build BIND.
X.It Ar NO_FORTRAN
X(bool) Set to  not build g77 and related libraries.
X.It Ar NO_LPR
X(bool) Set to  not build lpr and related programs.
X.It Ar NO_MAILWRAPPER
X(bool) Set to  not build the mailwrapper(8) MTA selector.
X.It Ar NO_MAKEDEV
X(bool) Set to avoid running MAKEDEV all on /dev during install.
X.It Ar NO_OBJC
X(bool) Set to  not build Objective C support.
X.It Ar NO_OPENSSH
X(bool) Set to  not build OpenSSH.
X.It Ar NO_OPENSSL
X(bool) Set to  not build OpenSSL (implies NO_OPENSSH).
X.It Ar NO_SENDMAIL
X(bool) Set to  not build sendmail and related programs.
X.It Ar NO_SHAREDOCS
X(bool) Set to  not build the 4.4BSD legacy docs.
X.It Ar NO_TCSH
X(bool) Set to  not build and install /bin/csh (which is tcsh).
X.It Ar NO_X
X(bool) Set to  not compile in XWindows support (e.g. doscmd).
X.It Ar NOCLEAN
X(bool) Set this to disable cleaning during
X.Cm "make buildworld" .
XThis should not be set unless you know what you are doing.
X.It Ar NOCLEANDIR
X(bool) Set this to run
X.Cm "${MAKE} clean"
Xinstead of
X.Cm "${MAKE} cleandir" .
X.It Ar NOCRYPT
X(bool) Set to not build any crypto code.
X.It Ar NODESCRYPTLINKS
X(bool) Set to not replace 
X.Pa libcrypt -> libscrypt
Xlinks.
X.It Ar NOGAMES
X(bool) Set to not build games.
X.It Ar NOINFO
X(bool) Set to not make or install info files.
X.It Ar NOLIBC_R
X(bool) Set to not build libc_r (re-entrant version of libc).
X.It Ar NOMANCOMPRESS
X(bool) Set to install man pages uncompressed.
X.It Ar NOPERL
X(bool) Set to avoid building perl.
X.It Ar NOPROFILE
X(bool) Set to avoid compiling profiled libraries.
X.It Ar NOSECURE
X(bool) set to not build crypto code in secure subdir.
X.It Ar NOSHARE
X(bool) Set to not build in the share subdir.
X.It Ar NOUUCP
X(bool) Set to not build uucp related programs.
X.It Ar PERL_THREADED
X(bool) Set to enable the building and installation of perl with thread
Xsupport.
X.It Ar PPP_NOSUID
X(bool) Set to disable the installation of ppp as an suid root program.
X.It Ar SENDMAIL_CFLAGS
X(str) Flags to pass to the compile command when building sendmail. The
Xsendmail flags can be used to provide SASL support with setting such as:
X.Bd -literal -offset indent
XSENDMAIL_CFLAGS=-I/usr/local/include -DSASL
XSENDMAIL_LDFLAGS=-L/usr/local/lib
XSENDMAIL_LDADD=-lsasl
X.Ed
X.It Ar SENDMAIL_LDFLAGS
X(str) Flags to pass to the ld command when building sendmail.
X.It Ar SENDMAIL_LDADD
X(str) Flags to add to the end of the ld command when building sendmail.
X.It Ar SENDMAIL_DPADD
X(str) This variable is undocumented.
X.El
X.Pp
XThe following list provides a name and short description for variables
Xthat are used when building documentation.
X.Bl -tag -width Ar
X.It Ar DISTDIR
X(str) Where distfiles are kept. Normally, this is
X.Pa distfiles
Xin
X.Ev PORTSDIR .
X.It Ar DOC_LANG
X(str) The list of languages and encodings to build and install.
X.It Ar PRINTERDEVICE
X(str) The default format for system documentation, depends on your
Xprinter. This can be set to 
X.Dq Li ascii
Xfor simple printers or
X.Dq Li ps
Xfor postscript or graphics printers with a ghostscript
Xfilter.
X.El
X.Pp
XThe following list provides a name and short description for variables
Xthat are used when building ports:
X.Bl -tag -width Ar
X.It Ar FORCE_PKG_RESIDENT
X(bool) Set this to override any existing package registration.
X.It Ar HAVE_MOTIF
X(bool) Set this if you have Motif on your system.
X.It Ar KRB5_HOME
X(str) Set this if you want to install the MIT Kerberos5 port somewhere
Xother than
X.Pa /usr/local .
X.It Ar LOCALBASE
X(str) Set this to the base directory that non-X ports should be
Xinstalled in. It provides the default for PREFIX when building in
X.Pa /usr/ports .
X.It Ar MASTER_SITE_AFTERSTEP
X(str) Set this to change the master site for AfterStep ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_BACKUP
X(str) Controls the site location that ports check for distfiles if the
Xlocations listed in their 
X.Pa Makefile
Xdo not work. The last part of the path must be
X.Dq Li /${DIST_SUBDIR}/ .
X.It Ar MASTER_SITE_COMP_SOURCES
X(str) Controls the master site location for comp.sources ports. The
Xlast part of the path must be
X.Dq Li %SUBDIR%/
X.It Ar MASTER_SITE_GNOME
X(str) Controls the master site location for GNOME ports. The
Xlast part of the path must be
X.Dq Li /%SUBDIR%/
X.It Ar MASTER_SITE_GNU
X(str) Controls the master site location for GNU ports. The
Xlast part of the path must be
X.Dq Li /%SUBDIR%/
X.It Ar MASTER_SITE_KDE
X(str) Controls the master site location for KDE ports. The
Xlast part of the path must be
X.Dq Li /%SUBDIR%/
X.It Ar MASTER_SITE_FREEBSD
X(bool) If set, go to the master
X.Fx
Xsite for all files.
X.It Ar MASTER_SITE_MOZILLA
X(str) Controls the master site location for Mozilla ports. The
Xlast part of the path must be
X.Dq Li /%SUBDIR%/
X.It Ar MASTER_SITE_OVERRIDE
X(str) If set, this site is checked before the sites listed in the ports
X.Pa Makefile .
XYou can have it check the backup site first by like so:
X.Bd -literal -offset indent
XMASTER_SITE_OVERRIDE?=	${MASTER_SITE_BACKUP}
X.Ed
X.It Ar MASTER_SITE_PERL_CPAN
X(str) Controls the master site location for Perl ports. The
Xlast part of the path must be
X.Bd -literal -offset indent
X/%SUBDIR%/
X.Ed
X.It Ar MASTER_SORT_REGEX
X(str) Set this to control the sort order for mirror sets. To set it to
Xprefer mirrors in the .jp domain, use:
X.Bd -literal -offset indent
XMASTER_SORT_REGEX?=	^file: ^ftp://ftp\.FreeBSD\.org/pub/FreeBSD/ports/local-distfiles/ ://[^/]*\.jp/ ://[^/]*\.jp\.
X.Ed
XUsers of other ccTLD domins should change the 
X.Dq Li jp
Xto the
Xappropriate domain.
X.It Ar MASTER_SITE_RINGSERVER
X(str) Controls the master site location for Ringserver ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_RUBY
X(str) Controls the master site location for Ruby ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_SUNSITE
X(str) Controls the master site location for Sunsite ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_TCLTK
X(str) Controls the master site location for Tcl and Tk ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_TEX_CTAN
X(str) Controls the master site location for TeX ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_WINDOWMAKER
X(str) Controls the master site location for WindowMaker ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_XCONTRIB
X(str) Controls the master site location for contributed X ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_XEMACS
X(str) Controls the master site location for Xemacs ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MASTER_SITE_XFREE
X(str) Controls the master site location for XFree ports. The last
Xpart of the path must be
X.Dq Li /%SUBDIR%/ .
X.It Ar MOTIFLIB
X(str) Location of
X.Pa libXm.a
Xand
X.Pa libXm.so .
X.It Ar MOTIF_STATIC
X(bool) Set this if you want ports that use Motif to be built so they
Xcan be run on systems without the Motif shared libraries.
X.It Ar NOCLEANDEPENDS
X(bool) Set this to prevent 
X.Cm "make clean"
Xfrom cleaning the ports that the one being cleaned depends on.
X.It Ar NOPORTDOCS
X(bool) Set this to disable installing additional documentation with ports.
X.It Ar PACKAGES
X(str) Used only for the package target; the directory for the package tree.
X.It Ar PATCH_SITES
X(str) Primary location(s) for the distribution of patch files.
X.It Ar PORTSDIR
X(str) The location of the ports tree.
X.It Ar USA_RESIDENT
X(bool) Set this if you are a resident of the USA so that ports that
Xneed to can attemp to comply with U.S. export regulations.
X.It Ar WRKDIRPREFIX
X(str) Where to create temporary files used when building ports.
X.It Ar X11BASE
X(str) Should be set to where the X11 distribution has been
Xinstalled if it is installed anywhere other than /usr/X11R6.
X.Sh FILES
X.Bl -tag -width /etc/defaults/make.conf -compact
X.It Pa /etc/defaults/make.conf
X.It Pa /etc/make.conf
X.It Pa /usr/doc/Makefile
X.It Pa /usr/src/Makefile
X.It Pa /usr/src/Makefile.inc1
X.It Pa /usr/ports/Mk/bsd.port.mk
X.It Pa /usr/ports/Mk/bsd.sites.mk
X.Sh SEE ALSO
X.Xr gcc 1 ,
X.Xr install 1 ,
X.Xr lpd 8 ,
X.Xr make 1 ,
X.Xr make 7 ,
X.Xr ports 7 ,
X.Xr sendmail 8
X.Sh HISTORY
XThe
X.Nm
Xfile appeared sometime before
X.Fx 4.0 .
X.Sh AUTHORS
X.An Mike W. Meyer Aq mwm@mired.org .
END-of-manpages/make.conf.5
echo x - manpages/build.7
sed 's/^X//' >manpages/build.7 << 'END-of-manpages/build.7'
X.\" Copyright (c) 2000
X.\"	Mike W. Meyer
X.\"
X.\" Redistribution and use in source and binary forms, with or without
X.\" modification, are permitted provided that the following conditions
X.\" are met:
X.\" 1. Redistributions of source code must retain the above copyright
X.\"    notice, this list of conditions and the following disclaimer.
X.\" 2. Redistributions in binary form must reproduce the above copyright
X.\"    notice, this list of conditions and the following disclaimer in the
X.\"    documentation and/or other materials provided with the distribution.
X.\"
X.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
X.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
X.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
X.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
X.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
X.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
X.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
X.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
X.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
X.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
X.\" SUCH DAMAGE.
X.\"
X.\" $FreeBSD:$
X.\"
X.Dd Nov 4, 2000
X.Dt BUILD 7
X.Os
X.Sh NAME
X.Nm build
X.Nd information on how to build the system.
X.Sh DESCRIPTION
XThe source for the
X.Os FreeBSD
Xsystem and applications are contained in three different directories,
Xnormally
X.Pa /usr/src ,
X.Pa /usr/doc ,
Xand
X.Pa /usr/ports .
X.Pa /usr/src
Xcontains the
X.Dq "base system"
Xsources, which is loosely defined as the things required to rebuild
Xthe system to a useful state.
X.Pa /usr/doc
Xcontains the source for the system documentation, excluding the manual
Xpages.
X.Pa /usr/ports
Xis a tree that provides a consistent interface for building and
Xinstalling third party applications.
X.Pp
XThe
X.Xr make 1
Xcommand is used in each of these directories to build and install the
Xthings in that directory. Issuing the make command in any directory or
Xsubdirectory of those directories has the same effect as issuing the
Xsame command in all subdirectories of that directory. With no target
Xspecified, the things in that directory are just built. The following
Xlist provides the names and actions for other targets:
X.Bl -tag -width Ar
X.It Ar clean
XRemoves any files created during the build process.
X.It Ar install
XInstalls the results of the build for this directory.
X.It Ar update
XGets updated sources as configured in
X.Pa /etc/make.conf .
X.El
X.Pp
XThe other
X.Pa /usr/src
Xmake targets are:
X.Bl -tag -width Ar
X.It Ar buildworld
XRebuild everything but the kernel, configure files in
X.Pa /etc ,
Xand release.
X.It Ar installworld
XInstall everything built by
X.Dq buildworld .
X.It Ar world
Xbuildworld + installworld.
X.It Ar buildkernel
XRebuild the kernel and the kernel-modules.
X.It Ar installkernel
XInstall the kernel and the kernel-modules.
X.It Ar reinstallkernel
XReinstall the kernel and the kernel-modules.
X.It Ar upgrade 
XUpgrade a.out (2.2.x/3.0) system to the new ELF way
X.It Ar most
XBuild user commands, no libraries or include files.
X.It Ar installmost
XInstall user commands, no libraries or include files.
X.It Ar aout-to-elf
XUpgrade an system from a.out to elf format.
X.It Ar aout-to-elf-build
XBuild everything required to upgrade a system from a.out to elf format.
X.It Ar aout-to-elf-install
XInstall everything built by aout-to-elf-build.
X.It Ar move-aout-libs
XMove the a.out libraries into an aout sub-directory of each elf
Xlibrary sub-directory.
X.El
X.Pp
XFor more information about the ports build process, see
X.Xr ports 7 .
X.Sh FILES
X.Bl -tag -width /etc/defaults/make.conf -compact
X.It Pa /etc/defaults/make.conf
X.It Pa /etc/make.conf
X.It Pa /usr/doc/Makefile
X.It Pa /usr/doc/share/mk/doc.project.mk
X.It Pa /usr/src/Makefile
X.It Pa /usr/src/Makefile.inc1
X.It Pa /usr/ports/Mk/bsd.port.mk
X.It Pa /usr/ports/Mk/bsd.sites.mk
X.Sh SEE ALSO
X.Xr gcc 1 ,
X.Xr install 1 ,
X.Xr make 1 ,
X.Xr make.conf 5 ,
X.Xr ports 7
X.Sh AUTHORS
X.An Mike W. Meyer Aq mwm@mired.org .
END-of-manpages/build.7
exit


>Release-Note:
>Audit-Trail:
>Unformatted:


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20001108012636.9528.qmail>