share/man/man7/build.7

   1 .\" Copyright (c) 2000
   2 .\"     Mike W. Meyer
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man7/build.7,v 1.19.2.1 2002/03/18 08:33:02 murray Exp $
  26 .\" $DragonFly: src/share/man/man7/build.7,v 1.3 2004/03/11 12:28:56 hmp Exp $
  27 .\"
  28 .Dd November 4, 2000
  29 .Dt BUILD 7
  30 .Os
  31 .Sh NAME
  32 .Nm build
  33 .Nd information on how to build the system
  34 .Sh DESCRIPTION
  35 The source for the
  36 .Dx
  37 system and applications are contained in three different directories,
  38 normally
  39 .Pa /usr/src ,
  40 .Pa /usr/doc ,
  41 and
  42 .Pa /usr/ports .
  43 .Pa /usr/src
  44 contains the
  45 .Dq "base system"
  46 sources, which is loosely defined as the things required to rebuild
  47 the system to a useful state.
  48 .Pa /usr/doc
  49 contains the source for the system documentation, excluding the manual
  50 pages.
  51 .Pa /usr/ports
  52 is a tree that provides a consistent interface for building and
  53 installing third party applications.
  54 .Pp
  55 The
  56 .Xr make 1
  57 command is used in each of these directories to build and install the
  58 things in that directory. Issuing the make command in any directory or
  59 subdirectory of those directories has the same effect as issuing the
  60 same command in all subdirectories of that directory. With no target
  61 specified, the things in that directory are just built. The following
  62 list provides the names and actions for other targets:
  63 .Bl -tag -width Ar
  64 .It Ar clean
  65 Removes any files created during the build process.
  66 .It Ar install
  67 Installs the results of the build for this directory.
  68 .It Ar update
  69 Gets updated sources as configured in
  70 .Pa /etc/make.conf .
  71 .El
  72 .Pp
  73 The other
  74 .Pa /usr/src
  75 make targets are:
  76 .Bl -tag -width Ar
  77 .It Ar buildworld
  78 Rebuild everything but the kernel, configure files in
  79 .Pa /etc ,
  80 and release.
  81 .It Ar installworld
  82 Install everything built by
  83 .Dq buildworld .
  84 .It Ar world
  85 buildworld + installworld.
  86 .It Ar buildkernel
  87 Rebuild the kernel and the kernel-modules.
  88 .It Ar installkernel
  89 Install the kernel and the kernel-modules.
  90 .It Ar reinstallkernel
  91 Reinstall the kernel and the kernel-modules.
  92 .It Ar upgrade
  93 Upgrade a.out (2.2.x/3.0) system to the new ELF way
  94 .It Ar most
  95 Build user commands, no libraries or include files.
  96 .It Ar installmost
  97 Install user commands, no libraries or include files.
  98 .It Ar aout-to-elf
  99 Upgrade an system from a.out to elf format.
 100 .It Ar aout-to-elf-build
 101 Build everything required to upgrade a system from a.out to elf format.
 102 .It Ar aout-to-elf-install
 103 Install everything built by aout-to-elf-build.
 104 .It Ar move-aout-libs
 105 Move the a.out libraries into an aout sub-directory of each elf
 106 library sub-directory.
 107 .El
 108 .Pp
 109 For more information about the ports build process, see
 110 .Xr ports 7 .
 111 .Sh ENVIRONMENT
 112 .Bl -tag -width ".Va TARGET_ARCH"
 113 .It Va TARGET_ARCH
 114 The target machine processor architecture.
 115 This is analogous to the
 116 .Dq "uname -p"
 117 output.
 118 Set this to cross-build for a different architecture.
 119 .It Va TARGET
 120 The target hardware platform.
 121 This is analogous to the
 122 .Dq "uname -m"
 123 output.
 124 This is necessary to cross-build some target architectures.
 125 For example, cross-building for PC98 machines requires
 126 .Va "TARGET_ARCH=i386"
 127 and
 128 .Va "TARGET=pc98" .
 129 .It Va NO_WERROR
 130 If defined, warnings will not cause the build to halt, even if the
 131 makefile says otherwise.
 132 .It Va DESTDIR
 133 The directory hierarchy where the resulting binaries will be
 134 installed.
 135 .El
 136 .Sh FILES
 137 .Bl -tag -width ".Pa /usr/share/examples/etc/make.conf" -compact
 138 .It Pa /etc/make.conf
 139 .It Pa /usr/doc/Makefile
 140 .It Pa /usr/doc/share/mk/doc.project.mk
 141 .It Pa /usr/ports/Mk/bsd.port.mk
 142 .It Pa /usr/ports/Mk/bsd.sites.mk
 143 .It Pa /usr/share/examples/etc//make.conf
 144 .It Pa /usr/src/Makefile
 145 .It Pa /usr/src/Makefile.inc1
 146 .El
 147 .Sh EXAMPLES
 148 The
 149 .Dq approved
 150 method of updating your system from the latest sources is:
 151 .Bd -literal -offset indent
 152 make buildworld
 153 make buildkernel KERNCONF=FOO
 154 make installkernel KERNCONF=FOO
 155 make installworld
 156 mergemaster
 157 .Ed
 158 .Pp
 159 .Dq FOO
 160 must be replaced with the name of the kernel configuration file from which
 161 the kernel should be built.
 162 Alternatively, the
 163 .Va KERNCONF
 164 variable in
 165 .Pa /etc/make.conf
 166 can be set to the name of the kernel to build;
 167 in this case the
 168 .Dq KERNCONF=FOO
 169 part of the
 170 .Dq buildkernel
 171 and
 172 .Dq installkernel
 173 commands can be omitted.
 174 .Pp
 175 After running these commands a system reboot is required,
 176 otherwise many programs which have been rebuilt
 177 (such as
 178 .Nm ps ,
 179 .Nm top ,
 180 etc)
 181 may not work with the old kernel which is still running.
 182 .Pp
 183 The following sequence of commands can be used to cross-build the
 184 system for the Alpha architecture on an i386 host:
 185 .Bd -literal -offset indent
 186 cd /usr/src
 187 make TARGET_ARCH=alpha buildworld
 188 make TARGET_ARCH=alpha DESTDIR=/clients/axp installworld
 189 .Ed
 190 .Sh SEE ALSO
 191 .Xr cc 1 ,
 192 .Xr install 1 ,
 193 .Xr make 1 ,
 194 .Xr make.conf 5 ,
 195 .Xr ports 7 ,
 196 .Xr release 7 ,
 197 .Xr mergemaster 8 ,
 198 .Xr reboot 8 ,
 199 .Xr shutdown 8
 200 .Sh AUTHORS
 201 .An Mike W. Meyer Aq mwm@mired.org .