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