1.\" $NetBSD: release.7,v 1.3 1998/02/06 06:13:20 perry Exp $ 2.\" 3.\" Copyright (c) 1997 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" Authors: Charles M. Hannum and Jason R. Thorpe. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. All advertising materials mentioning features or use of this software 17.\" must display the following acknowledgement: 18.\" This product includes software developed by the NetBSD 19.\" Foundation, Inc. and its contributors. 20.\" 4. Neither the name of The NetBSD Foundation nor the names of its 21.\" contributors may be used to endorse or promote products derived 22.\" from this software without specific prior written permission. 23.\" 24.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 25.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 26.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 27.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 28.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 29.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 30.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 31.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 32.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 33.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 34.\" POSSIBILITY OF SUCH DAMAGE. 35.\" 36.Dd November 18, 1997 37.Dt RELEASE 7 38.Os NetBSD 39.Sh NAME 40.Nm release 41.Nd layout of NetBSD releases and snapshots 42.Sh DESCRIPTION 43This document describes the layout of 44.Nx 45releases and snapshots. 46This layout should be consistent between FTP servers and CD-ROMs, 47except possibly the path that leads to the release hierarchy. 48.Pp 49In this document, the following special words have these definitions: 50.Bl -tag -width "<machine_arch>" 51.It Em <machine> 52The platform for which the release was built, corresponding to the 53.Em hw.machine 54sysctl variable, e.g. 55.Em i386 56or 57.Em amiga . 58.It Em <machine_arch> 59The architecture for which a particular installation set was built, 60corresponding to the 61.Em hw.machine_arch 62sysctl variable, e.g. 63.Em i386 64or 65.Em m68k . 66.It Em <rel> 67The target release. 68.El 69.Pp 70All 71.Sy README 72files are descriptions of the various files in directories that have 73.Dq non-standard 74contents. 75.Pp 76All 77.Sy BSDSUM 78files are historic 79.Bx 80checksums for the various files in that directory, 81in the format produced by the command: 82.Sy cksum -o 1 <file> . 83.Pp 84All 85.Sy CKSUM 86files are POSIX checksums for the various files in that directory, in the 87format produced by the command: 88.Sy cksum <file> . 89.Pp 90All 91.Sy MD5 92files are MD5 digests for the various files in that directory, in the 93format produced by the command: 94.Sy cksum -m <file> . 95.Pp 96All 97.Sy SYSVSUM 98files are historic AT&T System V UNIX checksums for the various files in 99that directory, in the format produced by the command: 100.Sy cksum -o 2 <file> . 101.Pp 102The MD5 digest is the safest checksum, followed by the POSIX checksum. 103The other two checksums are provided only to ensure that the widest possible 104range of system can check the integrity of the release files. 105.Pp 106Files that end in 107.Sy .tgz 108are gzipped tar archives. This is used in lieu of 109.Sy .tar.gz 110because the software used to download the sets may incorrectly auto-unpack 111files ending in 112.Sy .gz 113and to accommodate systems which only support 3 character extensions 114to file names. 115.Pp 116All tar archives are relative to the target's 117.Sy / 118directory, and 119.Em do not 120include the leading 121.Dq / . 122.Pp 123All compression of release files is to be performed with the command: 124.Sy gzip -9 . 125.Pp 126The root of the release hierarchy is 127.Sm off 128.Xo 129.Sy .../NetBSD- 130.Em <rel> 131.Sy / 132.Em <machine> 133.Sy / . 134.Xc 135.Sm on 136For files which may be shared by all systems of the same 137.Em <machine_arch> , 138(e.g. the 139.Sy games 140and 141.Sy xbase 142sets for m68k-based platforms), this hierarchy will have a second root of 143.Sm off 144.Xo 145.Sy .../NetBSD- 146.Em <rel> 147.Sy / 148.Em <machine_arch> 149.Sy / 150.Xc 151.Sm on 152which will contain those files. For files which are completely 153machine-independent (e.g. the 154.Sy xfont 155set), this hierarchy will have a third root of 156.Sy .../NetBSD- Ns Em <rel> Ns Sy /mi/ 157which will contain those files. 158Unless otherwise noted, all files may be symbolic links to common 159.Em <machine_arch> 160or machine-independent files located in their respective directory 161hierarchies. 162.Bl -tag -width "installation/" 163.It Sy SOURCE_DATE 164a file containing the date, in UTC, of the source code from which the 165release or snapshot was built, in the default format produced by the 166command: 167.Sy date -u 168.It Sy INSTALL 169Installation notes, including complete descriptions of files contained 170within the release hierarchy 171.It Sy binary/ 172system binaries 173.Bl -tag -width "security/" 174.It Sy sets/ 175installation sets 176.Bl -tag -width "xcontrib.tgz" 177.It Sy BSDSUM 178.It Sy CKSUM 179.It Sy MD5 180.It Sy SYSVSUM 181.It Sy Split/ 182installation sets split with the 183.Xr split 1 184command. 185.Em "Note: split installation sets may not be available for all platforms" . 186.Bl -tag -width "base.aa" 187.It Sy BSDSUM 188.It Sy CKSUM 189.It Sy MD5 190.It Sy SYSVSUM 191.It Sy base.aa 192.It Sy base.ab 193.It Sy ... 194.El 195.It Sy base.tgz 196The base binary distribution. This set contains the base 197.Nx 198utilities that are necessary for the system to run and be minimally 199functional. It includes shared libraries for those architectures that 200support support them. This set excludes all things listed in the sets 201described below. 202.It Sy comp.tgz 203The compiler tools distribution. This set contains the C and C++ 204compilers, assembler, linker, other toolchain components, and their 205manual pages. It also includes the system include files 206.Pq Pa /usr/include 207, and the static system libraries. 208.It Sy etc.tgz 209This set contains the system configuration files that reside in 210.Pa /etc 211and in several other places throughout the file system hierarchy. 212.It Sy games.tgz 213This set includes the games and their manual pages. 214.It Sy kern.tgz 215This set includes a generic kernel. 216.It Sy man.tgz 217This set includes all of the manual pages for the binaries and other 218software contained in the 219.Sy base 220set which are not included in the other sets. 221.It Sy misc.tgz 222This set includes the system dictionaries (which are rather large), the 223typesettable document set, and manual pages for other architectures, which 224happen to be installed from the source tree by default. 225.It Sy text.tgz 226This set includes the 227.Nx 228text processing tools, including 229.Xr groff 1 , 230all related programs, and their manual pages. 231.It Sy xbase.tgz 232This set includes the base X11 distribution, including manual pages and 233shared libraries for those architectures that support them, and excluding 234everything contained in the other X11 sets. 235.It Sy xcomp.tgz 236This set includes the X11 include files and static X11 libraries. 237.It Sy xcontrib.tgz 238This set includes binaries and manual pages for programs built from the 239X11 240.Dq contrib 241sources. 242.It Sy xfont.tgz 243This set includes the X11 fonts. 244.It Sy xserver.tgz 245This set includes the X servers and manual pages for <machine>. 246.Em "Note: this set may not be available on some platforms" . 247.El 248.It Sy kernel/ 249suitably named, gzipped kernels 250.Bl -tag -width "netbsd-GENERIC.gz" 251.It Sy BSDSUM 252.It Sy CKSUM 253.It Sy MD5 254.It Sy README 255.It Sy SYSVSUM 256.It Sy netbsd-GENERIC.gz 257A kernel built from the 258.Sy GENERIC 259kernel configuration file. This is meant as an example only; different 260platforms may have differently named kernels. 261.El 262.It Sy security/ 263security-related system binaries 264.Bl -tag -width "secr.tgz" 265.It Sy BSDSUM 266.It Sy CKSUM 267.It Sy MD5 268.It Sy SYSVSUM 269.It Sy Split/ 270.Bl -tag -width "secr.aa" 271.It Sy BSDSUM 272.It Sy CKSUM 273.It Sy MD5 274.It Sy SYSVSUM 275.It Sy secr.aa 276.It Sy secr.ab 277.It Sy ... 278.El 279.It Sy secr.tgz 280This set contains executables which are built from the 281.Dq Pa src/domestic 282portion of the 283.Nx 284source tree. It can only be found on those sites 285which carry the complete 286.Nx 287distribution and can legally obtain it. 288(Remember, because of United States law, it may not be legal to distribute 289this set to locations outside the United States and Canada.) 290.El 291.El 292.It Sy installation/ 293installation helper items 294.Bl -tag -width "diskimage/" 295.It Sy diskimage/ 296disk images, for those platforms that provide them 297.Bl -tag -width "diskimage-rz25.gz" 298.It Sy BSDSUM 299.It Sy CKSUM 300.It Sy MD5 301.It Sy README 302.It Sy SYSVSUM 303.It Sy diskimage-rz25.gz 304.El 305.It Sy floppy/ 306floppy images, for those platforms that provide them 307.Bl -tag -width "floppy-144.gz" 308.It Sy BSDSUM 309.It Sy CKSUM 310.It Sy MD5 311.It Sy README 312.It Sy SYSVSUM 313.It Sy floppy-144.gz 314.El 315.It Sy miniroot/ 316miniroot images, for those platforms that provide them 317.Bl -tag -width "miniroot.gz" 318.It Sy BSDSUM 319.It Sy CKSUM 320.It Sy MD5 321.It Sy README 322.It Sy SYSVSUM 323.It Sy miniroot.gz 324.El 325.It Sy misc/ 326miscellaneous installation helper utilities, including boot selectors, 327floppy writing software, other software that runs under foreign operating 328systems, etc. 329.Bl -tag -width "CKSUMS" 330.It Sy BSDSUM 331.It Sy CKSUM 332.It Sy MD5 333.It Sy README 334.It Sy SYSVSUM 335.It Sy ... 336.El 337.It Sy netboot/ 338network boot programs 339.Bl -tag -width "netboot.gz" 340.It Sy BSDSUM 341.It Sy CKSUM 342.It Sy MD5 343.It Sy README 344.It Sy SYSVSUM 345.It Sy netboot.gz 346.El 347.It Sy tapeimage/ 348tape images, for those platforms that provide them 349.Bl -tag -width "tapeimage-hp9144.gz" 350.It Sy BSDSUM 351.It Sy CKSUM 352.It Sy MD5 353.It Sy README 354.It Sy SYSVSUM 355.It Sy tapeimage-hp9144.gz 356.El 357.El 358.El 359.Sh SEE ALSO 360.Xr cksum 1 , 361.Xr date 1 , 362.Xr gzip 1 , 363.Xr split 1 , 364.Xr tar 1 365.Sh HISTORY 366The 367.Nm 368manual page first appeared in 369.Nx 1.3 . 370