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