xref: /netbsd-src/distrib/notes/common/main (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1.\"	$NetBSD: main,v 1.563 2020/07/26 11:05:39 jmcneill Exp $
2.\"
3.\" Copyright (c) 1999-2012 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.ig
28
29	To "regenerate" this file, go up one level to src/distrib/notes
30	and type "make".  This will create
31	src/distrib/notes/<arch>/INSTALL.*.
32
33	We keep most of the notes the same on HEAD and release branches,
34	but some of this are not appropriate for HEAD/current. Also
35	some locations differ for actual release, so we distinguish
36	between:
37
38	RELEASE_BRANCH == 1
39		this is on a release branch (not -current)
40	RELEASE_BRANCH == 0
41		this is current, not yet branched
42	FOR_RELEASE == 1
43		this is an official release (will be signed and placed
44		on ftp/cdn)
45	FOR_RELEASE == 0
46		this is a local build or a "daily" build on the build
47		cluster
48..
49.
50.tm Processing INSTALL
51.
52.\"	--------------------  CONFIGURATION  --------------------
53.
54.nr oldvers ( \n[major] - 1 )
55.ie \n[FOR_RELEASE] \{\
56.ds RELEASE_URL https://cdn.NetBSD.org/pub/NetBSD/NetBSD-\*V
57.\}
58.el \{\
59.ie \n[RELEASE_BRANCH] \{\
60.ds ftppath netbsd-\n[major]
61.\} \" \n[RELEASE_BRANCH]
62.el .ds ftppath HEAD
63.ds RELEASE_URL https://nycdn.NetBSD.org/pub/NetBSD-daily/\*[ftppath]/latest
64.\} \" !\n[FOR_RELEASE]
65.nr DOC_XR 1
66.ds MACHINE_LIST acorn32 algor alpha amd64 amiga amigappc arc atari
67.as MACHINE_LIST " bebox cats cesfic cobalt dreamcast emips evbarm evbmips
68.as MACHINE_LIST " evbppc evbsh3 ews4800mips hp300 hppa hpcarm hpcmips hpcsh
69.as MACHINE_LIST " i386 ibmnws iyonix landisk luna68k mac68k macppc mipsco
70.as MACHINE_LIST " mmeye mvme68k mvmeppc netwinder news68k newsmips next68k
71.as MACHINE_LIST " ofppc playstation2 pmax prep rs6000 sandpoint sbmips
72.as MACHINE_LIST " sgimips shark sparc sparc64 sun2 sun3 vax x68k zaurus .
73.so \*[.CURDIR]/../common/macros
74.
75.\" Override <title> for HTML output
76.if rHTML .ds title-section Installation procedure for NetBSD/\*M \*V
77.Dd \*[cur_date]
78.Dt INSTALL 8
79.Os NetBSD/\*M \*V
80.Sh NAME
81.Nm INSTALL
82.Nd Installation procedure for
83.Nx*M .
84.Sh CONTENTS
85.Tc
86.Sh DESCRIPTION
87.
88.Ss About this Document
89.Pp
90.
91This document describes the installation procedure for
92.Nx
93\*V on the
94.Em \*M
95platform.
96It is available in four different formats titled
97.Pa INSTALL. Ns Ar ext ,
98where
99.Ar \&.ext
100is one of
101.Pa \&.ps , \&.html , \&.more ,
102.No or Pa \&.txt :
103.(tag \&.morex -offset indent
104.It Pa \&.ps
105PostScript.
106.It Pa \&.html
107.No Standard Internet Tn HTML .
108.It Pa \&.more
109The enhanced text format used on
110.Ul
111systems by the
112.Xr more 1
113and
114.Xr less 1
115pager utility programs.
116This is the format in which the on-line
117.Em man
118pages are generally presented.
119.It Pa \&.txt
120Plain old
121.Tn ASCII .
122.tag)
123.Pp
124You are reading the
125.Em \*[format]
126version.
127.
128.if \n[i386]:\n[macppc]:\n[sparc]:\n[sparc64]:\n[amd64] \{\
129.Ss "Quick install notes for the impatient"
130.Pp
131This section contains some brief notes describing what you need to
132install
133.Nx
134\*V on a machine of the \*M architecture.
135.Bl -bullet
136.It
137Fetch files needed to install
138.Nx .
139.if \n[i386]:\n[amd64] \{\
140.Pp
141Option 1: bootable CD-ROM images or USB images containing the
142full distribution.
143.Pp
144These can be found
145on an FTP site near you, usually located in the
146.Pa /pub/NetBSD/images/
147directory.
148Check the list of
149.Nx
150.Lk https://www.NetBSD.org/mirrors mirrors
151for details.
152.Pp
153Option 2: bootable CD-ROM images from
154.Pa \*M/installation/cdrom/ .
155.Pp
156These images are bootable, but do not contain binary sets.
157They are intended for network installs or system repair.
158.Pa boot.iso
159is for VGA console installation, and
160.Pa boot-com.iso
161is for installation over serial console (com0, 9600 baud).
162.Pp
163.\} \" amd64:i386
164.if \n[i386] \{\
165Option 3: boot floppy images from
166.Pa \*M/installation/floppy/ .
167.Pp
168.Pa boot1.fs
169and
170.Pa boot2.fs
171are floppy images for VGA console installation.
172.Pa boot-com1.fs
173and
174.Pa boot-com2.fs
175are for installation via serial console (com0, 9600 baud).
176.\} \" i386
177.if \n[i386]:\n[amd64] \{\
178.It
179The default kernel on CD-ROMs has ACPI enabled.
180This is known to cause issues on a few machines which have buggy ACPI
181implementations.
182.Pp
183To boot with ACPI disabled, interrupt the menu and enter the
184.Nx
185boot prompt.
186Type
187.Ic boot -2
188to boot with ACPI disabled.
189.\} \" amd64:i386
190.if \n[macppc] \{\
191The files depend on which model you
192are using and how you plan to boot your machine.
193For systems with built-in floppy drives (Open Firmware 1 or 2),
194fetch the pair of boot floppy images
195.Pa macppc/installation/floppy/boot1.fs
196and
197.Pa macppc/installation/floppy/boot2.fs ,
198which include the bootloader and installation kernel.
199For systems without floppy drives (most are Open Firmware 3), fetch the
200bootloader
201.Pa macppc/installation/ofwboot.xcf
202and the installation kernel
203.Pa macppc/binary/kernel/netbsd-GENERIC_MD.gz .
204If you have a CD-R, you can fetch the CD image,
205.Pa NetBSD-\*V-macppc.iso .
206.\}
207.if \n[sparc] \{\
208Fetch a CD image,
209.Pa NetBSD-\*V-sparc.iso
210or the floppy disk images,
211.Pa sparc/install/floppy/disk1.gz No and Pa sparc/install/floppy/disk2 .
212You need either the pair of floppies or the CD to boot your system.
213.\}
214.if \n[sparc64] \{\
215This is either a CD image
216.Pq Pa NetBSD-\*V-sparc64.iso
217which can be booted directly, or the installation kernel and bootloader
218.Pq Pa sparc64/binary/kernel/netbsd-INSTALL.gz No and Pa sparc64/installation/misc/ofwboot
219which can be booted from a
220.Tn Solaris
221or
222.Nx
223partition.
224.\}
225.if \n[macppc]:\n[sparc]:\n[sparc64] \{\
226Alternatively, you may netboot the installation kernel.  This process is
227covered below, in detail.
228.\}
229.It
230The actual binary distribution is in the
231.Pa \*M/binary/sets/
232directory.
233When you boot the install
234.if \n[amd64] image or CD-ROM,
235.if \n[i386] image, CD-ROM or floppies,
236.if \n[macppc] kernel from floppies, hard drive, or CD-ROM,
237.if \n[sparc] floppies or CD-ROM,
238.if \n[sparc64] CD-ROM or installation kernel,
239the installation program
240can fetch these files for you (using, e.g., ftp)
241if you have a network connection.
242There are several other methods to get the binary sets onto
243your machine.
244.Pp
245You will at a minimum need
246.ie \n[i386]:\n[amd64] \{\
247one of the kernel sets, typically
248.Pa kern-GENERIC.\*[setsuffix] ,
249as well as
250.\}
251.el \{\
252the following sets:
253.Pa kern-GENERIC.\*[setsuffix] ,
254.\}
255.Pa base.\*[setsuffix]
256and
257.Pa etc.\*[setsuffix] .
258In a typical workstation installation you will probably want
259all the installation sets.
260.ie \n[i386]:\n[amd64] \{\
261.It
262Write the boot images
263.Pp
264Many commercial and freeware programs are available to burn CD-ROMs.
265.Pp
266If installing via USB, you must first uncompress the USB image, which
267is gzipped.
268.Dl $ Ic "gunzip NetBSD-\*V-\*M-install.img.gz"
269Next, write the USB image to a USB stick/drive.
270Note that this will overwrite any existing data on the device that you
271specify, so double check the device before running!
272On
273.Ul
274operating systems, use a command similar to the following,
275replacing
276.Pa /dev/rsd0d
277with the appropriate device for your system:
278.Dl # Ic "dd if=NetBSD-\*V-\*M-install.img of=/dev/rsd0d bs=32k"
279On Windows, you will need to use a program such as
280.Lk http://sourceforge.net/projects/win32diskimager/ "Win32 Disk Imager" ,
281or
282.Lk https://www.NetBSD.org/~martin/rawrite32 Rawrite32 .
283.if \n[amd64]:\n[i386] \{\
284If you have problems writing a raw image to a floppy,
285the
286.Ic rawrite.exe
287MS-DOS program
288in the
289.Pa \*M/installation/misc/
290directory may be of help.
291.\}
292.\}
293.if \n[macppc] \{\
294.It
295If your \*M has a floppy drive, create the pair of boot floppies using
296.Ic suntar
297(MacOS 9),
298.Ic rawrite
299(Windows), or
300.Ic dd
301(any
302.Ul
303system with floppy support).  If your system has Open Firmware 3, drag
304.Pa ofwboot.xcf No and Pa netbsd-GENERIC_MD.gz
305to your hard drive icon (the top level of the drive, not the desktop).
306If you are using the CD image, burn it now.
307.\}
308.if \n[sparc] \{\
309.It
310Make sure your sparc's CD-ROM drive is bootable.
311Burn the CD.
312Otherwise, write the floppy images directly to a pair of floppies
313(after uncompressing disk1.gz).
314.\}
315.if \n[sparc64] \{\
316.It
317Burn the CD or put the installation kernel and bootloader
318at the root level of a bootable
319.Tn Solaris
320or
321.Nx
322partition.
323.\}
324.Pp
325The media you just prepared will be used to boot the installation
326kernel, which contains all the tools required to install
327.Nx .
328.if \n[macppc] \{\
329.It
330Determine your machine's model, quirks, and Open Firmware version from the
331.Nx*M
332.Lk https://www.NetBSD.org/ports/macppc/models.html "Model Support webpage" .
333.Pp
334At present,
335.Nx*M
336cannot exist on the same hard drive as
337.Tn Mac OS
338unless you partition your disk before running the installer.
339Open Firmware versions prior to 3 require a dedicated
340.Nx
341drive \(em you must use the entire disk,
342partitioned with the installation tools.
343Open Firmware version 3 cannot boot into
344.Nx
345on a drive partitioned with the installation tools, you must partition
346your disk before running the installer, then select the
347.Dq Me "Re-install sets or install additional sets"
348option in the installer (selecting the
349.Dq Me "Install NetBSD to hard disk"
350or
351.Dq Me "Upgrade NetBSD on a hard disk"
352options will render your drive unbootable).
353If you are unsure, you may want to read the section below on
354.Sx Partitioning your hard drive for NetBSD
355.It
356For systems with Open Firmware versions prior to 3, you may need to use
357Apple's System Disk utility to enter Open Firmware and use your screen and
358keyboard.
359To enter Open Firmware, hold down the
360.Key COMMAND-OPTION-O-F
361keys after the boot chime starts, but before the chime ends.
362Entering Open Firmware versions prior to 3 is usually the most frustrating
363part of installation \(em you may want to read the section below on
364.Sx Older Open Firmware System Preparation
365.Pp
366You should have the Open Firmware
367.Dq Pa "0 \*[Gt]"
368prompt on your screen before attempting to boot
369.Nx*M .
370.\}
371.if \n[macppc] \{\
372.It
373At the Open Firmware prompt, type the command to boot.
374To boot from the installation floppies, the command is
375.Dq Ic "boot fd:0" .
376For the install kernel and bootloader on your hard drive (Open Firmware
3773), the command is
378.Dq Ic "boot hd:,\eofwboot.xcf netbsd-GENERIC_MD.gz" .
379.Pp
380For boot CDs, the command is something like
381.Dq Ic "boot cd:,\eofwboot.xcf netbsd.macppc"
382(for Open Firmware 3) or
383.Dq Ic "boot scsi-int/sd@3:0 NETBSD.MACPPC"
384(for earlier Open Firmware versions).
385You will need to use the correct case for
386.Ic OFWBOOT.XCF No and Ic NETBSD.MACPPC
387depending on how your version of Open Firmware interprets the ISO
388file system.
389You may need to replace
390.Ic cd
391with
392.Ic "scsi/sd@3 , scsi-int/sd@3 , ata/atapi-disk ,"
393or some other device alias.
394You should also use the Open Firmware
395.Ic dir
396command to confirm that the
397.Nx*M
398kernel is called
399.Pa NETBSD.MACPPC .
400You may want to read the section below on
401.Sx Open Firmware boot syntax
402.\}
403.if \n[macppc] \{\
404.It
405.Pp
406PowerPC 601 machines need to use separate boot floppies
407.Pa macppc/installation/floppy/boot601_1.fs
408and
409.Pa macppc/installation/floppy/boot602_2.fs ,
410a different kernel set
411.Pa kern-GENERIC_601.\*[setsuffix] ,
412and a different install kernel
413.Pa netbsd-INSTALL_601.gz .
414The same boot CD can be used but at the boot prompt you must specify
415the 601 kernel, i.e., replace
416.Ic netbsd.macppc
417with
418.Ic netbsd.601
419.
420.\}
421.if \n[sparc]:\n[sparc64] \{\
422.It
423You will need to get to the
424.if \n[sparc] OpenBoot PROM
425.if \n[sparc64] OpenFirmware
426.Dq Ic "ok"
427prompt.
428After your system first powers on and displays some initial information,
429press the
430.Key STOP-A
431keys, or send a BREAK if you're on a serial console.
432At the
433.Dq Ic "ok"
434prompt, type the command to boot your system into
435.Nx .
436.\}
437.if \n[sparc] \{\
438The command to boot from CD is one of the following commands (depending on
439your model):
440.Dq Ic b sd(,30,) ,
441.Dq Ic boot sd(,30,) ,
442or
443.Dq Ic boot cdrom .
444.Pp
445The command to boot from floppy is either
446.Dq Ic boot fd(,,1)
447or
448.Dq Ic boot floppy .
449The installer will prompt you to insert the second floppy when it is ready
450for it.
451.\}
452.if \n[sparc64] \{\
453The command to boot from CD is:
454.Dq Ic boot cdrom .
455The command to boot the
456.Nx
457kernel from a
458.Tn Solaris
459or
460.Nx
461partition depends on which disk and partition it is on.
462To boot from the first partition of the first (primary) disk:
463.Dq Ic "boot disk:a /ofwboot -a" .
464When it asks you for a kernel, specify
465.Dq Ic "netbsd-INSTALL.gz"
466.\}
467.It
468For third-party programs which are not part of the base
469.Nx
470distribution, you will want to explore the
471.Ic pkgsrc
472package management system, which contains thousands of third party software
473applications.
474.El
475.\}
476.Ss "What is NetBSD?"
477.Pp
478.
479The
480.Nx
481Operating System is a fully functional
482.Tn Open Source
483.Ul
484operating system derived from the University of California, Berkeley
485Networking Release 2 (Net/2), 4.4BSD-Lite, and 4.4BSD-Lite2 sources.
486.Nx
487runs on many different different system architectures (ports)
488across a variety of distinct CPU families, and is being ported to more.
489The
490.Nx
491\*V release contains complete binary releases for most of these
492system architectures, with preliminary support for the others included in
493source form.
494Please see the
495.Nx
496.Lk https://www.NetBSD.org/ website
497for information on them.
498.Pp
499.Nx
500is a completely integrated system.
501In addition to its highly portable, high performance kernel,
502.nh
503.Nx
504features a complete set of user utilities, compilers for several
505languages, the X Window System, firewall software
506and numerous other tools, all accompanied by full source code.
507.Pp
508.\" XXX Should we include some text here about NetBSD's license
509.\" policies and how commercial-friendly it is?
510.Nx
511is a creation of the members of the Internet community.
512Without the unique cooperation and coordination the net makes
513possible,
514.Nx
515would not exist.
516.
517.ie \n[RELEASE_BRANCH] .Ss Changes Between The NetBSD \n[oldvers] \
518and \n[major] Releases
519.el .Ss Changes Between The NetBSD \n[oldvers] and \
520\n[major] Releases, and newer
521.Pp
522The
523.Nx
524\*V release
525provides many significant changes, including support for many new
526devices, hundreds of bug fixes, new and updated kernel subsystems, and
527numerous userland enhancements.
528The result of these improvements is a stable operating system fit for
529production use that rivals most commercially available systems.
530.Pp
531.if !\n[RELEASE_BRANCH] \{ \
532Please note that this build is a development snapshot, not a formal release.
533You are testing the bleeding edge of
534.Nx
535development, and no formal or informal testing may have been done for
536this snapshot (yet).
537.Pp
538.\} \" !\n[RELEASE_BRANCH] \{
539It is impossible to completely summarize the massive development that
540went into the
541.Nx
542\*V release.
543.ie \n[RELEASE_BRANCH] \{\
544The complete list of changes can be found in the following files:
545.br
546.Lk "\*[RELEASE_URL]/CHANGES" CHANGES
547.de showdotchanges
548.  nr ominor (\\$1-1)
549.  if \\n[ominor] .showdotchanges \\n[ominor]
550.  nr ominor (\\$1-1)
551.  br
552.  Lk "\*[RELEASE_URL]/CHANGES-\n[major].\\$1" "CHANGES-\\n[major].\\$1"
553..
554.showdotchanges \n[minor]
555.if (\n[nextminor] > \n[minor]) \{\
556.  br
557.  Lk "\*[RELEASE_URL]/CHANGES-\n[major].\n[nextminor]" "CHANGES-\\n[major].\n[nextminor]"
558.\}
559.br
560files in the top level directory of the NetBSD \n[major].\n[minor] release tree.
561.Pp
562.
563.\} \" \n[RELEASE_BRANCH]
564.el \{\
565The complete list of changes can be found in the following files:
566.br
567.Lk \*[RELEASE_URL]/CHANGES CHANGES
568.br
569.Lk \*[RELEASE_URL]/CHANGES.prev CHANGES.prev
570.\} \" !\n[RELEASE_BRANCH]
571.
572.Ss "Features to be removed in a later release"
573The following features are to be removed from
574.Nx
575in the future:
576.(bullet
577.Xr groff 1 .
578Man pages are now handled with
579.Xr mandoc 1 ,
580and
581.Xr groff 1
582can still be found in pkgsrc as
583.Pa textproc/groff .
584.
585.bullet)
586.Ss "The NetBSD Foundation"
587.Pp
588.
589The
590.Nx
591Foundation is a tax exempt, not-for-profit 501(c)(3) corporation
592that devotes itself to the traditional goals and Spirit of the
593.Nx
594Project and owns the trademark of the word
595.Dq NetBSD .
596It supports the design, development, and adoption of
597.Nx
598worldwide.
599More information on the
600.Nx
601Foundation, its composition, aims, and work can be found at:
602.Lk https://www.NetBSD.org/foundation/
603.br_ne 10P
604.
605.Ss "Sources of NetBSD"
606.Pp
607.
608Refer to
609.Lk https://www.NetBSD.org/mirrors/ mirrors
610.br_ne 10P
611.
612.Ss "NetBSD \*V Release Contents
613.Pp
614.
615The root directory of the
616.Nx
617\*V release is organized as follows:
618.Pp
619.Pa .../NetBSD-\*V/
620.(tag README.files
621.It Li CHANGES
622.ie \n[RELEASE_BRANCH] Changes between the \n[oldvers].0 and \
623\n[major].0 releases.
624.el Changes after the netbsd-\n[major] branch.
625.if \n[RELEASE_BRANCH] \{\
626.It Li CHANGES-\\n[major].0
627Changes between the initial \n[major].0 branch and final release of \n[major].0.
628.de showdotchanges
629.  nr ominor (\\$1-1)
630.  if \\n[ominor] .showdotchanges \\n[ominor]
631.  nr ominor (\\$1-1)
632.  It Li CHANGES-\\n[major].\\$1
633Changes between the \n[major].\\n[ominor] and the \n[major].\\$1 release.
634..
635.if \n[minor] .showdotchanges \n[minor]
636.if (\n[nextminor] > \n[minor]) \{\
637.It Li CHANGES-\\n[major].\n[nextminor]
638Changes after the release of \n[major].\n[minor].
639.\} \" \n[nextminor] > \n[minor]
640.\} \" \n[RELEASE_BRANCH]
641.It Li CHANGES.prev
642Changes in previous
643.Nx
644releases.
645.ie \n[FOR_RELEASE] \{\
646.It Li LAST_MINUTE
647Last minute changes and notes about the release.
648.\} \" \n[FOR_RELEASE]
649.It Li README.files
650README describing the distribution's contents.
651.It Pa images/
652Images (ISO 9660 or USB) for installing NetBSD.
653Depending on your system, these may be bootable.
654.It Pa source/
655Source distribution sets; see below.
656.tag)
657.Pp
658In addition to the files and directories listed above, there is one
659directory per architecture, for each of the architectures for which
660.Nx
661\*V has a binary distribution.
662.Pp
663The source distribution sets can be found in subdirectories of the
664.Pa source
665subdirectory of the distribution tree.
666They contain the complete sources to the system.
667The source distribution sets are as follows:
668.(tag sharesrc
669.It Sy gnusrc
670This set contains the
671.Dq gnu
672sources, including the source for the compiler, assembler, groff,
673and the other GNU utilities in the binary distribution sets.
674.It Sy sharesrc
675This set contains the
676.Dq share
677sources, which include the sources for the man pages not associated
678with any particular program; the sources for the typesettable document
679set; the dictionaries; and more.
680.It Sy src
681This set contains all of the base
682.Nx
683\*V sources which are not in
684.Sy gnusrc ,
685.Sy sharesrc ,
686or
687.Sy syssrc .
688.It Sy syssrc
689This set contains the sources to the
690.Nx
691\*V kernel for all architectures as well as the
692.Xr config 1
693utility.
694.It Sy xsrc
695This set contains the sources to the X Window System.
696.tag)
697.Pp
698All the above source sets are located in the
699.Pa source/sets
700subdirectory of the distribution tree.
701.Pp
702The source sets are distributed as compressed tar files.
703Except for the
704.Sy pkgsrc
705set, which is traditionally unpacked into
706.Pa /usr/pkgsrc ,
707all sets may be unpacked into
708.Pa /usr/src
709with the command:
710.Dl # Ic "cd / ; tar -zxpf set_name.\*[setsuffix]"
711.Pp
712In each of the source distribution set directories, there are
713files which contain the checksums of the files in the directory:
714.(tag SHA512 -offset indent
715.It Li MD5
716.Tn MD5
717digests in the format produced by the command:
718.br
719.Ic cksum -a MD5 Ar file .
720.It Li SHA512
721.Tn SHA512
722digests in the format produced by the command:
723.br
724.Ic cksum -a SHA512 Ar file .
725.tag)
726.Pp
727The SHA512 digest is safer, but MD5 checksums are provided so that a wider
728range of operating systems can check the integrity of the release files.
729.
730.so contents -----------------------------------------------
731.
732.
733.(Note
734Each directory in the \*M binary distribution also has its
735own checksum files, just as the source distribution does.
736.Note)
737.br_ne 7P
738.
739.Ss "NetBSD/\*M System Requirements and Supported Devices"
740.
741.so hardware -----------------------------------------------
742.br_ne 7P
743.
744.Ss "Getting the NetBSD System on to Useful Media"
745.
746.so xfer -----------------------------------------------
747.br_ne 7P
748.
749.Ss "Preparing your System for NetBSD installation"
750.
751.so prep -----------------------------------------------
752.br_ne 7P
753.
754.ie \n[mac68k] .Ss "Installing the NetBSD System (Sysinst Method)"
755.el .Ss "Installing the NetBSD System"
756.
757.so install -----------------------------------------------
758.br_ne 7P
759.
760.Ss "Post installation steps"
761.
762.so ../common/postinstall -----------------------------------------------
763.br_ne 7P
764.
765.Ss "Upgrading a previously-installed NetBSD System"
766.
767.so upgrade -----------------------------------------------
768.br_ne 7P
769.
770.Ss "Compatibility Issues With Previous NetBSD Releases"
771.Pp
772.
773Users upgrading from previous versions of
774.Nx
775may wish to bear the
776following problems and compatibility issues in mind when upgrading to
777.Nx
778\*V.
779.Pp
780Note that
781.Ic sysinst
782will automatically invoke
783.(disp
784postinstall fix
785.disp)
786and thus all issues that are fixed by
787.Ic postinstall
788by default will be handled.
789.Pp
790A number of things have been removed from the
791.Nx
792\*V release.
793See the
794.Dq Components removed from NetBSD
795section near the beginning of this document for a list.
796.Ss "Using online NetBSD documentation"
797.Pp
798Documentation is available if you installed the manual
799distribution set.
800Traditionally, the
801.Dq man pages
802(documentation) are denoted by
803.Sq Li name(section) .
804Some examples of this are
805.Pp
806.(bullet -compact -offset indent
807.Xr intro 1 ,
808.It
809.Xr man 1 ,
810.It
811.Xr apropos 1 ,
812.It
813.Xr passwd 1 ,
814and
815.It
816.Xr passwd 5 .
817.bullet)
818.Pp
819The section numbers group the topics into several categories, but three
820are of primary interest: user commands are in section 1, file formats
821are in section 5, and administrative information is in section 8.
822.Pp
823.No The Em man
824command is used to view the documentation on a topic, and is
825started by entering
826.Ic man
827.Op Ar section
828.Ar topic .
829The brackets
830.Op \&
831around the
832section should not be entered, but rather indicate that the section is
833optional.
834If you don't ask for a particular section, the topic with the
835lowest numbered section name will be displayed.
836For instance, after logging in, enter
837.Pp
838.Dl # Ic "man passwd"
839.Pp
840to read the documentation for
841.Xr passwd 1 .
842To view the documentation for
843.Xr passwd 5 ,
844enter
845.Pp
846.Dl # Ic "man 5 passwd"
847.Pp
848instead.
849.Pp
850If you are unsure of what man page you are looking for, enter
851.Pp
852.Dl # Ic apropos Ar subject-word
853.Pp
854where
855.Ar subject-word
856is your topic of interest; a list of possibly
857related man pages will be displayed.
858.
859.Ss Administrivia
860.Pp
861.
862If you've got something to say, do so!
863We'd like your input.
864There are various mailing lists available via the mailing list
865server at
866.Mt majordomo@NetBSD.org .
867See
868.Lk https://www.NetBSD.org/mailinglists/
869for details.
870.Pp
871There are various mailing lists set up to deal with comments and
872questions about this release.
873Please send comments to:
874.Mt netbsd-comments@NetBSD.org .
875.Pp
876To report bugs, use the
877.Xr send-pr 1
878command shipped with
879.Nx ,
880and fill in as much information about the problem as you can.
881Good bug reports include lots of details.
882.Pp
883Bugs also can be submitted and queried with the web interface at
884.Lk https://www.NetBSD.org/support/send-pr.html
885.Pp
886There are also port-specific mailing lists, to discuss aspects of
887each port of
888.Nx .
889Use majordomo to find their addresses, or visit
890.Lk https://www.NetBSD.org/mailinglists/
891.Pp
892If
893you're interested in doing a serious amount of work on a specific
894port, you probably should contact the
895.Sq owner
896of that port (listed
897below).
898.Pp
899If you'd like to help with
900.Nx ,
901and have an idea as to how you could be useful, send us mail or subscribe to:
902.Mt netbsd-users@NetBSD.org .
903.Pp
904As a favor, please avoid mailing huge documents or files to these
905mailing lists.
906Instead, put the material you would have sent up for FTP or WWW somewhere,
907then mail the appropriate list about it.
908If you'd rather not do that, mail the list saying you'll send the data to
909those who want it.
910.
911.Ss Thanks go to
912.
913.(bullet
914The former members of UCB's Computer Systems Research Group,
915including (but not limited to):
916.Bd -unfilled -offset indent
917Keith Bostic
918Ralph Campbell
919Mike Karels
920Marshall Kirk McKusick
921.Ed
922.Pp
923for their work on
924.Bx
925systems, support, and encouragement.
926.It
927The Internet Systems Consortium, Inc. for hosting the
928.Nx
929FTP, CVS, AnonCVS, mail, mail archive, GNATS, SUP, Rsync and WWW servers.
930.It
931The Internet Research Institute in Japan for hosting the server
932which runs the CVSweb interface to the
933.Nx
934source tree.
935.It
936The Columbia University Computer Science Department for hosting
937the build cluster.
938.It
939The many organizations that provide
940.Nx
941mirror sites.
942.It
943Without CVS, this project would be impossible to manage, so our hats
944go off to Brian Berliner, Jeff Polk, and the various other people
945who've had a hand in making CVS a useful tool.
946.It
947We list the individuals and organizations
948that have made donations or loans of hardware and/or money, to support
949.Nx
950development, and deserve credit for it at
951.Lk https://www.NetBSD.org/donations/
952(If you're not on that list and should be, tell us!
953We probably were not able to get in touch with you, to verify that you
954wanted to be listed.)
955.It
956Finally, we thank all of the people who've put sweat and tears into
957developing
958.Nx
959since its inception in January, 1993.
960(Obviously, there are a lot more people who deserve thanks here.
961If you're one of them, and would like to be mentioned, tell us!)
962.bullet)
963.
964.Ss "Legal Mumbo-Jumbo"
965.Pp
966.
967All product names mentioned herein are trademarks or registered
968trademarks of their respective owners.
969.Pp
970The following notices are required to satisfy the license terms of
971the software that we have mentioned in this document:
972.Pp
973.nr save_size \n[.s]
974.nr save_vs \n[.v]
975.ps 8
976.vs 9
977.Ht <font size=-1>
978.(item -compact
979.so ../common/legal.common -----------------------------------------------
980.item)
981.Ht </font>
982.ps
983.vs
984.Ss "The End"
985