1.\" $NetBSD: release.7,v 1.1 1997/11/25 05:27:44 thorpej 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 BSD checksums for the various files in that directory, 79in the format produced by the command: 80.Sy cksum -o 1 <file> . 81.Pp 82All 83.Sy CKSUM 84files are POSIX checksums for the various files in that directory, in the 85format produced by the command: 86.Sy cksum <file> . 87.Pp 88All 89.Sy MD5 90files are MD5 digests for the various files in that directory, in the 91format produced by the command: 92.Sy cksum -m <file> . 93.Pp 94All 95.Sy SYSVSUM 96files are historic AT&T System V UNIX checksums for the various files in 97that directory, in the format produced by the command: 98.Sy cksum -o 2 <file> . 99.Pp 100The MD5 digest is the safest checksum, followed by the POSIX checksum. 101The other two checksums are provided only to ensure that the widest possible 102range of system can check the integrity of the release files. 103.Pp 104Files that end in 105.Sy .tgz 106are gzipped tar archives. This is used in lieu of 107.Sy .tar.gz 108because the software used to download the sets may incorrectly auto-unpack 109files ending in 110.Sy .gz 111and to accomodate systems which only support 3 character extensions 112to file names. 113.Pp 114All tar archives are relative to the target's 115.Sy / 116directory, and 117.Em do not 118include the leading 119.Dq / . 120.Pp 121All compression of release files is to be performed with the command: 122.Sy gzip -9 . 123.Pp 124The root of the release hierarchy is 125.Sm off 126.Xo 127.Sy .../NetBSD- 128.Em <rel> 129.Sy / 130.Em <machine> 131.Sy / . 132.Xc 133.Sm on 134For files which may be shared by all systems of the same 135.Em <machine_arch> , 136(e.g. the 137.Sy games 138and 139.Sy xbase 140sets for m68k-based platforms), this hierarchy will have a second root of 141.Sm off 142.Xo 143.Sy .../NetBSD- 144.Em <rel> 145.Sy / 146.Em <machine_arch> 147.Sy / 148.Xc 149.Sm on 150which will contain those files. For files which are completely 151machine-independent (e.g. the 152.Sy xfont 153set), this hierarchy will have a third root of 154.Sy .../NetBSD- Ns Em <rel> Ns Sy /mi/ 155which will contain those files. 156Unless otherwise noted, all files may be symbolic links to common 157.Em <machine_arch> 158or machine-independent files located in their respective directory 159hierarchies. 160.Bl -tag -width "installation/" 161.It Sy SOURCE_DATE 162a file containing the date, in UTC, of the source code from which the 163release or snapshot was built, in the default format produced by the 164command: 165.Sy date -u 166.It Sy INSTALL 167Installation notes, including complete descriptions of files contained 168within the release hierarchy 169.It Sy binary/ 170system binaries 171.Bl -tag -width "security/" 172.It Sy sets/ 173installation sets 174.Bl -tag -width "xcontrib.tgz" 175.It Sy BSDSUM 176.It Sy CKSUM 177.It Sy MD5 178.It Sy SYSVSUM 179.It Sy Split/ 180installation sets split with the 181.Xr split 1 182command. 183.Em "Note: split installation sets may not be available for all platforms" . 184.Bl -tag -width "base.aa" 185.It Sy BSDSUM 186.It Sy CKSUM 187.It Sy MD5 188.It Sy SYSVSUM 189.It Sy base.aa 190.It Sy base.ab 191.It Sy ... 192.El 193.It Sy base.tgz 194The base binary distribution. This set contains the base 195.Nx 196utilities that are necessary for the system to run and be minimally 197functional. It includes shared libraries for those architectures that 198support support them. This set excludes all things listed in the sets 199described below. 200.It Sy comp.tgz 201The compiler tools distribution. This set contains the C and C++ 202compilers, assembler, linker, other toolchain components, and their 203manual pages. It also includes the system include files 204.Pq Pa /usr/include 205, and the static system libraries. 206.It Sy etc.tgz 207This set contains the system configuration files that reside in 208.Pa /etc 209and in several other places throughout the file system hierarchy. 210.It Sy games.tgz 211This set includes the games and their manual pages. 212.It Sy kern.tgz 213This set includes a generic kernel. 214.It Sy man.tgz 215This set includes all of the manual pages for the binaries and other 216software contained in the 217.Sy base 218set which are not included in the other sets. 219.It Sy misc.tgz 220This set includes the system dictionaries (which are rather large), the 221typesettable document set, and manual pages for other architectures, which 222happen to be installed from the source tree by default. 223.It Sy text.tgz 224This set includes the 225.Nx 226text processing tools, including 227.Xr groff 1 , 228all related programs, and their manual pages. 229.It Sy xbase.tgz 230This set includes the base X11 distribution, including manual pages and 231shared libraries for those architectures that support them, and excluding 232everything contained in the other X11 sets. 233.It Sy xcomp.tgz 234This set includes the X11 include files and static X11 libraries. 235.It Sy xcontrib.tgz 236This set includes binaries and manual pages for programs built from the 237X11 238.Dq contrib 239sources. 240.It Sy xfont.tgz 241This set includes the X11 fonts. 242.It Sy xserver.tgz 243This set includes the X servers and manual pages for <machine>. 244.Em "Note: this set may not be available on some platforms" . 245.El 246.It Sy kernel/ 247suitably named, gzipped kernels 248.Bl -tag -width "netbsd-GENERIC.gz" 249.It Sy BSDSUM 250.It Sy CKSUM 251.It Sy MD5 252.It Sy README 253.It Sy SYSVSUM 254.It Sy netbsd-GENERIC.gz 255A kernel built from the 256.Sy GENERIC 257kernel configuration file. This is meant as an example only; different 258platforms may have differently named kernels. 259.El 260.It Sy security/ 261security-related system binaries 262.Bl -tag -width "secr.tgz" 263.It Sy BSDSUM 264.It Sy CKSUM 265.It Sy MD5 266.It Sy SYSVSUM 267.It Sy Split/ 268.Bl -tag -width "secr.aa" 269.It Sy BSDSUM 270.It Sy CKSUM 271.It Sy MD5 272.It Sy SYSVSUM 273.It Sy secr.aa 274.It Sy secr.ab 275.It Sy ... 276.El 277.It Sy secr.tgz 278This set contains executables which are built from the 279.Dq Pa src/domestic 280portion of the 281.Nx 282source tree. It can only be found on those sites 283which carry the complete 284.Nx 285distribution and can legally obtain it. 286(Remember, because of United States law, it may not be legal to distribute 287this set to locations outside the United States and Canada.) 288.El 289.El 290.It Sy installation/ 291installation helper items 292.Bl -tag -width "diskimage/" 293.It Sy diskimage/ 294disk images, for those platforms that provide them 295.Bl -tag -width "diskimage-rz25.gz" 296.It Sy BSDSUM 297.It Sy CKSUM 298.It Sy MD5 299.It Sy README 300.It Sy SYSVSUM 301.It Sy diskimage-rz25.gz 302.El 303.It Sy floppy/ 304floppy images, for those platforms that provide them 305.Bl -tag -width "floppy-144.gz" 306.It Sy BSDSUM 307.It Sy CKSUM 308.It Sy MD5 309.It Sy README 310.It Sy SYSVSUM 311.It Sy floppy-144.gz 312.El 313.It Sy miniroot/ 314miniroot images, for those platforms that provide them 315.Bl -tag -width "miniroot.gz" 316.It Sy BSDSUM 317.It Sy CKSUM 318.It Sy MD5 319.It Sy README 320.It Sy SYSVSUM 321.It Sy miniroot.gz 322.El 323.It Sy misc/ 324miscellaneous installation helper utilities, including boot selectors, 325floppy writing software, other software that runs under foreign operating 326systems, etc. 327.Bl -tag -width "CKSUMS" 328.It Sy BSDSUM 329.It Sy CKSUM 330.It Sy MD5 331.It Sy README 332.It Sy SYSVSUM 333.It Sy ... 334.El 335.It Sy netboot/ 336network boot programs 337.Bl -tag -width "netboot.gz" 338.It Sy BSDSUM 339.It Sy CKSUM 340.It Sy MD5 341.It Sy README 342.It Sy SYSVSUM 343.It Sy netboot.gz 344.El 345.It Sy tapeimage/ 346tape images, for those platforms that provide them 347.Bl -tag -width "tapeimage-hp9144.gz" 348.It Sy BSDSUM 349.It Sy CKSUM 350.It Sy MD5 351.It Sy README 352.It Sy SYSVSUM 353.It Sy tapeimage-hp9144.gz 354.El 355.El 356.El 357.Sh SEE ALSO 358.Xr cksum 1 , 359.Xr date 1 , 360.Xr gzip 1 , 361.Xr split 1 , 362.Xr tar 1 363.Sh HISTORY 364The 365.Nm 366manual page first appeared in 367.Nx 1.3 . 368