1.\" $NetBSD: release.7,v 1.31 2009/09/19 07:06:55 snj 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.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd September 19, 2009 31.Dt RELEASE 7 32.Os 33.Sh NAME 34.Nm release 35.Nd layout of NetBSD releases and snapshots 36.Sh DESCRIPTION 37This document describes the layout of 38.Nx 39releases and snapshots. 40This layout should be consistent between FTP servers and CD-ROMs, 41except possibly the path that leads to the release hierarchy. 42.Pp 43In this document, the following special words have these definitions: 44.Bl -tag -width "\*[Lt]machine_arch\*[Gt]" 45.It Aq Em machine 46The platform for which the release was built, corresponding to the 47.Em hw.machine 48sysctl variable, e.g., 49.Em i386 50or 51.Em amiga . 52.It Aq Em machine_arch 53The architecture for which a particular installation set was built, 54corresponding to the 55.Em hw.machine_arch 56sysctl variable, e.g., 57.Em i386 58or 59.Em m68k . 60.It Aq Em rel 61The release version number. 62.El 63.Pp 64All 65.Sy README 66files are descriptions of the various files in directories that have 67.Dq non-standard 68contents. 69There may also be a 70.Sy README 71file at the top-level, 72describing who built the snapshot and under what circumstances 73.Po e.g., whether it's an official 74.Nx 75snapshot, or not 76.Pc . 77.Pp 78All 79.Sy MD5 80files are MD5 digests for the various files in that directory, in the 81format produced by the command: 82.Sy cksum -m Aq Sy file . 83.Pp 84All 85.Sy SHA512 86files are SHA512 digests for the various files in that directory, in the 87format produced by the command: 88.Sy cksum -a SHA512 Aq Sy file . 89.Pp 90The SHA512 digest is safer, but MD5 checksums are provided so that a wider 91range of operating systems can check the integrity of the release files. 92.Pp 93Files that end in 94.Sy .tgz 95are gzipped tar archives. 96This is used in lieu of 97.Sy .tar.gz 98because the software used to download the sets may incorrectly auto-unpack 99files ending in 100.Sy .gz 101and to accommodate systems which only support 3 character extensions 102to file names. 103.Pp 104All tar archives are relative to the target's 105.Sy / 106directory, and 107.Em do not 108include the leading 109.Dq / . 110.Pp 111The root of the release hierarchy may be the root directory of a 112CD-ROM, but in all other cases it should be 113.Sm off 114.Xo 115.Sy .../NetBSD- 116.Aq Em rel 117.Sy / . 118.Xc 119.Sm on 120.Pp 121The root of the release hierarchy should contain the following 122files and subdirectories: 123.Pp 124.Bl -tag -width "\*[Lt]machine\*[Gt]" 125.It Sy iso/ 126CDROM images in ISO 9660 format, usually created with 127.Dq ./build.sh ... iso-image ... 128after a 129.Dq ./build.sh -x ... release ... 130in 131.Pa src 132or created with 133.Dq ./build.sh ... iso-image-source ... 134after a 135.Dq ./build.sh -x ... release sourcesets ... 136in 137.Pa src . 138.Pp 139Images in this directory, unlike images in the 140.Sm off 141.Xo 142.Sy .../NetBSD- 143.Aq Em rel 144.Sy / 145.Aq Em machine 146.Sy /installation/cdrom/ 147.Xc 148.Sm on 149directory, contain file systems that 150have an internal layout that corresponds to 151a complete release for a given machine type. 152If built with 153.Dq iso-image-source , 154then it will also contain a 155.Dq source 156directory. 157These images are usually bootable. 158.Bl -tag -width "\*[Lt]machine_arch\*[Gt]cd.iso" 159.It Sy MD5 160.It Sy SHA512 161.It Ao Em machine Ac Ns Sy cd.iso 162.El 163. 164.It Sy shared/ 165Files shared by two or more machine types. 166.Bl -tag -width "\*[Lt]machine_arch\*[Gt]" 167.It Ao Em machine_arch Ac Ns Pa / 168Files which may be shared by all systems of the same 169.Aq Em machine_arch 170will be located in 171.Sm off 172.Xo 173.Sy .../NetBSD- 174.Aq Em rel 175.Sy /shared/ 176.Aq Em machine_arch 177.Sy / 178.Xc 179.Sm on 180with symbolic links pointing to these files from the 181.Aq Em machine 182subdirectory. 183.It Sy ALL/ 184Files which are completely machine-independent will be 185located in 186.Sy .../NetBSD- Ns Ao Em rel Ac Ns Sy /shared/ALL/ 187with symbolic links pointing to these files from the 188.Aq Em machine 189subdirectory. 190.El 191. 192.It Sy source/ 193Source code of the operating system should be put into 194.Sy .../NetBSD- Ns Ao Em rel Ac Ns Sy /source/ 195using the following layout: 196.Pp 197.Bl -tag -width "sets/" 198.It Sy sets/ 199Sources for the various system sets. 200.Bl -tag -width "sharesrc.tgz" 201.It Sy MD5 202.It Sy SHA512 203.It Sy gnusrc.tgz 204Contains sources for all GPLed and possibly other programs that 205contains restrictions in their licensing that prevent others from 206using these programs in closed-source environments. 207.It Sy sharesrc.tgz 208Contains machine-independent data files that can be shared across 209architectures/systems. 210.It Sy src.tgz 211The operating system's userland source code, including all programs, 212tools, libraries, etc. 213.It Sy syssrc.tgz 214Kernel sources for all architectures plus sources of the tools needed 215to build kernels (like 216.Xr config 1 ) . 217.It Sy xsrc.tgz 218Source code of the X Window System used on all 219.Nx 220architectures. 221Includes X clients and servers. 222.El 223.El 224. 225.It Ao Em machine Ac Ns Pa / 226The binary releases in 227.Sm off 228.Xo 229.Sy .../NetBSD- 230.Aq Em rel 231.Sy / 232.Aq Em machine 233.Sy / 234.Xc 235.Sm on 236fit the following layout: 237.Bl -tag -width "installation/" 238.It Sy INSTALL.txt 239Installation notes, including complete descriptions of files contained 240within the release hierarchy 241.It Sy INSTALL.more 242pretty version, suited for viewing with 243.Xr more 1 244.It Sy INSTALL.html 245HTML version 246.It Sy INSTALL.ps 247PostScript version 248.It Sy binary/ 249system binaries 250.Bl -tag -width "SHA512/" 251.It Sy sets/ 252installation sets 253.Bl -tag -width "xserver.tgz" 254.It Sy MD5 255.It Sy SHA512 256.It Sy base.tgz 257The base binary distribution. 258This set contains the base 259.Nx 260utilities that are necessary for the system to run and be minimally 261functional. 262This set excludes all things listed in the sets 263described below. 264.It Sy comp.tgz 265The compiler tools distribution. 266This set contains the C and C++ 267compilers, assembler, linker, other toolchain components, and their 268manual pages. 269It also includes the system include files 270.Pq Pa /usr/include 271and the static system libraries. 272.It Sy etc.tgz 273This set contains the system configuration files that reside in 274.Pa /etc 275and in several other places throughout the file system hierarchy. 276.It Sy games.tgz 277This set includes the games and their manual pages. 278.It Sy kern.tgz 279This set includes a generic kernel. 280.It Sy man.tgz 281This set includes all of the manual pages for the binaries and other 282software contained in the 283.Sy base 284set which are not included in the other sets. 285.It Sy misc.tgz 286This set includes miscellaneous non-essential files, including dictionaries, 287the typesettable document set, and various other documentation and example 288configuration files. 289.It Sy modules.tgz 290This set includes all the kernel modules. 291.It Sy text.tgz 292This set includes the 293.Nx 294text processing tools, including 295.Xr groff 1 , 296all related programs, and their manual pages. 297.It Sy xbase.tgz 298This set includes the base X11 distribution, including manual pages 299and excluding everything contained in the other X11 sets. 300.It Sy xcomp.tgz 301This set includes the X11 include files and static X11 libraries. 302.It Sy xfont.tgz 303This set includes the X11 fonts. 304.It Sy xserver.tgz 305This set includes the X servers and manual pages for 306a given machine. 307.Em "Note: this set may not be available on some platforms" . 308.El 309.It Sy kernel/ 310suitably named, gzipped kernels 311.Bl -tag -width "netbsd-GENERIC.gz" 312.It Sy MD5 313.It Sy SHA512 314.It Sy netbsd-GENERIC.gz 315A kernel built from the 316.Sy GENERIC 317kernel configuration file. 318This is meant as an example only; different 319platforms may have differently named kernels. 320.El 321.El 322.It Sy installation/ 323installation helper items 324.Bl -tag -width "diskimage/" 325.It Sy cdrom/ 326CDROM images in ISO 9660 format, created as part of 327.Dq build.sh ... release ... 328in 329.Pa src . 330.Pp 331Images in this directory are bootable, and contain one a kernel, 332installation tools, and rescue tools. 333They do not contain installation sets, source sets, or 334other components of a complete release. 335.Pp 336.Em "Note: These images are only present in the amd64 and i386 distributions." 337.Bl -tag -width "boot-com.iso" 338.It Sy MD5 339.It Sy SHA512 340.It Sy boot.iso 341VGA console 342.It Sy boot-com.iso 343Serial console 344.El 345.It Sy diskimage/ 346disk images, on those platforms that provide them 347.Bl -tag -width "diskimage.gz" 348.It Sy MD5 349.It Sy SHA512 350.It Sy diskimage.gz 351.El 352.It Sy floppy/ 353floppy images, on those platforms that provide them 354.Bl -tag -width "boot1.fs" 355.It Sy MD5 356.It Sy SHA512 357.It Sy boot1.fs 358.It Sy boot2.fs 359.El 360.It Sy instkernel/ 361installation kernels for platforms that can boot them directly 362.Bl -tag -width netbsd.gz 363.It Sy MD5 364.It Sy SHA512 365.It Sy netbsd.gz 366.El 367.It Sy miniroot/ 368miniroot images, on those platforms that provide them 369.Bl -tag -width "miniroot.fs.gz" 370.It Sy MD5 371.It Sy SHA512 372.It Sy miniroot.fs.gz 373.El 374.It Sy misc/ 375miscellaneous installation helper utilities, including boot selectors, 376floppy writing software, other software that runs under foreign operating 377systems, etc. 378.Bl -tag -width "SHA512" 379.It Sy MD5 380.It Sy SHA512 381.It Sy ... 382.El 383.It Sy netboot/ 384network boot programs 385.Bl -tag -width "netboot.gz" 386.It Sy MD5 387.It Sy SHA512 388.It Sy netboot.gz 389.El 390.It Sy tapeimage/ 391tape images, on those platforms that provide them 392.Bl -tag -width "tapeboot" 393.It Sy MD5 394.It Sy SHA512 395.It Sy tapeboot 396.El 397.El 398.El 399.El 400.Sh SEE ALSO 401.Xr cksum 1 , 402.Xr gzip 1 , 403.Xr split 1 , 404.Xr tar 1 405.Sh HISTORY 406The 407.Nm 408manual page first appeared in 409.Nx 1.3 . 410