.\" $NetBSD: contents,v 1.2 1999/01/25 23:34:22 garbled Exp $ .\" .\" Copyright (c) 1999 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. .\" .ds m \*[MACHINE] .Ss2 NetBSD/\*m Subdirectory Structure The \*m-specific portion of the .Nx \*V release is found in the .Pa \*m subdirectory of the distribution: .ie \n[_FOR_RELEASE] .Pa \&.../NetBSD-\*V/\*m/ .el .Pa Pf \&.../arch/\*m/snapshot/ Ar yyyymmdd/ .Bl -tag -compact -width INSTALL.html . It Pa INSTALL.html . It Pa INSTALL.ps . It Pa INSTALL.txt . It Pa INSTALL.more Installation notes; this file. The .Pa \&.more No file contains underlined text using the .Xr more 1 conventions for indicating italic and bold display. . It Pa binary/ . Bl -tag -compact -width diskimage/ . It Pa sets/ \*m binary distribution sets; see below. .if \n[amiga] \{\ . Bl -tag -compact -width diskimage/ . It Pa Split/ \&.tgz files split for loading onto floppies. . El .\} . It Pa security/ \*m security distribution; see below. .if \n[amiga] \{\ . It Pa kernel/ .No The Tn GENERIC No kernel. .\} .if \n[sparc] \{\ . It Pa kernel/ .No Base Tn GENERIC No kernels. .\} . El . It Pa installation/ .\" BTW, .Bl ... .El is not allowed unless there is at least one .It. . .\"============================================ ALPHA INSTALLATION SUBTREE . .if \n[alpha] \{\ . Bl -tag -compact -width diskimage/ . It Pa floppy/ \*m boot and installation floppies; see below. . It Pa tapeimage/ . It Pa diskimage/ .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, .No but a separate Pa tapeimage/ directory exists to hold a copy of the .Tn README No file and to meet the .Nx .Xr release 7 standard. . El .\} . .\"============================================ AMIGA INSTALLATION SUBTREE . .if \n[amiga] \{\ . Bl -tag -compact -width diskimage/ . It Pa miniroot/ \*[MACHINE] miniroot file system image; see below. . It Pa misc/ Miscellaneous \*[MACHINE] installation utilities; see installation section, below. . El .\} . .\"============================================ ARM32 INSTALLATION SUBTREE . .if \n[arm32] \{\ . Bl -tag -compact -width diskimage/ . It Pa kernels/ \*m installation and other kernels; see below. . It Ar platform/ Miscellaneous arm32 installation utilities and supplementary documentation for .Ar platform ; No see installation section, below. . El .\} . .\"============================================ HP300 INSTALLATION SUBTREE . .if \n[hp300] \{\ . Bl -tag -compact -width diskimage/ . It Pa miniroot/ hp300 miniroot images; see below. . It Pa misc/ Miscellaneous hp300 installation helper utilities; see installation section below. . El .\} . .\"============================================ I386 INSTALLATION SUBTREE . .if \n[i386] \{\ . Bl -tag -compact -width diskimage/ . It Pa floppy/ \*m boot and installation floppies; see below. . It Pa misc/ Miscellaneous \*[MACHINE] installation utilities; see installation section, below. . El .\} . . . .\"============================================ MVME68K INSTALLATION SUBTREE . .if \n[mvme68k] \{\ . Bl -tag -compact -width diskimage/ . It Pa miniroot/ The miniroot filesystem image. . It Pa netboot/ Two programs needed to boot a VME147 kernel over the network. . It Pa tapeimage/ Tape boot programs, and a RAMDISK kernel. . El .\} . .\"============================================ PC532 INSTALLATION SUBTREE . .if \n[pc532] \{\ . Bl -tag -compact -width floppy . It Pa floppy/ . Bl -tag -compact -width floppy-144.fs.gz . It Pa floppy-144.fs.gz Installation file system obtained via SCSI floppy or download to RAM. . El . It Pa misc/ . Bl -tag -compact -width floppy-144.fs.gz . It Pa download.c.gz Source for the program to download inst-11.fs into memory via the pc532 ROM monitor. . El . El .\} . .\"============================================ PMAX INSTALLATION SUBTREE . .if \n[pmax] \{\ .\} . .\"============================================ SPARC INSTALLATION SUBTREE . .if \n[sparc] \{\ . Bl -tag -compact -width miniroot/ . It Pa miniroot/ Sparc miniroot boot-image. . It Pa netboot/ Server boot-file image for diskless machines. . It Pa misc/ Statically-linked versions of gzip (GNU gzip) and gtar (GNU tar). . El .\} . .\"============================================ SUN3 INSTALLATION SUBTREE . .if \n[sun3] \{\ .\} . .\"============================================ SUN3X INSTALLATION SUBTREE . .if \n[sun3x] \{\ .\} . .\"============================================ VAX INSTALLATION SUBTREE . .if \n[vax] \{\ .\} . .\"============================================ X68K INSTALLATION SUBTREE . .if \n[x68k] \{\ .\} . . . . .El . . . .if r_alpha \{\ .Ss2 Bootable installation/upgrade floppies: .Pp 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 .Tn GENERIC kernel intended for production use in unusual cases. This can be useful at some sites when: .Bl -bullet .It 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. .It 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. .El .\} . .if r_amiga \{\ .Ss2 Miniroot file system The Amiga now uses a single miniroot filesystem 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 Pa miniroot.fs This file contains a BSD 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 root and /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 AmigaDOS partitions. .tag) .\} . .if r_arm32 \{\ There are a collection of arm32 kernels in the "arm32/kernels" subdirectory of the .Nx \*V distribution. Some of these kernels contain a root file system image and should only be used for the initial installation. Some of the kernels only support a particular subset of the platforms that arm32 supports (See "arm32/kernels/README" for more details.) .\} . .if r_mvme68k \{\ .Pp The NetBSD/mvme68k install distribution contains files that can be used to install NetBSD onto a completely "bare" VME147. The files in the "mvme68k/installation/*" directories are described below. .Bl -tag -width netbsd-rd.gz .It Pa miniroot.gz A gzipped copy of the miniroot filesystem. This image is to be un-gzipped and copied into the swap area of a disk. .It Pa netbsd-rd.gz A gzipped copy of the .Em RAMDISK kernel for installing the miniroot filesystem. .It Pa stboot A tape boot-block, in the form required to allow 147-Bug to boot from tape. This is the first segment of a boot tape. .It Pa bootst A copy of the tape boot program, used as the second segment of a boot tape. .It Pa sboot A copy of the serial boot program. This is necessary if you don't have a tape drive, but you _do_ have another system which can act as a boot and NFS server. This is also useful if you are installing a diskless NetBSD/mvme68k system. .It Pa netboot A copy of the network boot program. Used in conjunction with sboot to get your system booted over a network. .El .Pp These files can be used to make a boot tape suitable for installing NetBSD/mvme68k. These files can also be used to configure an NFS server to support installation "over the network". See the section .Sx Getting the NetBSD System onto Useful Media for instructions on either method. .\} . . .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 .ie r_pc532 sets. .el .No sets and the Em security No distribution set. The binary distribution sets can be found in the .Pa \*m/binary/sets subdirectory of the .Nx \*V distribution tree, and are as follows: .Bl -tag -width mmmmmmmmmmm -compact .Pp .It 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. .br .if r_alpha .Em 13M gzipped, 41M uncompressed .if r_arm32 .Em 11M gzipped, 28M uncompressed .if r_mac68k .Em 8.6M gzipped, 25.1M uncompressed .Pp .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. .br .if r_alpha .Em 6M gzipped, 31M uncompressed .if r_arm32 .Em 7.5M gzipped, 25M uncompressed .if r_mac68k .Em 6.2M gzipped, 21.6M uncompressed .Pp .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. (If you are upgrading, it's recommended that you get a copy of this set and .Em carefully upgrade your configuration files by hand.) .br .if r_alpha .Em 50K gzipped, 320K uncompressed .if r_arm32 .Em 52K gzipped, 310K uncompressed .if r_mac68k .Em 49K gzipped, 288K uncompressed .Pp .It Sy games This set includes the games and their manual pages. .br .if r_alpha .Em 3M gzipped, 8M uncompressed .if r_arm32 .Em 3M gzipped, 7.4M uncompressed .if r_mac68k .Em 2.8M gzipped, 7.2M uncompressed . .\" garden variety kern set description . .if !\n[arm32]:\n[atari]:\n[mac68k] \{\ .Pp .It Sy kern This set contains a NetBSD/\*m \*V .Tn GENERIC No kernel, named Pa /netbsd . .No You Em must install this distribution set. .br .if r_alpha .Em 1M gzipped, 2M uncompressed .\} .if \n[atari] \{\ .Pp .It Sy kern .It Sy kern_hades .It Sy kern_x The NetBSD/\*m \*V kernel binary. You should install the appropriate kernel for your system. .Em 472K gzipped, 1.01M uncompressed .\} .if \n[mac68k] \{\ .Pp .It Sy kern .It Sy kern_sbc This set contains a NetBSD/\*m \*V .Tn GENERIC No kernel, named Pa /netbsd . .No You Em must install this distribution set. It is the kernel that you need to boot the system. If you experience SCSI-related difficulties with your 68030-based system, you might want to try kern_sbc.tgz instead. .br .Em 606K gzipped, 1.32M uncompressed .\} .Pp .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. .br .Em 2.5M gzipped, 10M uncompressed .Pp .It Sy misc This set includes the (rather large) system dictionaries, the typesettable document set, and other files from .Pa /usr/share . .br . .\" Umm, shouldn't this be the same for all platforms?! . .if r_alpha .Em 2M gzipped, 9M uncompressed .if r_arm32 .Em 2M gzipped, 8M uncompressed .if r_mac68k .Em 2.1M gzipped, 7.6M uncompressed .Pp .It Sy text This set includes NetBSD's text processing tools, including .Xr groff 1 , all related programs, and their manual pages. .br .if r_alpha .Em 1M gzipped, 4M uncompressed .if r_arm32 .Em 1M gzipped, 4M uncompressed .if r_mac68k .Em 1.0M gzipped, 3.7M uncompressed .El .if r_atari \{\ .(tag Note: An X server distribution set is currently not available. .tag) .\} . . .ie \n[pc532] \{\ .Pp The pc532 distribution set does not include a security distribution. If you are in the US and want the security distribution you must get the security source distribution and recompile libcrypt.a and recompile the following programs: .Xr ed 1 , .Xr ftpd 8 , .Xr makekey 8 , .Xr rexecd 8 , .Xr uucpd 8 , .Xr init 8 , .Xr lock 1 , .Xr login 1 , .Xr passwd 1 , .Xr skeyinit 1 , .Xr su 1 , .Xr tn3270 1 , and .Xr pppd 8 . .\} .el \{\ .Pp The \*m security distribution set is named .Sy secr No and can be found in the .D1 Pa \*m/binary/security subdirectory of the .Nx \*V distribution tree. It contains security-related binaries which depend on cryptographic source code. You do not need this distribution set to use encrypted passwords in your password file; the .Sy base distribution includes a crypt library which can perform only the one-way encryption function. The security distribution includes a version of the Kerberos IV network security system, and a Kerberized version of .Xr telnet 1 .No program. The Sy secr distribution set can be found only on those sites which carry the complete .Nx distribution and which can legally obtain it. Because of United States law, it may not be legal to distribute this set to locations outside of the United States and Canada. .br .if r_alpha .Em 1M gzipped, 3M uncompressed .if r_i386 . Em 798K gzipped, 2.4M uncompressed .\} . . .Pp Starting with release 1.3, binary sets for the X Window system are distributed with .Nx . The binaries are based on X11R6.3. .if r_hp300 \{\ Unfortunately there is no R6.3 Xserver for NetBSD/hp300 yet, so we can only distribute the X clients this time. .\} You can not yet install them using the new automated install system. However, they are gzipped tarfiles, just like the other sets, so you can always simply extract them once you have your .Nx system installed and running. The sets are: .Bl -tag -width xcontribmmm .It Sy xbase The basic files needed for a complete X client environment. This does not include the X servers. .br .if r_hp300 .Em 2.5M gzipped, 7.6M uncompressed .if r_mac68k .Em 2.34 M gzipped, 7.46M uncompressed .It Sy xcomp The extra libraries and include files needed to compile X source code. .br .if r_hp300 .Em 1.7M gzipped, 7.1M uncompressed .if r_mac68k .Em 1.57M gzipped, 6.38M uncompressed .It Sy xcontrib Programs that were contributed to X. .br .if r_hp300 .Em 183k gzipped, 686k uncompressed .if r_mac68k .Em 178K gzipped, 661K uncompressed .It Sy xfont Fonts needed by X. .br .Em 5.9M gzipped, 7.3M uncompressed . .if r_mac68k \{\ .Pp .It Sy xserver .No The Xmac68k Em monochrome server with man pages. .br .Em 1.32M gzipped, 3.25M uncompressed .\} . .El . .\"============================ MI DISCUSSION OF BINARY SETS . .Pp The \*m binary distribution sets are distributed as gzipped tar files named with the extension .Sy .tgz , No e.g. .Pa base.tgz . . . .\" contrary to most old INSTALL docs, only i386 has Split/ sets . . .if r_i386 \{\ They are also available in split form \- catted together, the members of a split set form a gzipped tar file. .\} . . .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 files are /-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 .Ic tar xfp command from /. . . . . .if r_atari \{\ .Pp Additional kernels to those included in the distribution sets may be found in the .Pa atari/binary/kernel subdirectory of the .Nx \*V distribution tree. These kernels are generally named something like .Pa netbsd.BOOT.gz or some other suitable name. Please note that these kernels are simply gzipped and are not in tar archives. .Pp There are three atari floppy images to be found in the .Pa atari/installation/floppies subdirectory of the .Nx \*V distribution. One of them is a bootable 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 .Pa \&.gz extension added to their names.) .Bl -tag -width indent .It Em Bootable\ Kernel\ floppy This 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. .Pp For the TT030 and Falcon, the floppy is named boot-_SVER_S.fs and the kernel supplied is 'BOOT'. For the Hades, you need the hades-boot-_SVER_S.fs floppy. The kernel is 'HADES'. .It Em Installation\ floppy: This disk contains a BSD root file system setup to help you install the rest of NetBSD. This includes formatting and mounting your root and /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 GEMDOS partitions. .Pp These floppies are named .Pa miniroot.fs.1 No and Pa miniroot.fs.2 . .El .Pp There are also TOS utilities in the .Pa atari/installation/misc subdirectory, which you will need to get NetBSD/Atari 'up-and-running'. .Bl -bullet .It The .Dq gzip.ttp program allows you to uncompress .gz images. The usage is "gzip.ttp -d filename.gz". .It The .Dq rawwrite.ttp program allows you to create the installation floppy disks from the files in the .Pa atari/floppies directory. .It The "aptck.ttp" program reads the partition tables present on a given disk and tries to interpret then the same way the NetBSD kernel does. If you have a disk on which GEMDOS and .Nx are to co-exist, It is a good idea to run this before you begin the NetBSD/Atari installation just to check that the kernel's view of the partition tables agree with GEMDOS's view. If you have more than 3 partitions defined on a disk you will notice that the NetBSD/\*m partition starts one sector after the GEMDOS partition. This is to allow space for the auxilliary root for the 4th and subsequent partitions. .It The "loadbsd.ttp" program loads the NetBSD/\*m kernel from TOS (or MiNT, MultiTOS, etc.). .El .\} . . . .if r_hp300 \{\ . .Pp The following are included in the .Pa hp300/installation No directory: . . .Bl -tag -width miniroot/xx .It Pa miniroot/ . Bl -tag -width miniroot.fs.gz . It miniroot.fs.gz A copy of the miniroot filesystem. . El .It Pa misc/ . Bl -tag -width 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 NetBSD/hp300 system. . It Pa rbootd.tgz Source code for the rbootd program included with NetBSD. 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. . El .El . . The following are included in the .Pa hp300/binary/kernel No directory: . .Bl -tag -width netbsd.gdb.gzmmmmm .It Pa netbsd.gdb.gz A gzipped GENERIC kernel with debugging symbols. .It Pa netbsd.gz A gzipped GENERIC kernel. .El . .\} . .if r_mac68k \{\ .Pp Additional kernels to those included in the distribution sets may be found in the .Pa mac68k/binary/kernels subdirectory of the .Nx \*V distribution tree. These kernels are generally named something like .Pa netbsd-GENERIC.gz or some other suitable name. Please note that these kernels are simply gzipped and are not in tar archives. .Pp The MacOS-based utilities necessary for installing and running .Nx can be found in the .Pa mac68k/installation/misc subdirectory of the .Nx \*V distribution tree. The important files in this directory are as follows: . . .Bl -tag -width Installer.sea.hqx .It Pa Booter.sea.hqx The NetBSD/Mac68k Booter utility. This program is used to boot the .Nx kernel from within MacOS. .br .Em 141 K archived .It Pa Installer.sea.hqx The NetBSD/Mac68k Installer utility. This program is used to install the distribution sets onto your .Nx partition(s). .br .Em 147 K archived .It Pa Mkfs.sea.hqx The Mkfs utility. This program is used to format your chosen partitions so that they can be used with NetBSD. .br .Em 76 K archived .El .Pp These files are all binhexed, self-extracting archives. If you need them, the sources for these utilities are in the .Pa src No subdirectory. . . .\} . . .if r_pc532 \{\ .Pp The initial installation process on a pc532 without a previous .Nx installation is supported by the following files: .Bl -tag -width floppy-144.fs .It Pa floppy-144.fs A file system containing the boot loader and install kernel with a 2MB root. .It Pa download.c The source for a program to download .Pa inst-11.fs into memory via the pc532 .Tn ROM No monitor . .El .Pp The upgrade process is supported by having a copy of a \*V kernel available. This file is: .(tag Pa kern.tgz Contains a kernel produced from the .Pa DEFAULT configuration file in .Pa pc532/conf . .tag) .\} . . .if r_sparc \{\ . (Note The distribution cannot be extracted using the SunOS . Pa tar program so statically-linked SunOS versions of gzip (GNU gzip) and gtar (GNU tar) are provided in . Pa sparc/installation/misc . . Note) .\} . . .(Note Each directory in the \*m binary distribution also has its own checksum files, just as the source distribution does: .Pp .No All Tn BSDSUM files are historic .Tn BSD No checksums for the various files in that directory, in the format produced by the command: .Ic cksum -o 1 Ar file .Pp .No All Tn CKSUM No files are .Tn POSIX checksums for the various files in that directory, in the format produced by the command: .Ic cksum Ar file . .Pp .No All Tn MD5 No files are .Tn MD5 digests for the various files in that directory, in the format produced by the command: .Ic cksum Fl m Ar file . .Pp .No All Tn SYSVSUM files are historic AT\*&T System V .Ux checksums for the various files in that directory, in the format produced by the command: .Ic cksum Fl o 2 Ar file . .Pp The MD5 digest is the safest checksum, followed by the POSIX checksum. The other two checksums are provided only to ensure that the widest possible range of system can check the integrity of the release files. .Note)