Annotation of src/share/man/man7/release.7, Revision 1.32.2.1
1.32.2.1! bouyer 1: .\" $NetBSD$
1.1 thorpej 2: .\"
1.18 fredb 3: .\" Copyright (c) 1997, 2000, 2005 The NetBSD Foundation, Inc.
1.1 thorpej 4: .\" All rights reserved.
5: .\"
1.5 mycroft 6: .\" This code is derived from software contributed to The NetBSD Foundation
7: .\" by Charles M. Hannum and Jason R. Thorpe.
1.1 thorpej 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: .\"
1.32.2.1! bouyer 30: .Dd September 6, 2012
1.1 thorpej 31: .Dt RELEASE 7
1.6 garbled 32: .Os
1.1 thorpej 33: .Sh NAME
34: .Nm release
35: .Nd layout of NetBSD releases and snapshots
36: .Sh DESCRIPTION
37: This document describes the layout of
38: .Nx
39: releases and snapshots.
40: This layout should be consistent between FTP servers and CD-ROMs,
41: except possibly the path that leads to the release hierarchy.
42: .Pp
43: In this document, the following special words have these definitions:
1.16 ross 44: .Bl -tag -width "\*[Lt]machine_arch\*[Gt]"
1.28 wiz 45: .It Aq Em machine
1.1 thorpej 46: The platform for which the release was built, corresponding to the
47: .Em hw.machine
1.31 snj 48: sysctl variable, e.g.,
1.1 thorpej 49: .Em i386
50: or
51: .Em amiga .
1.28 wiz 52: .It Aq Em machine_arch
1.1 thorpej 53: The architecture for which a particular installation set was built,
54: corresponding to the
55: .Em hw.machine_arch
1.31 snj 56: sysctl variable, e.g.,
1.1 thorpej 57: .Em i386
58: or
59: .Em m68k .
1.28 wiz 60: .It Aq Em rel
1.31 snj 61: The release version number.
1.1 thorpej 62: .El
63: .Pp
64: All
65: .Sy README
66: files are descriptions of the various files in directories that have
67: .Dq non-standard
68: contents.
1.18 fredb 69: There may also be a
70: .Sy README
71: file at the top-level,
72: describing who built the snapshot and under what circumstances
1.31 snj 73: .Po e.g., whether it's an official
1.19 wiz 74: .Nx
75: snapshot, or not
1.18 fredb 76: .Pc .
1.1 thorpej 77: .Pp
78: All
79: .Sy MD5
80: files are MD5 digests for the various files in that directory, in the
81: format produced by the command:
1.28 wiz 82: .Sy cksum -m Aq Sy file .
1.1 thorpej 83: .Pp
84: All
1.31 snj 85: .Sy SHA512
86: files are SHA512 digests for the various files in that directory, in the
87: format produced by the command:
88: .Sy cksum -a SHA512 Aq Sy file .
89: .Pp
90: The SHA512 digest is safer, but MD5 checksums are provided so that a wider
91: range of operating systems can check the integrity of the release files.
1.1 thorpej 92: .Pp
93: Files that end in
94: .Sy .tgz
1.28 wiz 95: are gzipped tar archives.
96: This is used in lieu of
1.1 thorpej 97: .Sy .tar.gz
98: because the software used to download the sets may incorrectly auto-unpack
99: files ending in
100: .Sy .gz
1.2 enami 101: and to accommodate systems which only support 3 character extensions
1.1 thorpej 102: to file names.
103: .Pp
104: All tar archives are relative to the target's
105: .Sy /
106: directory, and
107: .Em do not
108: include the leading
109: .Dq / .
110: .Pp
1.22 apb 111: The root of the release hierarchy may be the root directory of a
112: CD-ROM, but in all other cases it should be
1.1 thorpej 113: .Sm off
114: .Xo
115: .Sy .../NetBSD-
1.28 wiz 116: .Aq Em rel
1.1 thorpej 117: .Sy / .
118: .Xc
119: .Sm on
1.11 tv 120: .Pp
1.22 apb 121: The root of the release hierarchy should contain the following
122: files and subdirectories:
123: .Pp
124: .Bl -tag -width "\*[Lt]machine\*[Gt]"
1.32.2.1! bouyer 125: .It Sy images/
! 126: Image files intended for use in installing
! 127: .Nx .
! 128: There are different types of images for different platforms, and sometimes
! 129: multiple different image types for a single platform.
1.23 apb 130: .Pp
131: Images in this directory, unlike images in the
132: .Sm off
133: .Xo
134: .Sy .../NetBSD-
1.28 wiz 135: .Aq Em rel
1.23 apb 136: .Sy /
1.28 wiz 137: .Aq Em machine
1.32.2.1! bouyer 138: .Sy /installation/\\*/
1.23 apb 139: .Xc
140: .Sm on
1.32.2.1! bouyer 141: directories, contain file systems that
1.23 apb 142: have an internal layout that corresponds to
1.31 snj 143: a complete release for a given machine type.
1.24 jnemeth 144: If built with
145: .Dq iso-image-source ,
146: then it will also contain a
147: .Dq source
148: directory.
1.23 apb 149: These images are usually bootable.
1.32.2.1! bouyer 150: .Bl -tag -width "NetBSD-\*[Lt]rel\*[Gt]-\*[Lt]machine\*[Gt].iso"
1.23 apb 151: .It Sy MD5
1.31 snj 152: .It Sy SHA512
1.32 jmcneill 153: .It Sy NetBSD- Ns Ao Em rel Ac Ns Sy - Ns Ao Em machine Ac Ns Sy .iso
1.32.2.1! bouyer 154: CDROM images in ISO 9660 format, usually created with
! 155: .Dq ./build.sh ... iso-image ...
! 156: after a
! 157: .Dq ./build.sh -x ... release ...
! 158: in
! 159: .Pa src
! 160: or created with
! 161: .Dq ./build.sh ... iso-image-source ...
! 162: after a
! 163: .Dq ./build.sh -x ... release sourcesets ...
! 164: in
! 165: .Pa src .
! 166: .It Sy NetBSD- Ns Ao Em rel Ac Ns Sy - Ns Ao Em machine Ac Ns Sy -install.img.gz
! 167: Bootable installation images intended to be written to any drive which
! 168: appears as an
! 169: .Xr sd 4
! 170: type, such as USB flash disks.
! 171: These images are created with
! 172: .Dq ./build.sh ... install-image
! 173: in
! 174: .Pa src .
1.23 apb 175: .El
176: .
1.22 apb 177: .It Sy shared/
1.23 apb 178: Files shared by two or more machine types.
1.22 apb 179: .Bl -tag -width "\*[Lt]machine_arch\*[Gt]"
1.28 wiz 180: .It Ao Em machine_arch Ac Ns Pa /
1.11 tv 181: Files which may be shared by all systems of the same
1.28 wiz 182: .Aq Em machine_arch
1.11 tv 183: will be located in
1.1 thorpej 184: .Sm off
185: .Xo
186: .Sy .../NetBSD-
1.28 wiz 187: .Aq Em rel
1.11 tv 188: .Sy /shared/
1.28 wiz 189: .Aq Em machine_arch
1.1 thorpej 190: .Sy /
191: .Xc
192: .Sm on
1.11 tv 193: with symbolic links pointing to these files from the
1.28 wiz 194: .Aq Em machine
1.22 apb 195: subdirectory.
196: .It Sy ALL/
197: Files which are completely machine-independent will be
1.11 tv 198: located in
1.28 wiz 199: .Sy .../NetBSD- Ns Ao Em rel Ac Ns Sy /shared/ALL/
1.11 tv 200: with symbolic links pointing to these files from the
1.28 wiz 201: .Aq Em machine
1.11 tv 202: subdirectory.
1.22 apb 203: .El
204: .
205: .It Sy source/
1.31 snj 206: Source code of the operating system should be put into
1.28 wiz 207: .Sy .../NetBSD- Ns Ao Em rel Ac Ns Sy /source/
1.10 hubertf 208: using the following layout:
209: .Pp
1.31 snj 210: .Bl -tag -width "sets/"
1.10 hubertf 211: .It Sy sets/
1.31 snj 212: Sources for the various system sets.
1.10 hubertf 213: .Bl -tag -width "sharesrc.tgz"
214: .It Sy MD5
1.31 snj 215: .It Sy SHA512
1.10 hubertf 216: .It Sy gnusrc.tgz
217: Contains sources for all GPLed and possibly other programs that
218: contains restrictions in their licensing that prevent others from
1.12 wiz 219: using these programs in closed-source environments.
1.10 hubertf 220: .It Sy sharesrc.tgz
221: Contains machine-independent data files that can be shared across
1.12 wiz 222: architectures/systems.
1.10 hubertf 223: .It Sy src.tgz
224: The operating system's userland source code, including all programs,
1.31 snj 225: tools, libraries, etc.
1.10 hubertf 226: .It Sy syssrc.tgz
227: Kernel sources for all architectures plus sources of the tools needed
1.12 wiz 228: to build kernels (like
1.20 peter 229: .Xr config 1 ) .
1.10 hubertf 230: .It Sy xsrc.tgz
1.28 wiz 231: Source code of the X Window System used on all
232: .Nx
233: architectures.
1.12 wiz 234: Includes X clients and servers.
1.10 hubertf 235: .El
236: .El
1.22 apb 237: .
1.28 wiz 238: .It Ao Em machine Ac Ns Pa /
1.18 fredb 239: The binary releases in
1.10 hubertf 240: .Sm off
241: .Xo
242: .Sy .../NetBSD-
1.28 wiz 243: .Aq Em rel
1.10 hubertf 244: .Sy /
1.28 wiz 245: .Aq Em machine
1.10 hubertf 246: .Sy /
247: .Xc
248: .Sm on
1.31 snj 249: fit the following layout:
1.1 thorpej 250: .Bl -tag -width "installation/"
1.7 is 251: .It Sy INSTALL.txt
1.1 thorpej 252: Installation notes, including complete descriptions of files contained
253: within the release hierarchy
1.7 is 254: .It Sy INSTALL.more
1.31 snj 255: pretty version, suited for viewing with
1.12 wiz 256: .Xr more 1
1.7 is 257: .It Sy INSTALL.html
1.31 snj 258: HTML version
1.7 is 259: .It Sy INSTALL.ps
1.31 snj 260: PostScript version
1.1 thorpej 261: .It Sy binary/
262: system binaries
1.31 snj 263: .Bl -tag -width "SHA512/"
1.1 thorpej 264: .It Sy sets/
265: installation sets
1.31 snj 266: .Bl -tag -width "xserver.tgz"
1.1 thorpej 267: .It Sy MD5
1.31 snj 268: .It Sy SHA512
1.1 thorpej 269: .It Sy base.tgz
1.28 wiz 270: The base binary distribution.
271: This set contains the base
1.1 thorpej 272: .Nx
273: utilities that are necessary for the system to run and be minimally
1.28 wiz 274: functional.
275: This set excludes all things listed in the sets
1.1 thorpej 276: described below.
277: .It Sy comp.tgz
1.28 wiz 278: The compiler tools distribution.
279: This set contains the C and C++
1.1 thorpej 280: compilers, assembler, linker, other toolchain components, and their
1.28 wiz 281: manual pages.
282: It also includes the system include files
1.1 thorpej 283: .Pq Pa /usr/include
1.31 snj 284: and the static system libraries.
1.1 thorpej 285: .It Sy etc.tgz
286: This set contains the system configuration files that reside in
287: .Pa /etc
288: and in several other places throughout the file system hierarchy.
289: .It Sy games.tgz
290: This set includes the games and their manual pages.
291: .It Sy kern.tgz
292: This set includes a generic kernel.
293: .It Sy man.tgz
294: This set includes all of the manual pages for the binaries and other
295: software contained in the
296: .Sy base
297: set which are not included in the other sets.
298: .It Sy misc.tgz
1.31 snj 299: This set includes miscellaneous non-essential files, including dictionaries,
300: the typesettable document set, and various other documentation and example
301: configuration files.
1.29 jnemeth 302: .It Sy modules.tgz
303: This set includes all the kernel modules.
1.1 thorpej 304: .It Sy text.tgz
305: This set includes the
306: .Nx
307: text processing tools, including
308: .Xr groff 1 ,
309: all related programs, and their manual pages.
310: .It Sy xbase.tgz
1.31 snj 311: This set includes the base X11 distribution, including manual pages
312: and excluding everything contained in the other X11 sets.
1.1 thorpej 313: .It Sy xcomp.tgz
314: This set includes the X11 include files and static X11 libraries.
315: .It Sy xfont.tgz
316: This set includes the X11 fonts.
317: .It Sy xserver.tgz
1.28 wiz 318: This set includes the X servers and manual pages for
1.31 snj 319: a given machine.
1.1 thorpej 320: .Em "Note: this set may not be available on some platforms" .
321: .El
322: .It Sy kernel/
323: suitably named, gzipped kernels
324: .Bl -tag -width "netbsd-GENERIC.gz"
325: .It Sy MD5
1.31 snj 326: .It Sy SHA512
1.1 thorpej 327: .It Sy netbsd-GENERIC.gz
328: A kernel built from the
329: .Sy GENERIC
1.28 wiz 330: kernel configuration file.
331: This is meant as an example only; different
1.1 thorpej 332: platforms may have differently named kernels.
333: .El
334: .El
335: .It Sy installation/
336: installation helper items
337: .Bl -tag -width "diskimage/"
1.8 hubertf 338: .It Sy cdrom/
1.31 snj 339: CDROM images in ISO 9660 format, created as part of
1.23 apb 340: .Dq build.sh ... release ...
1.18 fredb 341: in
342: .Pa src .
1.23 apb 343: .Pp
1.31 snj 344: Images in this directory are bootable, and contain one a kernel,
345: installation tools, and rescue tools.
346: They do not contain installation sets, source sets, or
1.23 apb 347: other components of a complete release.
1.31 snj 348: .Pp
349: .Em "Note: These images are only present in the amd64 and i386 distributions."
350: .Bl -tag -width "boot-com.iso"
351: .It Sy MD5
352: .It Sy SHA512
353: .It Sy boot.iso
354: VGA console
355: .It Sy boot-com.iso
356: Serial console
1.8 hubertf 357: .El
1.1 thorpej 358: .It Sy diskimage/
1.31 snj 359: disk images, on those platforms that provide them
360: .Bl -tag -width "diskimage.gz"
361: .It Sy MD5
362: .It Sy SHA512
363: .It Sy diskimage.gz
1.1 thorpej 364: .El
365: .It Sy floppy/
1.31 snj 366: floppy images, on those platforms that provide them
367: .Bl -tag -width "boot1.fs"
368: .It Sy MD5
369: .It Sy SHA512
370: .It Sy boot1.fs
371: .It Sy boot2.fs
372: .El
373: .It Sy instkernel/
374: installation kernels for platforms that can boot them directly
375: .Bl -tag -width netbsd.gz
376: .It Sy MD5
377: .It Sy SHA512
378: .It Sy netbsd.gz
1.1 thorpej 379: .El
380: .It Sy miniroot/
1.31 snj 381: miniroot images, on those platforms that provide them
382: .Bl -tag -width "miniroot.fs.gz"
383: .It Sy MD5
384: .It Sy SHA512
385: .It Sy miniroot.fs.gz
1.1 thorpej 386: .El
387: .It Sy misc/
388: miscellaneous installation helper utilities, including boot selectors,
389: floppy writing software, other software that runs under foreign operating
390: systems, etc.
1.31 snj 391: .Bl -tag -width "SHA512"
1.1 thorpej 392: .It Sy MD5
1.31 snj 393: .It Sy SHA512
1.1 thorpej 394: .It Sy ...
395: .El
396: .It Sy netboot/
397: network boot programs
398: .Bl -tag -width "netboot.gz"
399: .It Sy MD5
1.31 snj 400: .It Sy SHA512
1.1 thorpej 401: .It Sy netboot.gz
402: .El
403: .It Sy tapeimage/
1.31 snj 404: tape images, on those platforms that provide them
405: .Bl -tag -width "tapeboot"
406: .It Sy MD5
407: .It Sy SHA512
408: .It Sy tapeboot
1.1 thorpej 409: .El
410: .El
411: .El
1.22 apb 412: .El
1.1 thorpej 413: .Sh SEE ALSO
414: .Xr cksum 1 ,
415: .Xr gzip 1 ,
416: .Xr split 1 ,
417: .Xr tar 1
418: .Sh HISTORY
419: The
420: .Nm
421: manual page first appeared in
422: .Nx 1.3 .
CVSweb <webmaster@jp.NetBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to release.7 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / share / man / man7