1.\" $NetBSD: release.7,v 1.7 1999/05/10 19:34:22 is 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 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.txt 172Installation notes, including complete descriptions of files contained 173within the release hierarchy 174.It Sy INSTALL.more 175pretty version of this, suited for viewing with 176.Xr more 1 177.It Sy INSTALL.html 178HTML version of this 179.It Sy INSTALL.ps 180PostScript version of this 181.It Sy binary/ 182system binaries 183.Bl -tag -width "security/" 184.It Sy sets/ 185installation sets 186.Bl -tag -width "xcontrib.tgz" 187.It Sy BSDSUM 188.It Sy CKSUM 189.It Sy MD5 190.It Sy SYSVSUM 191.It Sy Split/ 192installation sets split with the 193.Xr split 1 194command. 195.Em "Note: split installation sets may not be available for all platforms" . 196.Bl -tag -width "base.aa" 197.It Sy BSDSUM 198.It Sy CKSUM 199.It Sy MD5 200.It Sy SYSVSUM 201.It Sy base.aa 202.It Sy base.ab 203.It Sy ... 204.El 205.It Sy base.tgz 206The base binary distribution. This set contains the base 207.Nx 208utilities that are necessary for the system to run and be minimally 209functional. It includes shared libraries for those architectures that 210support support them. This set excludes all things listed in the sets 211described below. 212.It Sy comp.tgz 213The compiler tools distribution. This set contains the C and C++ 214compilers, assembler, linker, other toolchain components, and their 215manual pages. It also includes the system include files 216.Pq Pa /usr/include 217, and the static system libraries. 218.It Sy etc.tgz 219This set contains the system configuration files that reside in 220.Pa /etc 221and in several other places throughout the file system hierarchy. 222.It Sy games.tgz 223This set includes the games and their manual pages. 224.It Sy kern.tgz 225This set includes a generic kernel. 226.It Sy man.tgz 227This set includes all of the manual pages for the binaries and other 228software contained in the 229.Sy base 230set which are not included in the other sets. 231.It Sy misc.tgz 232This set includes the system dictionaries (which are rather large), the 233typesettable document set, and manual pages for other architectures, which 234happen to be installed from the source tree by default. 235.It Sy text.tgz 236This set includes the 237.Nx 238text processing tools, including 239.Xr groff 1 , 240all related programs, and their manual pages. 241.It Sy xbase.tgz 242This set includes the base X11 distribution, including manual pages and 243shared libraries for those architectures that support them, and excluding 244everything contained in the other X11 sets. 245.It Sy xcomp.tgz 246This set includes the X11 include files and static X11 libraries. 247.It Sy xcontrib.tgz 248This set includes binaries and manual pages for programs built from the 249X11 250.Dq contrib 251sources. 252.It Sy xfont.tgz 253This set includes the X11 fonts. 254.It Sy xserver.tgz 255This set includes the X servers and manual pages for <machine>. 256.Em "Note: this set may not be available on some platforms" . 257.El 258.It Sy kernel/ 259suitably named, gzipped kernels 260.Bl -tag -width "netbsd-GENERIC.gz" 261.It Sy BSDSUM 262.It Sy CKSUM 263.It Sy MD5 264.It Sy README 265.It Sy SYSVSUM 266.It Sy netbsd-GENERIC.gz 267A kernel built from the 268.Sy GENERIC 269kernel configuration file. This is meant as an example only; different 270platforms may have differently named kernels. 271.El 272.It Sy security/ 273security-related system binaries 274.Bl -tag -width "secr.tgz" 275.It Sy BSDSUM 276.It Sy CKSUM 277.It Sy MD5 278.It Sy SYSVSUM 279.It Sy Split/ 280.Bl -tag -width "secr.aa" 281.It Sy BSDSUM 282.It Sy CKSUM 283.It Sy MD5 284.It Sy SYSVSUM 285.It Sy secr.aa 286.It Sy secr.ab 287.It Sy ... 288.El 289.It Sy secr.tgz 290This set contains executables which are built from the 291.Dq Pa src/domestic 292portion of the 293.Nx 294source tree. It can only be found on those sites 295which carry the complete 296.Nx 297distribution and can legally obtain it. 298(Remember, because of United States law, it may not be legal to distribute 299this set to locations outside the United States and Canada.) 300.El 301.El 302.It Sy installation/ 303installation helper items 304.Bl -tag -width "diskimage/" 305.It Sy diskimage/ 306disk images, for those platforms that provide them 307.Bl -tag -width "diskimage-rz25.gz" 308.It Sy BSDSUM 309.It Sy CKSUM 310.It Sy MD5 311.It Sy README 312.It Sy SYSVSUM 313.It Sy diskimage-rz25.gz 314.El 315.It Sy floppy/ 316floppy images, for those platforms that provide them 317.Bl -tag -width "floppy-144.gz" 318.It Sy BSDSUM 319.It Sy CKSUM 320.It Sy MD5 321.It Sy README 322.It Sy SYSVSUM 323.It Sy floppy-144.gz 324.El 325.It Sy miniroot/ 326miniroot images, for those platforms that provide them 327.Bl -tag -width "miniroot.gz" 328.It Sy BSDSUM 329.It Sy CKSUM 330.It Sy MD5 331.It Sy README 332.It Sy SYSVSUM 333.It Sy miniroot.gz 334.El 335.It Sy misc/ 336miscellaneous installation helper utilities, including boot selectors, 337floppy writing software, other software that runs under foreign operating 338systems, etc. 339.Bl -tag -width "CKSUMS" 340.It Sy BSDSUM 341.It Sy CKSUM 342.It Sy MD5 343.It Sy README 344.It Sy SYSVSUM 345.It Sy ... 346.El 347.It Sy netboot/ 348network boot programs 349.Bl -tag -width "netboot.gz" 350.It Sy BSDSUM 351.It Sy CKSUM 352.It Sy MD5 353.It Sy README 354.It Sy SYSVSUM 355.It Sy netboot.gz 356.El 357.It Sy tapeimage/ 358tape images, for those platforms that provide them 359.Bl -tag -width "tapeimage-hp9144.gz" 360.It Sy BSDSUM 361.It Sy CKSUM 362.It Sy MD5 363.It Sy README 364.It Sy SYSVSUM 365.It Sy tapeimage-hp9144.gz 366.El 367.El 368.El 369.Sh SEE ALSO 370.Xr cksum 1 , 371.Xr date 1 , 372.Xr gzip 1 , 373.Xr split 1 , 374.Xr tar 1 375.Sh HISTORY 376The 377.Nm 378manual page first appeared in 379.Nx 1.3 . 380