[BACK]Return to release.7 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / share / man / man7

Annotation of src/share/man/man7/release.7, Revision 1.32

1.32    ! jmcneill    1: .\"    $NetBSD: release.7,v 1.31 2009/09/19 07:06:55 snj Exp $
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    ! jmcneill   30: .Dd January 14, 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.23      apb       125: .It Sy iso/
                    126: CDROM images in ISO 9660 format, usually created with
                    127: .Dq ./build.sh ... iso-image ...
                    128: after a
1.24      jnemeth   129: .Dq ./build.sh -x ... release ...
                    130: in
                    131: .Pa src
                    132: or created with
                    133: .Dq ./build.sh ... iso-image-source ...
                    134: after a
1.23      apb       135: .Dq ./build.sh -x ... release sourcesets ...
                    136: in
                    137: .Pa src .
                    138: .Pp
                    139: Images in this directory, unlike images in the
                    140: .Sm off
                    141: .Xo
                    142: .Sy .../NetBSD-
1.28      wiz       143: .Aq Em rel
1.23      apb       144: .Sy /
1.28      wiz       145: .Aq Em machine
1.23      apb       146: .Sy /installation/cdrom/
                    147: .Xc
                    148: .Sm on
1.31      snj       149: directory, contain file systems that
1.23      apb       150: have an internal layout that corresponds to
1.31      snj       151: a complete release for a given machine type.
1.24      jnemeth   152: If built with
                    153: .Dq iso-image-source ,
                    154: then it will also contain a
                    155: .Dq source
                    156: directory.
1.23      apb       157: These images are usually bootable.
1.32    ! jmcneill  158: .Bl -tag -width "NetBSD-\*[Lt]rel\*[Gt]-\*[Lt]machine_arch\*[Gt].iso"
1.23      apb       159: .It Sy MD5
1.31      snj       160: .It Sy SHA512
1.32    ! jmcneill  161: .It Sy NetBSD- Ns Ao Em rel Ac Ns Sy - Ns Ao Em machine Ac Ns Sy .iso
1.23      apb       162: .El
                    163: .
1.22      apb       164: .It Sy shared/
1.23      apb       165: Files shared by two or more machine types.
1.22      apb       166: .Bl -tag -width "\*[Lt]machine_arch\*[Gt]"
1.28      wiz       167: .It Ao Em machine_arch Ac Ns Pa /
1.11      tv        168: Files which may be shared by all systems of the same
1.28      wiz       169: .Aq Em machine_arch
1.11      tv        170: will be located in
1.1       thorpej   171: .Sm off
                    172: .Xo
                    173: .Sy .../NetBSD-
1.28      wiz       174: .Aq Em rel
1.11      tv        175: .Sy /shared/
1.28      wiz       176: .Aq Em machine_arch
1.1       thorpej   177: .Sy /
                    178: .Xc
                    179: .Sm on
1.11      tv        180: with symbolic links pointing to these files from the
1.28      wiz       181: .Aq Em machine
1.22      apb       182: subdirectory.
                    183: .It Sy ALL/
                    184: Files which are completely machine-independent will be
1.11      tv        185: located in
1.28      wiz       186: .Sy .../NetBSD- Ns Ao Em rel Ac Ns Sy /shared/ALL/
1.11      tv        187: with symbolic links pointing to these files from the
1.28      wiz       188: .Aq Em machine
1.11      tv        189: subdirectory.
1.22      apb       190: .El
                    191: .
                    192: .It Sy source/
1.31      snj       193: Source code of the operating system should be put into
1.28      wiz       194: .Sy .../NetBSD- Ns Ao Em rel Ac Ns Sy /source/
1.10      hubertf   195: using the following layout:
                    196: .Pp
1.31      snj       197: .Bl -tag -width "sets/"
1.10      hubertf   198: .It Sy sets/
1.31      snj       199: Sources for the various system sets.
1.10      hubertf   200: .Bl -tag -width "sharesrc.tgz"
                    201: .It Sy MD5
1.31      snj       202: .It Sy SHA512
1.10      hubertf   203: .It Sy gnusrc.tgz
                    204: Contains sources for all GPLed and possibly other programs that
                    205: contains restrictions in their licensing that prevent others from
1.12      wiz       206: using these programs in closed-source environments.
1.10      hubertf   207: .It Sy sharesrc.tgz
                    208: Contains machine-independent data files that can be shared across
1.12      wiz       209: architectures/systems.
1.10      hubertf   210: .It Sy src.tgz
                    211: The operating system's userland source code, including all programs,
1.31      snj       212: tools, libraries, etc.
1.10      hubertf   213: .It Sy syssrc.tgz
                    214: Kernel sources for all architectures plus sources of the tools needed
1.12      wiz       215: to build kernels (like
1.20      peter     216: .Xr config 1 ) .
1.10      hubertf   217: .It Sy xsrc.tgz
1.28      wiz       218: Source code of the X Window System used on all
                    219: .Nx
                    220: architectures.
1.12      wiz       221: Includes X clients and servers.
1.10      hubertf   222: .El
                    223: .El
1.22      apb       224: .
1.28      wiz       225: .It Ao Em machine Ac Ns Pa /
1.18      fredb     226: The binary releases in
1.10      hubertf   227: .Sm off
                    228: .Xo
                    229: .Sy .../NetBSD-
1.28      wiz       230: .Aq Em rel
1.10      hubertf   231: .Sy /
1.28      wiz       232: .Aq Em machine
1.10      hubertf   233: .Sy /
                    234: .Xc
                    235: .Sm on
1.31      snj       236: fit the following layout:
1.1       thorpej   237: .Bl -tag -width "installation/"
1.7       is        238: .It Sy INSTALL.txt
1.1       thorpej   239: Installation notes, including complete descriptions of files contained
                    240: within the release hierarchy
1.7       is        241: .It Sy INSTALL.more
1.31      snj       242: pretty version, suited for viewing with
1.12      wiz       243: .Xr more 1
1.7       is        244: .It Sy INSTALL.html
1.31      snj       245: HTML version
1.7       is        246: .It Sy INSTALL.ps
1.31      snj       247: PostScript version
1.1       thorpej   248: .It Sy binary/
                    249: system binaries
1.31      snj       250: .Bl -tag -width "SHA512/"
1.1       thorpej   251: .It Sy sets/
                    252: installation sets
1.31      snj       253: .Bl -tag -width "xserver.tgz"
1.1       thorpej   254: .It Sy MD5
1.31      snj       255: .It Sy SHA512
1.1       thorpej   256: .It Sy base.tgz
1.28      wiz       257: The base binary distribution.
                    258: This set contains the base
1.1       thorpej   259: .Nx
                    260: utilities that are necessary for the system to run and be minimally
1.28      wiz       261: functional.
                    262: This set excludes all things listed in the sets
1.1       thorpej   263: described below.
                    264: .It Sy comp.tgz
1.28      wiz       265: The compiler tools distribution.
                    266: This set contains the C and C++
1.1       thorpej   267: compilers, assembler, linker, other toolchain components, and their
1.28      wiz       268: manual pages.
                    269: It also includes the system include files
1.1       thorpej   270: .Pq Pa /usr/include
1.31      snj       271: and the static system libraries.
1.1       thorpej   272: .It Sy etc.tgz
                    273: This set contains the system configuration files that reside in
                    274: .Pa /etc
                    275: and in several other places throughout the file system hierarchy.
                    276: .It Sy games.tgz
                    277: This set includes the games and their manual pages.
                    278: .It Sy kern.tgz
                    279: This set includes a generic kernel.
                    280: .It Sy man.tgz
                    281: This set includes all of the manual pages for the binaries and other
                    282: software contained in the
                    283: .Sy base
                    284: set which are not included in the other sets.
                    285: .It Sy misc.tgz
1.31      snj       286: This set includes miscellaneous non-essential files, including dictionaries,
                    287: the typesettable document set, and various other documentation and example
                    288: configuration files.
1.29      jnemeth   289: .It Sy modules.tgz
                    290: This set includes all the kernel modules.
1.1       thorpej   291: .It Sy text.tgz
                    292: This set includes the
                    293: .Nx
                    294: text processing tools, including
                    295: .Xr groff 1 ,
                    296: all related programs, and their manual pages.
                    297: .It Sy xbase.tgz
1.31      snj       298: This set includes the base X11 distribution, including manual pages
                    299: and excluding everything contained in the other X11 sets.
1.1       thorpej   300: .It Sy xcomp.tgz
                    301: This set includes the X11 include files and static X11 libraries.
                    302: .It Sy xfont.tgz
                    303: This set includes the X11 fonts.
                    304: .It Sy xserver.tgz
1.28      wiz       305: This set includes the X servers and manual pages for
1.31      snj       306: a given machine.
1.1       thorpej   307: .Em "Note: this set may not be available on some platforms" .
                    308: .El
                    309: .It Sy kernel/
                    310: suitably named, gzipped kernels
                    311: .Bl -tag -width "netbsd-GENERIC.gz"
                    312: .It Sy MD5
1.31      snj       313: .It Sy SHA512
1.1       thorpej   314: .It Sy netbsd-GENERIC.gz
                    315: A kernel built from the
                    316: .Sy GENERIC
1.28      wiz       317: kernel configuration file.
                    318: This is meant as an example only; different
1.1       thorpej   319: platforms may have differently named kernels.
                    320: .El
                    321: .El
                    322: .It Sy installation/
                    323: installation helper items
                    324: .Bl -tag -width "diskimage/"
1.8       hubertf   325: .It Sy cdrom/
1.31      snj       326: CDROM images in ISO 9660 format, created as part of
1.23      apb       327: .Dq build.sh ... release ...
1.18      fredb     328: in
                    329: .Pa src .
1.23      apb       330: .Pp
1.31      snj       331: Images in this directory are bootable, and contain one a kernel,
                    332: installation tools, and rescue tools.
                    333: They do not contain installation sets, source sets, or
1.23      apb       334: other components of a complete release.
1.31      snj       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
                    341: VGA console
                    342: .It Sy boot-com.iso
                    343: Serial console
1.8       hubertf   344: .El
1.1       thorpej   345: .It Sy diskimage/
1.31      snj       346: disk 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
1.1       thorpej   351: .El
                    352: .It Sy floppy/
1.31      snj       353: floppy 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/
                    361: installation 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
1.1       thorpej   366: .El
                    367: .It Sy miniroot/
1.31      snj       368: miniroot 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
1.1       thorpej   373: .El
                    374: .It Sy misc/
                    375: miscellaneous installation helper utilities, including boot selectors,
                    376: floppy writing software, other software that runs under foreign operating
                    377: systems, etc.
1.31      snj       378: .Bl -tag -width "SHA512"
1.1       thorpej   379: .It Sy MD5
1.31      snj       380: .It Sy SHA512
1.1       thorpej   381: .It Sy ...
                    382: .El
                    383: .It Sy netboot/
                    384: network boot programs
                    385: .Bl -tag -width "netboot.gz"
                    386: .It Sy MD5
1.31      snj       387: .It Sy SHA512
1.1       thorpej   388: .It Sy netboot.gz
                    389: .El
                    390: .It Sy tapeimage/
1.31      snj       391: tape images, on those platforms that provide them
                    392: .Bl -tag -width "tapeboot"
                    393: .It Sy MD5
                    394: .It Sy SHA512
                    395: .It Sy tapeboot
1.1       thorpej   396: .El
                    397: .El
                    398: .El
1.22      apb       399: .El
1.1       thorpej   400: .Sh SEE ALSO
                    401: .Xr cksum 1 ,
                    402: .Xr gzip 1 ,
                    403: .Xr split 1 ,
                    404: .Xr tar 1
                    405: .Sh HISTORY
                    406: The
                    407: .Nm
                    408: manual page first appeared in
                    409: .Nx 1.3 .

CVSweb <webmaster@jp.NetBSD.org>