xref: /netbsd/distrib/notes/common/contents (revision bf9ec67e)
$NetBSD: contents,v 1.53 2002/05/23 06:44:17 pooka Exp $

Copyright (c) 1999-2001 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.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the NetBSD
Foundation, Inc. and its contributors.
4. Neither the name of The NetBSD Foundation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

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

a \*M subdirectory of the distribution: .(tag INSTALL.html -compact . 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

a .more No file contains underlined text using the .Xr more 1 conventions for indicating italic and bold display. . It Pa binary/ . (tag instkernel/ -compact . It Pa kernel/ . (tag netbsd.INSTALL_LAPTOP.gz -compact . It Pa netbsd-GENERIC.gz A gzipped .Nx kernel containing code for everything supported in this release. This kernel runs on Vr41xx and TX3922 CPU only. .\} . This kernel will boot on O2 and similar machines. .\} . . It Pa netbsd.INSTALL.gz A somewhat smaller kernel, which you can use to boot the system using loadbsd for installation on memory-tight systems. This is the same kernel as present on the miniroot. .\} . . It Pa netbsd.FOURMEG.gz A somewhat smaller kernel, intended to be usable on systems with four megabytes of RAM. .\} . . It Pa netbsd-TX3912.gz A kernel for TX3912 machines. .\} . . It Pa netbsd.GENERIC_LAPTOP.gz A version of .Li GENERIC that has USB, PCMCIA and CardBus enabled to allow installing on laptop machines. . It Pa netbsd.GENERIC_TINY.gz A version of .Li GENERIC intended to run on machines with less than 8 MB. . It Pa netbsd.GENERIC_PS2TINY.gz A version of .Li GENERIC intended to run on IBM PS/2 machines. . It Pa netbsd.INSTALL.gz The install kernel. . It Pa netbsd.INSTALL_TINY.gz A version of .Li INSTALL intended to run on machines with less than 8 MB. . It Pa netbsd.INSTALL_SMALL.gz A version of .Li INSTALL intended to fit on a 5.25"/1.2 MB diskette. . It Pa netbsd.INSTALL_LAPTOP.gz A version of .Li INSTALL that has USB, PCMCIA and CardBus enabled to allow installing on laptop machines. . It Pa netbsd.INSTALL_PS2.gz A version of .Li INSTALL that has MCA stuff enabled to allow installing on IBM PS/2 machines. .\} . 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 from an HFS partition on Open Firmware 3 systems, netboot, or from a CD-R. . 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. This is the kernel you should use when you want to install on one of these systems from a floppy disk. .\} . . It Pa netbsd.VME147.gz A kernel for MVME147 boards. . It Pa netbsd.VME162.gz A kernel for MVME162 boards. . It Pa netbsd.VME167.gz A kernel for MVME167 boards. . It Pa netbsd.VME172.gz A kernel for MVME172 boards. . It Pa netbsd.VME177.gz A kernel for MVME177 boards. .\} . . It Pa netbsd-GENERIC_INDY.gz A kernel similar to GENERIC, but will boot on an Indy and similar machines. . It Pa netbsd.ecoff-GENERIC_INDY.gz GENERIC targeted for being bootable on Indigo 2 and similar machines. .\} . . tag) . It Pa sets/ \*M binary distribution sets; see below. . tag) . It Pa installation/ . . (tag instkernel/ -compact . \n[newsmips]:\n[pc532]:\n[x68k]:\n[prep]:\n[sandpoint] \{\ . It Pa floppy/ \*M boot and installation floppies; see below. .\} . . It Pa diskimage/ . It Pa tapeimage/ .No an image file Pa cdhdtape is included for the case where the installer is written to a CD, hard drive, or tape. This image file is the same for the CD, HD, and tape cases, but a separate

a tapeimage/ directory exists to hold a copy of the

a README No file and to meet the .Nx .Xr release 7 standard. . It Pa instkernel/ .No contains a Pa netbsd.gz installation kernel; this is the same installer kernel as in all the other install images, but without the various boot program and file system wrappers. It can be netbooted or diskbooted from a previous installation. no need to c gunzip this image. .\} . . It Pa miniroot/ \*M miniroot file system image; see below. .\} . . It Pa misc/ . contains

a GENERIC.fs , a .Li GENERIC kernel in a bootable file system image. This is used in some unusual installations as described in the next section. .\} Statically-linked versions of c gzip (GNU gzip) and c gtar (GNU tar). .\} Miscellaneous \*M installation utilities; see installation section, below. \} .\} . . It Pa boot.fs \*M boot and installation floppy image. Only usable on models that ship with a floppy drive (pre-Open Firmware 3); see below. . It Pa ofwboot.xcf \*M bootloader; see below. .\} . . It Pa netboot/ Two programs needed to boot \*M kernels over the network; see below. . It Pa tapeimage/ Tape boot programs, and a RAMDISK kernel; see below. .\} . . It Pa netboot/ NFS-root images .\} . . It Pa netboot/ Server boot-file image for diskless machines. .\} . . It Pa netboot/ Two programs needed to boot \*M kernels over the network. . It Pa tapeimage/ Tape boot program, and two shell scripts used to prepare tapes. .\} . . It Pa netboot/ Two programs needed to boot \*M kernels over the network. . It Pa tapeimage/ Tape boot programs, and a RAMDISK kernel. .\} . . tag) . . . .Ss2 Bootable installation/upgrade floppies

p There are three bootable images in the .Nx \*M distribution. One is for a dual-floppy boot and is split into two separate files. The other is a single-file image containing the same install kernel, but intended to be written to a CD, tape, or hard drive. The third image is a .Li GENERIC kernel intended for production use in unusual cases. This can be useful at some sites when: .(bullet You want to run diskless but SRM bugs prevent the firmware from netbooting. You can work around this problem by always booting the generic kernel from the floppy. t SRM doesn't recognize your (hard) disk controller but .Nx does. This happens more frequently than you might think. SRM will usually only boot from .Xr ncr 4 or .Xr isp 4 SCSI devices, and on most platforms will not boot from an IDE drive. .Nx will happily operate with almost any SCSI root or an IDE root; the solution here is to netboot a kernel or always boot from floppy. .bullet) .\} . . .Ss2 Miniroot file system The Amiga now uses a single miniroot file system for both an initial installation and for an upgrade. A gzipped version is available, for easier downloading. (The gzipped version has the .Sy .gz extension added to their names.) .(tag miniroot.fs t Pa miniroot.fs This file contains a x root file system setup to help you install the rest of .Nx or to upgrade a previous version of .Nx . This includes formatting and mounting your

a / (root) and

a /usr partitions and getting ready to extract (and possibly first fetching) the distribution sets. There is enough on this file system to allow you to make a SLIP or PPP connection, configure an Ethernet, mount an NFS file system or ftp. You can also load distribution sets from a SCSI tape or from one of your existing .Tn AmigaDOS partitions. .\} . . .Ss2 Binary distribution sets The .Nx \*M binary distribution sets contain the binaries which comprise the .Nx \*V release for the \*M. There are eight binary distribution sets. The binary distribution sets can be found in the

a \*M/binary/sets subdirectory of the .Nx \*V distribution tree, and are as follows: .(tag xcontrib . t Sy base The .Nx \*V .No \*M Sy base No 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 includes shared library support, and excludes everything described below.

. t Sy comp Things needed for compiling programs. This set includes the system include files

q 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.

. t Sy etc This distribution set contains the system configuration files that reside in

a /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.

Not MI, but close enough to the same size on all ports...
.Em 0.1 MB gzipped, 0.6 MB uncompressed . t Sy games This set includes the games and their manual pages.

Shareable within MACHINE_ARCH
. t Sy kern-GENERIC This set contains a .Nx*M \*V .Li GENERIC kernel, named

a /netbsd . .No You Em must install this distribution set.

. t 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.

MI
.Em 6.3 MB gzipped, 25.4 MB uncompressed . t Sy misc This set includes the (rather large) system dictionaries, the typesettable document set, and other files from

a /usr/share .

MI
.Em 2.6 MB gzipped, 10.1 MB uncompressed . t Sy text This set includes .Nx Ns 's text processing tools, including .Xr groff 1 , all related programs, and their manual pages.

Shareable within MACHINE_ARCH
. . . ---------------------------- X SETS

p .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 XFree86, and tightly track XFree86 releases. They are currently equivalent to XFree86 3.3.6. Binary sets for the X Window System are distributed with .Nx . The sets are: .(tag xcontrib t Sy xbase The basic files needed for a complete X client environment. This does not include the X servers.

Shareable within MACHINE_ARCH, except atari
. t Sy xcomp The extra libraries and include files needed to compile X source code.

Shareable within MACHINE_ARCH
. t Sy xcontrib Programs that were contributed to X.

Shareable within MACHINE_ARCH
. t Sy xfont Fonts needed by X.

MI
.Em 6.2 MB gzipped, 7.5 MB uncompressed . t Sy xmisc Miscellaneous X programs.

MI
Shareable within MACHINE_ARCH
. . t Sy xserver

.Em 2.3 MB gzipped, 9.2 MB uncompressed .\} . t Sy xserver

.Em 1.6 MB gzipped, 3.9 MB uncompressed .\} . t Sy xserver The Xservers and some programs not shared with the other m68k ports. Please consult the X specific section in the atari FAQ as to which server you should use.

.Em 5.7 MB gzipped, 14.1 MB uncompressed .\} . t Sy xserver The Xhpc server which supports 256 and 65536 colors, with man pages.

.Em 2.0 MB gzipped, 6.0 MB uncompressed .\} . t Sy xserver All XFree86 X servers. Because all of them are included, this set is large. However, you will only need one of the servers provided in this set. (Typically, c XF86_SVGA . )

.Em 14.9 MB gzipped, 35.2 MB uncompressed .\} . t Sy xserver The Xmac68k Em monochrome server with man pages.

.Em 1.4 MB gzipped, 3.4 MB uncompressed .\} . t Sy xserver The Xmacppc server which supports 256 colors with man pages.

.Em 1.7 MB gzipped, 4.6 MB uncompressed .\} . t There is currently no X server for the \*M platform. .\} . t Sy xserver .No The Xpmax server with man page. .Em 1.8 MB gzipped, 5.6 MB uncompressed .\} . t Sy xserver .No The Xsun, Xsun24, XsunMono and Xprt servers with man pages.

.Em 3.3 MB gzipped, 8.5 MB uncompressed .\} . t Sy xserver The Xsun, Xsun24, XsunMono and Xprt servers with man pages. The 64-bit X server current has problems with pixmaps.

.Em 3.4 MB gzipped, 8.9 MB uncompressed .\} . t Sy xserver .No The X68k and Xprt servers with man pages and the runtime configuration file.

.Em 1.5 MB gzipped, 3.6 MB uncompressed .\} . . . ---------------------------- MI DISCUSSION OF BINARY SETS
. .

p The \*M binary distribution sets are distributed as gzipped tar files named with the extension .Sy .tgz , No e.g.

a base.tgz . . . . contrary to most old INSTALL docs, only i386 has Split/ sets
. They are also available in split form; catted together, the members of a split set form a gzipped tar file. .\} . .

p 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 files are

a / Ns No -relative and therefore are extracted .Em below the current directory. That is, if you want to extract the binaries into your system, i.e. replace the system binaries with them, you have to run the c "tar -xpf" command from

a / . . . ---------------------------- MD DISCUSSION
. .

p There is a copy of the .Nx Ns /acorn26 bootloader, c boot26 , in the

a installation/misc subdirectory. This is a RISC OS relocatable module, and should have its file type set to ffa (Module) once it's been copied to a RISC OS system. .\} . .

p Additional kernels to those included in the distribution sets may be found in the

a atari/binary/kernel subdirectory of the .Nx \*V distribution tree. These kernels are generally named something like

a netbsd.BOOT.gz or some other suitable name. Please note that these kernels are simply gzipped and are not in tar archives.

p There are three atari floppy images to be found in the

a atari/installation/floppies subdirectory of the .Nx \*V distribution. One of them is a bootable .Tn TOS kernel floppy and the other two are installation floppies. They are described in more detail below. There are gzipped versions of each available, for easier downloading. (The gzipped versions have the

a .gz extension added to their names.) .(tag indent t Em Bootable Kernel floppy This .Tn TOS disk contains the loadbsd and chg_pid programs and a kernel. It is setup so that you can insert it int your floppy drive, and start the programs from GEM.

p For the TT030 and Falcon, the (720 KB) floppy is named

a boot.fs and the kernel supplied is .Li BOOT . For the Hades, you need the

a hades-boot.fs floppy (1.44 MB), the kernel is .Li HADES . t Em Installation floppy: This disk contains a x root file system setup to help you install the rest of .Nx . This includes formatting and mounting your

a / (root) and

a /usr partitions and getting ready to extract (and possibly first fetching) the distribution sets. There is enough on this file system to allow you to make a slip connection, configure an ethernet, mount an NFS file system or ftp. You can also load distribution sets from a SCSI tape or from one of your existing .Tn GEMDOS partitions.

p The floppies meant for 720 KB disks are named

a miniroot.fs.1 No and Pa miniroot.fs.2 . There is also an image for an 1.44 MB disk:

a miniroot.fs .

p There are also .Tn TOS utilities in the

a atari/installation/misc subdirectory, which you will need to get .Nx*M up-and-running. .(bullet The c gzip.ttp program allows you to uncompress .gz images. The usage is:

p .Dl Ic "gzip.ttp -d filename.gz" t The c rawwrite.ttp program allows you to create the installation floppy disks from the files in the

a atari/floppies directory. t The c aptck.ttp program reads the partition tables present on a given disk and tries to interpret then the same way the .Nx kernel does. If you have a disk on which .Tn GEMDOS and .Nx are to co-exist, It is a good idea to run this before you begin the .Nx*M installation just to check that the kernel's view of the partition tables agree with .Tn GEMDOS Ns 's view. If you have more than 3 partitions defined on a disk you will notice that the .Nx*M partition starts one sector after the .Tn GEMDOS partition. This is to allow space for the auxiliary root for the 4th and subsequent partitions. t The c loadbsd.ttp program loads the .Nx*M kernel from .Tn TOS (or .Tn MiNT , .Tn MultiTOS , etc.). .bullet) .\} . .

p The following are included in the

a hp300/installation No directory: . .(tag miniroot/ t Pa miniroot/ . (tag miniroot.fs.gz . It Pa miniroot.fs.gz A copy of the miniroot file system. . tag) t Pa misc/ . (tag miniroot.fs.gz . It Pa HP-IB.geometry A file containing geometry for some HB-IB disk drives. . It Pa SYS_INST.gz A gzipped copy of the SYS_INST miniroot installation program. . It Pa SYS_UBOOT.gz A gzipped copy of the universal boot block. Supports Network, tape and disk booting. This is useful if you are installing a diskless .Nx*M system. . It Pa rbootd.tgz Source code for the rbootd program included with .Nx . It requires that the server has a Berkeley Packet Filter (bpf). You will need to compile this version of rbootd if server system does not have this utility already. . tag) . The following are included in the

a hp300/binary/kernel No directory: . .(tag netbsd.RAMDISK.symbols.gz t Pa netbsd-GENERIC.gz A gzipped .Li GENERIC kernel. t Pa netbsd.RAMDISK.gz A gzipped .Li INSTALL kernel with embedded ramdisk. t Pa netbsd.RAMDISK.symbols.gz Symbols for

a netbsd.RAMDISK.gz . .\} . .

p Additional kernels to those included in the distribution sets may be found in the

a hpcmips/binary/kernels subdirectory of the .Nx \*V distribution tree. These kernels are generally named something like

a netbsd-GENERIC.gz or some other suitable name. Please note that these kernels are simply gzipped and are not in tar archives.

p The .Tn "Windows CE" Ns No -based utilities necessary for installing and running .Nx can be found in the

a hpcmips/installation/ subdirectory of the .Nx \*V distribution tree. The important files in this directory are as follows: . . .(tag pbsdboot1.exe t Pa netbsd.gz .Nx*M kernel with system installer (sysinst). This kernel runs on Vr41xx and TX3922 CPU only.

.Em 1.98 MB gzipped, 6.7 MB uncompressed t Pa netbsd.TX3912.gz .Nx*M kernel with system installer (sysinst). This kernel runs on TX3912 CPU only.

.Em 1.98 MB gzipped, 6.7 MB uncompressed t Pa hpcboot.exe The .Nx*M boot loader utility. This program is used to boot the .Nx kernel from within .Tn "Windows CE" (version 2.11 and later).

.Em 111 KB t Pa pbsdboot.exe The .Nx*M boot loader utility. This program is used to boot the .Nx kernel from within .Tn "Windows CE" (version 2.0 and later).

.Em 176 KB t Pa pbsdboot1.exe The .Nx*M boot loader utility. This program is used to boot the .Nx kernel from within .Tn "Windows CE" (version 1.01).

.Em 191 KB

p These

a *.exe files are .Tn "Windows CE binaries. If you need them, the sources for these utilities are in the

a src/arch/hpc/stand/ and the

a src/arch/hpcmips/stand/ directories. .\} . .

p Additional kernels to those included in the distribution sets may be found in the

a mac68k/binary/kernels subdirectory of the .Nx \*V distribution tree. These kernels are generally named something like

a netbsd-GENERIC.gz or some other suitable name. Please note that these kernels are simply gzipped and are not in tar archives.

p The .Tn MacOS based utilities necessary for installing and running .Nx can be found in the

a mac68k/installation/misc subdirectory of the .Nx \*V distribution tree. The important files in this directory are as follows: . .(tag Installer.sea.hqx t Pa Booter.sea.hqx The .Nx*M Booter utility. This program is used to boot the .Nx kernel from within .Tn MacOS .

.Em 141 KB archived t Pa Installer.sea.hqx The .Nx*M Installer utility. This program is used to install the distribution sets onto your .Nx partition(s).

.Em 147 KB archived t Pa Mkfs.sea.hqx The Mkfs utility. This program is used to format your chosen partitions so that they can be used with .Nx .

.Em 76 KB archived

p These files are all binhexed, self-extracting archives. If you need them, the sources for these utilities are in the

a src No subdirectory. .\} .

p The following are included in the

a mvme68k/installation No directory: . .(tag miniroot/ t Pa miniroot/ . (tag miniroot.gz . It Pa miniroot.gz A copy of the miniroot file system. This filesystem image is copied into the swap partition of the disk which you intend to boot .Nx from. Normally, this step will be performed manually from the ramdisk boot environment. . tag) . .(tag miniroot/ t Pa netboot/ . (tag sboot . It Pa sboot An MVME147 bootstrap program in Motorola S-Record format. This is required when you wish to boot an MVME147 over the network since the ROM has no built-in network support. Instructions for getting this program into memory are discussed later. . tag) . (tag netboot . It Pa netboot A standalone 2nd stage bootstrap program loaded over the network via TFTP. This is responsible for fetching and starting the .Nx \*M kernel from an NFS server. . tag) . .(tag tapeimage/ t Pa tapeimage/ . (tag stboot . It Pa stboot This file contains a boot sector for Motorola MVME boards. It must be the first file written to a tape in order to make the tape bootable. . tag) . (tag bootst . It Pa bootst This file contains a bootstrap program which knows how to load the .Nx \*M ramdisk image from tape. This must be the second file written to the tape. . tag) . (tag netbsd.RAMDISK.gz . It Pa netbsd.RAMDISK.gz This is the .Nx \*M ramdisk image. It contains a .Li GENERIC kernel and a built in RAMDISK with just enough tools to partition a disk, dump the miniroot kernel to it and make the disk bootable. This must be the third file written to the tape. . tag) .\} . .

p The initial installation process on a pc532 without a previous .Nx installation is supported by the following files: .(tag floppy-144.fs t Pa floppy-144.fs A file system containing the boot loader and install kernel with a 2 MB root. t Pa download.c The source for a program to download

a inst-11.fs into memory via the pc532 .Tn ROM No monitor .

p The upgrade process is supported by having a copy of a \*V kernel available. This file is: .(tag kern.tgz t Pa kern.tgz Contains a kernel produced from the

a DEFAULT configuration file in

a pc532/conf . .\} . . .(Note The distribution cannot be extracted using the .Tn SunOS c tar program so statically-linked .Tn SunOS versions of c gzip (GNU gzip) and c gtar (GNU tar) are provided in

a sparc/installation/misc . .Note) .\} . .

p There is a collection of Sun2 kernels in the

a \*M/binary/kernel subdirectory of the .Nx \*V distribution. The one named

a netbsd.RAMDISK.gz contain a root file system image and should only be used for the initial installation. The others are included for convenience. (Most people will want to use

a netbsd-GENERIC.gz or

a netbsd-FOURMEG.gz as appropriate.) Please note that these kernels are simply gzipped and are not tar archives. .\} .

p There is a collection of Sun3 and Sun3X kernels in the

a \*M/binary/kernels subdirectory of the .Nx \*V distribution. The ones named

a netbsd-ramdisk*.gz contain a root file system image and should only be used for the initial installation. The others are included for convenience. (Most people will want to use

a netbsd-generic.gz or

a netbsd-generic3x.gz as appropriate.) Please note that these kernels are simply gzipped and are not tar archives. .\}