1.\" $NetBSD: release.7,v 1.16 2002/02/13 08:18:20 ross Exp $ 2.\" 3.\" Copyright (c) 1997, 2000 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 October 6, 2000 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 "\*[Lt]machine_arch\*[Gt]" 52.It Em \*[Lt]machine\*[Gt] 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 \*[Lt]machine_arch\*[Gt] 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 \*[Lt]rel\*[Gt] 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 \*[Lt]file\*[Gt] . 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 \*[Lt]file\*[Gt] . 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 \*[Lt]file\*[Gt] . 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 \*[Lt]file\*[Gt] . 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 \*[Lt]rel\*[Gt] 134.Sy / 135.Em \*[Lt]machine\*[Gt] 136.Sy / . 137.Xc 138.Sm on 139.Pp 140Files which may be shared by all systems of the same 141.Em \*[Lt]machine_arch\*[Gt] 142will be located in 143.Sm off 144.Xo 145.Sy .../NetBSD- 146.Em \*[Lt]rel\*[Gt] 147.Sy /shared/ 148.Em \*[Lt]machine_arch\*[Gt] 149.Sy / 150.Xc 151.Sm on 152with symbolic links pointing to these files from the 153.Em \*[Lt]machine\*[Gt] 154subdirectory. Files which are completely machine-independent will be 155located in 156.Sy .../NetBSD- Ns Em \*[Lt]rel\*[Gt] Ns Sy /shared/ALL/ 157with symbolic links pointing to these files from the 158.Em \*[Lt]machine\*[Gt] 159subdirectory. 160.Pp 161Sources should be put into 162.Sy .../NetBSD- Ns Em \*[Lt]rel\*[Gt] Ns Sy /source/ 163using the following layout: 164.Pp 165.Bl -tag -width "source/" 166.It Sy source/ 167Source codes of the operating system and patches for it. 168.Bl -tag -width "patches/" 169.It Sy patches/ 170This directory contains various patch files appropriate for 171.Xr patch 1 . 172Other patches may exist for fixing critical problems. 173.Bl -tag -width "diff-1.4.1-to-1.4.2.gz" 174.It Sy BSDSUM 175.It Sy CKSUM 176.It Sy MD5 177.It Sy README 178.It Sy SYSVSUM 179.It Xo 180.Sm off 181.Sy diff- 182.Em \*[Lt]lastrel\*[Gt] 183.Sy - 184.Em \*[Lt]rel\*[Gt] 185.Sy .gz 186.Sm on 187.Xc 188Diff against the last release, usually generated by 189.Ic cvs rdiff . 190For patch releases, diffs against the last release 191are included. If the last release was a patch release itself, the 192diff is against that patch release is included. 193.El 194.It Sy sets/ 195Sources for the various system sets, based on their modules 196in the CVS server. 197.\" XXX how are these generated? Separate checkout of each module? 198.Bl -tag -width "sharesrc.tgz" 199.It Sy BSDSUM 200.It Sy CKSUM 201.It Sy MD5 202.It Sy README 203.It Sy SYSVSUM 204.It Sy Split/ 205installation sets split with the 206.Xr split 1 207command. 208.Bl -tag -width "gnusrc.aa" 209.It Sy BSDSUM 210.It Sy CKSUM 211.It Sy MD5 212.It Sy SYSVSUM 213.It Sy gnusrc.aa 214.It Sy gnusrc.ab 215.It Sy ... 216.El 217.It Sy gnusrc.tgz 218Contains sources for all GPLed and possibly other programs that 219contains restrictions in their licensing that prevent others from 220using these programs in closed-source environments. 221.It Sy pkgsrc.tgz 222Package-sources for third party software ready to compile. See 223pkgsrc/README for more information. 224.It Sy sharesrc.tgz 225Contains machine-independent data files that can be shared across 226architectures/systems. 227.It Sy src.tgz 228The operating system's userland source code, including all programs, 229tools, toolchain, etc. 230.It Sy syssrc.tgz 231Kernel sources for all architectures plus sources of the tools needed 232to build kernels (like 233.Xr config 8 ) . 234.It Sy xsrc.tgz 235Source code of the X Window System used on all NetBSD architectures. 236Includes X clients and servers. 237.El 238.El 239.El 240.Pp 241The release in 242.Sm off 243.Xo 244.Sy .../NetBSD- 245.Em \*[Lt]rel\*[Gt] 246.Sy / 247.Em \*[Lt]machine\*[Gt] 248.Sy / 249.Xc 250.Sm on 251follows the following layout: 252.Bl -tag -width "installation/" 253.It Sy SOURCE_DATE 254a file containing the date, in UTC, of the source code from which the 255release or snapshot was built, in the default format produced by the 256command: 257.Sy date -u 258.It Sy INSTALL.txt 259Installation notes, including complete descriptions of files contained 260within the release hierarchy 261.It Sy INSTALL.more 262pretty version of this, suited for viewing with 263.Xr more 1 264.It Sy INSTALL.html 265HTML version of this 266.It Sy INSTALL.ps 267PostScript version of this 268.It Sy binary/ 269system binaries 270.Bl -tag -width "SYSVSUM/" 271.It Sy sets/ 272installation sets 273.Bl -tag -width "xcontrib.tgz" 274.It Sy BSDSUM 275.It Sy CKSUM 276.It Sy MD5 277.It Sy SYSVSUM 278.It Sy Split/ 279installation sets split with the 280.Xr split 1 281command. 282.Em "Note: split installation sets may not be available for all platforms" . 283.Bl -tag -width "base.aa" 284.It Sy BSDSUM 285.It Sy CKSUM 286.It Sy MD5 287.It Sy SYSVSUM 288.It Sy base.aa 289.It Sy base.ab 290.It Sy ... 291.El 292.It Sy base.tgz 293The base binary distribution. This set contains the base 294.Nx 295utilities that are necessary for the system to run and be minimally 296functional. It includes shared libraries for those architectures that 297support support them. This set excludes all things listed in the sets 298described below. 299.It Sy comp.tgz 300The compiler tools distribution. This set contains the C and C++ 301compilers, assembler, linker, other toolchain components, and their 302manual pages. It also includes the system include files 303.Pq Pa /usr/include 304, and the static system libraries. 305.It Sy etc.tgz 306This set contains the system configuration files that reside in 307.Pa /etc 308and in several other places throughout the file system hierarchy. 309.It Sy games.tgz 310This set includes the games and their manual pages. 311.It Sy kern.tgz 312This set includes a generic kernel. 313.It Sy man.tgz 314This set includes all of the manual pages for the binaries and other 315software contained in the 316.Sy base 317set which are not included in the other sets. 318.It Sy misc.tgz 319This set includes the system dictionaries (which are rather large), the 320typesettable document set, and manual pages for other architectures, which 321happen to be installed from the source tree by default. 322.It Sy text.tgz 323This set includes the 324.Nx 325text processing tools, including 326.Xr groff 1 , 327all related programs, and their manual pages. 328.It Sy xbase.tgz 329This set includes the base X11 distribution, including manual pages and 330shared libraries for those architectures that support them, and excluding 331everything contained in the other X11 sets. 332.It Sy xcomp.tgz 333This set includes the X11 include files and static X11 libraries. 334.It Sy xcontrib.tgz 335This set includes binaries and manual pages for programs built from the 336X11 337.Dq contrib 338sources. 339.It Sy xfont.tgz 340This set includes the X11 fonts. 341.It Sy xserver.tgz 342This set includes the X servers and manual pages for \*[Lt]machine\*[Gt]. 343.Em "Note: this set may not be available on some platforms" . 344.El 345.It Sy kernel/ 346suitably named, gzipped kernels 347.Bl -tag -width "netbsd-GENERIC.gz" 348.It Sy BSDSUM 349.It Sy CKSUM 350.It Sy MD5 351.It Sy README 352.It Sy SYSVSUM 353.It Sy netbsd-GENERIC.gz 354A kernel built from the 355.Sy GENERIC 356kernel configuration file. This is meant as an example only; different 357platforms may have differently named kernels. 358.El 359.El 360.It Sy installation/ 361installation helper items 362.Bl -tag -width "diskimage/" 363.It Sy cdrom/ 364CDROM images in ISO 9660 format, usually created with 365.Dq make iso-image 366in 367.Pa src/etc 368after a 369.Dq make release 370in both 371.Pa src 372and 373.Pa xsrc . 374.Bl -tag -width "netbsd-ARCH.iso" 375.It Sy BSDSUM 376.It Sy CKSUM 377.It Sy MD5 378.It Sy README 379.It Sy SYSVSUM 380.It Xo 381.Sm off 382.Sy netbsd- 383.Em \*[Lt]machine_arch\*[Gt] 384.Sy .iso 385.Sm on 386.Xc 387.El 388.It Sy diskimage/ 389disk images, for those platforms that provide them 390.Bl -tag -width "diskimage-rz25.gz" 391.It Sy BSDSUM 392.It Sy CKSUM 393.It Sy MD5 394.It Sy README 395.It Sy SYSVSUM 396.It Sy diskimage-rz25.gz 397.El 398.It Sy floppy/ 399floppy images, for those platforms that provide them 400.Bl -tag -width "floppy-144.gz" 401.It Sy BSDSUM 402.It Sy CKSUM 403.It Sy MD5 404.It Sy README 405.It Sy SYSVSUM 406.It Sy floppy-144.gz 407.El 408.It Sy miniroot/ 409miniroot images, for those platforms that provide them 410.Bl -tag -width "miniroot.gz" 411.It Sy BSDSUM 412.It Sy CKSUM 413.It Sy MD5 414.It Sy README 415.It Sy SYSVSUM 416.It Sy miniroot.gz 417.El 418.It Sy misc/ 419miscellaneous installation helper utilities, including boot selectors, 420floppy writing software, other software that runs under foreign operating 421systems, etc. 422.Bl -tag -width "CKSUMS" 423.It Sy BSDSUM 424.It Sy CKSUM 425.It Sy MD5 426.It Sy README 427.It Sy SYSVSUM 428.It Sy ... 429.El 430.It Sy netboot/ 431network boot programs 432.Bl -tag -width "netboot.gz" 433.It Sy BSDSUM 434.It Sy CKSUM 435.It Sy MD5 436.It Sy README 437.It Sy SYSVSUM 438.It Sy netboot.gz 439.El 440.It Sy tapeimage/ 441tape images, for those platforms that provide them 442.Bl -tag -width "tapeimage-hp9144.gz" 443.It Sy BSDSUM 444.It Sy CKSUM 445.It Sy MD5 446.It Sy README 447.It Sy SYSVSUM 448.It Sy tapeimage-hp9144.gz 449.El 450.El 451.El 452.Sh SEE ALSO 453.Xr cksum 1 , 454.Xr date 1 , 455.Xr gzip 1 , 456.Xr split 1 , 457.Xr tar 1 458.Sh HISTORY 459The 460.Nm 461manual page first appeared in 462.Nx 1.3 . 463