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