.\"	$NetBSD: contents,v 1.16.2.2 2019/11/25 05:50:18 msaitoh Exp $
.\"
.\" Copyright (c) 1999-2016 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.
.Ss2 NetBSD/\*M subdirectory structure
The \*M-specific portion of the
.Nx
\*V release is found in the
.Pa \*M
subdirectory of the distribution:
.Pa \&.../NetBSD-\*V/\*M/ .
It contains the following files and directories:
.Pp
.(tag INSTALL.html -compact \" top level
.	It Pa INSTALL.html
.	It Pa INSTALL.ps
.	It Pa INSTALL.txt
.	It Pa INSTALL.more
Installation notes in various file formats, including this file.
The
.Pa \&.more
file contains underlined text using the
.Xr more 1
conventions for indicating italic and bold display.
.
.\" MD binary and installation directories ---------------------------
.
.	It Pa binary/
.
.	(tag kernel/ -compact \" binary/
.
.		It Pa kernel/
.
.		(tag netbsd.gz -compact \" binary/kernel
.
.			It Pa netbsd-GENERIC.gz
A gzipped
.Nx
kernel containing code for everything supported in this release.
.
.			It Pa netbsd-GENERIC_601.gz
A gzipped
.Nx
kernel containing code for PowerPC 601 machines.
.
.			It Pa netbsd-GENERIC.MP.gz
.
A gzipped
.Nx
kernel containing code for everything supported in this release.  This
kernel supports SMP on systems with more than one CPU.
.
.			It Pa netbsd-GENERIC_MD.gz
.
A gzipped
.Nx
kernel containing code for everything supported in this release.
It also has a RAM-disk installer.
This is the kernel you should use when you want to install via
netboot, from a CD-R, or an HFS partition on Open Firmware 3 systems.
.
.			It Pa netbsd-INSTALL.gz
.
A gzipped
.Nx
kernel containing code only for Open Firmware 1.0.5, 1.1.22, 2.0.x,
and 2.4 systems (i.e. those that have floppy drives).
It has a RAM-disk installer.
.
.			It Pa netbsd-INSTALL_601.gz
.
A gzipped
.Nx
kernel containing code only for PowerPC 601 machines, Open Firmware
1.0.5, 1.1.22, 2.0.x, and 2.4 systems (i.e. those that have floppy drives).
It has a RAM-disk installer.
.
.			It Pa netbsd-POWERMAC_G5.gz
.
A gzipped
.Nx
kernel containing code only for uniprocessor PowerPC 970FX and 970MP machines.
It is intended for netbooting, uncompressed, via TFTP.
.
.			It Pa netbsd-POWERMAC_G5.MP.gz
.
A gzipped
.Nx
kernel containing code only for multi-processor PowerPC 970FX and 970MP
machines.
It is intended for netbooting, uncompressed, via TFTP.
.
.
.		tag) \" binary/kernel/
.
.		It Pa sets/
.
\*M binary distribution sets;
see below.
.
.	tag) \" binary/
.
.	It Pa installation/
.
.	(tag miniroot/ -compact \" installation/
.
.		It Pa floppy/boot1.fs
.		It Pa floppy/boot2.fs
.
\*M boot and installation floppy images.  The first is the bootloader and
kernel.  The second image has the installation tools.
Only usable on models that ship with a floppy drive (pre-Open Firmware 3);
see below.
.
.
.		It Pa floppy/boot601_1.fs
.		It Pa floppy/boot601_2.fs
.
Same as boot1.fs, boot2.fs, except for PowerPC 601 machines only.
.
.
.		It Pa ofwboot.xcf
.
\*M bootloader; see below.
.
.	tag) \" installation/
.
.tag) \" top level
.
.\" ------------------------------------------------------------------
.
.
.Ss2 Binary distribution sets
.\"
.\" ------------------------------------------------------------------
.\" XXX: most sets except kern and xserver should be in notes/common
.\"
The
.Nx
\*M
binary distribution sets contain the binaries which
comprise the
.Nx
\*V release for \*M.
The binary distribution sets can be found in the
.Pa \*M/binary/sets
subdirectory
of the
.Nx
\*V
distribution tree, and are as follows:
.(tag xserver \" sets
.
.It Sy base
The
.Nx
\*V
\*M
.Sy base
binary distribution.
You
.Em must
install this distribution set.
It contains the base
.Nx
utilities that are necessary for the
system to run and be minimally functional.
.
.It Sy comp
Things needed for compiling programs.
This set includes the system include files
.Pq Pa /usr/include
and the various system libraries (except the shared
libraries, which are included as part of the
.Sy base
set).
This set also includes the manual pages for
all of the utilities it contains, as well as the
system call and library manual pages.
.
.It Sy debug
This distribution set contains debug information for
all base system utilities.
It is useful when reporting issues with binaries or during
developement.
This set is huge, if the target disk is small, do not install it.
.
.It Sy etc
This distribution set contains the system
configuration files that reside in
.Pa /etc
and in several other places.
This set
.Em must
be installed if you are installing the system from scratch, but should
.Em not
be used if you are upgrading.
.
.It Sy games
This set includes the games and their manual pages.
.
.\" MD kernel set(s) -------------------------------------------------
.
.It Sy kern-GENERIC
This set contains a
.Nx*M
\*V
.Li GENERIC
kernel named
.Pa /netbsd .
You
.Em must
install this distribution set unless you have a PowerPC 601 machine.
.It Sy kern-GENERIC_601
This set contains a
.Nx*M
\*V
.Li GENERIC_601
kernel named
.Pa /netbsd .
You
.Em must
install this distribution set if you have a PowerPC 601 machine.
.It Sy kern-GENERIC.MP
This set contains a
.Nx*M
\*V
.Li GENERIC.MP
kernel, which will use multiple processors (if present), named
.Pa /netbsd .
.
.\" ------------------------------------------------------------------
.
.It Sy man
This set includes all of the manual pages for the
binaries and other software contained in the
.Sy base
set.
Note that it does not include any of the manual pages
that are included in the other sets.
.
.It Sy misc
This set includes the system dictionaries,
the typesettable document set, and other files from
.Pa /usr/share .
.
.It Sy modules
This set includes kernel modules to add functionality to a running system.
.
.It Sy rescue
This set includes the statically linked emergency recover binaries installed
in
.Pa /rescue .
.
.It Sy text
This set includes
.Nx Ns 's
text processing tools, including
.Xr groff 1 ,
all related programs, and their manual pages.
.
.tag) \" sets
.
.
.\" X sets -----------------------------------------------------------
.\" XXX: XOrg vs XFree
.\" XXX: ports without xserver
.Pp
.Nx
maintains its own set of sources for the X Window System in order to
assure tight integration and compatibility.
These sources are based on
X.Org.
Binary sets for the X Window System are distributed with
.Nx .
The sets are:
.(tag xserver \" x sets
.
.It Sy xbase
The basic files needed for a complete X
client environment.
This does not include the X servers.
.
.It Sy xcomp
The extra libraries and include files needed to compile X source code.
.
.It Sy xdebug
This distribution set contains debug information for
all X11 binaries.
It is useful when reporting issues with these binaries or during
developement.
This set is huge, if the target disk is small, do not install it.
.
.It Sy xfont
Fonts needed by the X server and by X clients.
.
.It Sy xetc
Configuration files for X which could be locally modified.
.
.It Sy xserver
The X server.
This includes the modular Xorg server.
.
.tag) \" x sets
.
.
.\" ------------------------------------------------------------------
.
.
.\" MI DISCUSSION OF BINARY SETS -------------------------------------
.\" XXX: should be in notes/common
.
.Pp
The \*M binary distribution sets are distributed as gzipped tar files
named with the extension
.Sy .\*[setsuffix] ,
e.g.
.Pa base.\*[setsuffix] .
.
.
.Pp
The instructions given for extracting the source sets work equally
well for the binary sets, but it is worth noting that if you use that
method, the filenames stored in the sets are relative and therefore
the files are extracted
.Em below the current directory .
Therefore, if you want to extract the binaries into your system, i.e.
replace the system binaries with them, you have to run the
.Ic "tar -xzpf"
command from the root directory (
.Pa /
) of your system.
.
.
.\" MD DISCUSSION ----------------------------------------------------
.
.\" XXX: should be written
.