xref: /netbsd-src/distrib/notes/common/main (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1.\"	$NetBSD: main,v 1.570 2022/12/16 16:58:14 martin 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 .
210You need the CD to boot your system.
211.\}
212.if \n[sparc64] \{\
213This is either a CD image
214.Pq Pa NetBSD-\*V-sparc64.iso
215which can be booted directly, or the installation kernel and bootloader
216.Pq Pa sparc64/binary/kernel/netbsd-INSTALL.gz No and Pa sparc64/installation/misc/ofwboot
217which can be booted from a
218.Tn Solaris
219or
220.Nx
221partition.
222.\}
223.if \n[macppc]:\n[sparc]:\n[sparc64] \{\
224Alternatively, you may netboot the installation kernel.  This process is
225covered below, in detail.
226.\}
227.It
228The actual binary distribution is in the
229.Pa \*M/binary/sets/
230directory.
231When you boot the install
232.if \n[amd64] image or CD-ROM,
233.if \n[i386] image, CD-ROM or floppies,
234.if \n[macppc] kernel from floppies, hard drive, or CD-ROM,
235.if \n[sparc] CD-ROM,
236.if \n[sparc64] CD-ROM or installation kernel,
237the installation program
238can fetch these files for you (using, e.g., ftp)
239if you have a network connection.
240There are several other methods to get the binary sets onto
241your machine.
242.Pp
243You will at a minimum need
244.ie \n[i386]:\n[amd64] \{\
245one of the kernel sets, typically
246.Pa kern-GENERIC.\*[setsuffix] ,
247as well as
248.\}
249.el \{\
250the following sets:
251.Pa kern-GENERIC.\*[setsuffix] ,
252.\}
253.Pa base.\*[setsuffix]
254and
255.Pa etc.\*[setsuffix] .
256In a typical workstation installation you will probably want
257all the installation sets.
258.if \n[i386]:\n[amd64] \{\
259.It
260Write the boot images
261.Pp
262Many commercial and freeware programs are available to burn CD-ROMs.
263.Pp
264If installing via USB, you must first uncompress the USB image, which
265is gzipped.
266.if \n[amd64] \{\
267Note the \*M architecture has two images, NetBSD-\*V-\*M-install.img.gz
268and NetBSD-\*V-\*M-bios-install.img.gz. The latter is intended for older
269hardware which is unable to boot using a hybrid MBR and GPT image.
270.\}
271.Dl $ Ic "gunzip NetBSD-\*V-\*M-install.img.gz"
272Next, write the USB image to a USB stick/drive.
273Note that this will overwrite any existing data on the device that you
274specify, so double check the device before running!
275On
276.Ul
277operating systems, use a command similar to the following,
278replacing
279.Pa /dev/rsd0d
280with the appropriate device for your system:
281.Dl # Ic "dd if=NetBSD-\*V-\*M-install.img of=/dev/rsd0d bs=32k"
282On Windows, you will need to use a program such as
283.Lk http://sourceforge.net/projects/win32diskimager/ "Win32 Disk Imager" ,
284or
285.Lk https://www.NetBSD.org/~martin/rawrite32 Rawrite32 .
286If you have problems writing a raw image to a floppy,
287the
288.Ic rawrite.exe
289MS-DOS program
290in the
291.Pa \*M/installation/misc/
292directory may be of help.
293.\}
294.if \n[macppc] \{\
295.It
296If your \*M has a floppy drive, create the pair of boot floppies using
297.Ic suntar
298(MacOS 9),
299.Ic rawrite
300(Windows), or
301.Ic dd
302(any
303.Ul
304system with floppy support).  If your system has Open Firmware 3, drag
305.Pa ofwboot.xcf No and Pa netbsd-GENERIC_MD.gz
306to your hard drive icon (the top level of the drive, not the desktop).
307If you are using the CD image, burn it now.
308.\}
309.if \n[sparc] \{\
310.It
311Make sure your sparc's CD-ROM drive is bootable.
312Burn the CD.
313.\}
314.if \n[sparc64] \{\
315.It
316Burn the CD or put the installation kernel and bootloader
317at the root level of a bootable
318.Tn Solaris
319or
320.Nx
321partition.
322.\}
323.Pp
324The media you just prepared will be used to boot the installation
325kernel, which contains all the tools required to install
326.Nx .
327.if \n[macppc] \{\
328.It
329Determine your machine's model, quirks, and Open Firmware version from the
330.Nx*M
331.Lk https://www.NetBSD.org/ports/macppc/models.html "Model Support webpage" .
332.Pp
333At present,
334.Nx*M
335cannot exist on the same hard drive as
336.Tn Mac OS
337unless you partition your disk before running the installer.
338Open Firmware versions prior to 3 require a dedicated
339.Nx
340drive \(em you must use the entire disk,
341partitioned with the installation tools.
342Open Firmware version 3 cannot boot into
343.Nx
344on a drive partitioned with the installation tools, you must partition
345your disk before running the installer, then select the
346.Dq Me "Re-install sets or install additional sets"
347option in the installer (selecting the
348.Dq Me "Install NetBSD to hard disk"
349or
350.Dq Me "Upgrade NetBSD on a hard disk"
351options will render your drive unbootable).
352If you are unsure, you may want to read the section below on
353.Sx Partitioning your hard drive for NetBSD
354.It
355For systems with Open Firmware versions prior to 3, you may need to use
356Apple's System Disk utility to enter Open Firmware and use your screen and
357keyboard.
358To enter Open Firmware, hold down the
359.Key COMMAND-OPTION-O-F
360keys after the boot chime starts, but before the chime ends.
361Entering Open Firmware versions prior to 3 is usually the most frustrating
362part of installation \(em you may want to read the section below on
363.Sx Older Open Firmware System Preparation
364.Pp
365You should have the Open Firmware
366.Dq Pa "0 \*[Gt]"
367prompt on your screen before attempting to boot
368.Nx*M .
369.\}
370.if \n[macppc] \{\
371.It
372At the Open Firmware prompt, type the command to boot.
373To boot from the installation floppies, the command is
374.Dq Ic "boot fd:0" .
375For the install kernel and bootloader on your hard drive (Open Firmware
3763), the command is
377.Dq Ic "boot hd:,\eofwboot.xcf netbsd-GENERIC_MD.gz" .
378.Pp
379For boot CDs, the command is something like
380.Dq Ic "boot cd:,\eofwboot.xcf netbsd.macppc"
381(for Open Firmware 3) or
382.Dq Ic "boot scsi-int/sd@3:0 NETBSD.MACPPC"
383(for earlier Open Firmware versions).
384You will need to use the correct case for
385.Ic OFWBOOT.XCF No and Ic NETBSD.MACPPC
386depending on how your version of Open Firmware interprets the ISO
387file system.
388You may need to replace
389.Ic cd
390with
391.Ic "scsi/sd@3 , scsi-int/sd@3 , ata/atapi-disk ,"
392or some other device alias.
393You should also use the Open Firmware
394.Ic dir
395command to confirm that the
396.Nx*M
397kernel is called
398.Pa NETBSD.MACPPC .
399You may want to read the section below on
400.Sx Open Firmware boot syntax
401.\}
402.if \n[macppc] \{\
403.It
404.Pp
405PowerPC 601 machines need to use separate boot floppies
406.Pa macppc/installation/floppy/boot601_1.fs
407and
408.Pa macppc/installation/floppy/boot602_2.fs ,
409a different kernel set
410.Pa kern-GENERIC_601.\*[setsuffix] ,
411and a different install kernel
412.Pa netbsd-INSTALL_601.gz .
413The same boot CD can be used but at the boot prompt you must specify
414the 601 kernel, i.e., replace
415.Ic netbsd.macppc
416with
417.Ic netbsd.601
418.
419.\}
420.if \n[sparc]:\n[sparc64] \{\
421.It
422You will need to get to the
423.if \n[sparc] OpenBoot PROM
424.if \n[sparc64] OpenFirmware
425.Dq Ic "ok"
426prompt.
427After your system first powers on and displays some initial information,
428press the
429.Key STOP-A
430keys, or send a BREAK if you're on a serial console.
431At the
432.Dq Ic "ok"
433prompt, type the command to boot your system into
434.Nx .
435.\}
436.if \n[sparc] \{\
437The command to boot from CD is one of the following commands (depending on
438your model):
439.Dq Ic b sd(,30,) ,
440.Dq Ic boot sd(,30,) ,
441or
442.Dq Ic boot cdrom .
443.\}
444.if \n[sparc64] \{\
445The command to boot from CD is:
446.Dq Ic boot cdrom .
447The command to boot the
448.Nx
449kernel from a
450.Tn Solaris
451or
452.Nx
453partition depends on which disk and partition it is on.
454To boot from the first partition of the first (primary) disk:
455.Dq Ic "boot disk:a /ofwboot -a" .
456When it asks you for a kernel, specify
457.Dq Ic "netbsd-INSTALL.gz"
458.\}
459.It
460For third-party programs which are not part of the base
461.Nx
462distribution, you will want to explore the
463.Ic pkgsrc
464package management system, which contains thousands of third-party software
465applications.
466.El
467.\}
468.Ss "What is NetBSD?"
469.Pp
470.
471The
472.Nx
473Operating System is a fully functional open-source operating system derived
474from the University of California, Berkeley Networking Release 2 (Net/2),
4754.4BSD-Lite, and 4.4BSD-Lite2 sources.
476.Nx
477runs on many different different system architectures (ports)
478across a variety of distinct CPU families, and is being ported to more.
479The
480.Nx
481\*V release contains complete binary releases for most of these
482system architectures, with preliminary support for the others included in
483source form.
484Please see the
485.Nx
486.Lk https://www.NetBSD.org/ website
487for information on them.
488.Pp
489.Nx
490is a completely integrated system.
491In addition to its highly portable, high performance kernel,
492.nh
493.Nx
494features a complete set of user utilities, compilers for several
495languages, the X Window System, firewall software
496and numerous other tools, all accompanied by full source code.
497.Pp
498.\" XXX Should we include some text here about NetBSD's license
499.\" policies and how commercial-friendly it is?
500.Nx
501is a creation of the members of the Internet community.
502Without the unique cooperation and coordination the net makes
503possible,
504.Nx
505would not exist.
506.
507.ie \n[RELEASE_BRANCH] .Ss Changes Between The NetBSD \n[oldvers] \
508and \n[major] Releases
509.el .Ss Changes Between The NetBSD \n[oldvers] and \
510\n[major] Releases, and newer
511.Pp
512The
513.Nx
514\*V release
515provides many significant changes, including support for many new
516devices, hundreds of bug fixes, new and updated kernel subsystems, and
517numerous userland enhancements.
518The result of these improvements is a stable operating system fit for
519production use that rivals most commercially available systems.
520.Pp
521.if !\n[RELEASE_BRANCH] \{ \
522Please note that this build is a development snapshot, not a formal release.
523You are testing the bleeding edge of
524.Nx
525development, and no formal or informal testing may have been done for
526this snapshot (yet).
527.Pp
528.\} \" !\n[RELEASE_BRANCH] \{
529One important new feature in this release is the support for extended
530attributes and access controll lists on FFS file systems.
531.Pp
532For new installations the installer will default to disable this features,
533so the file system is compatible with older
534.Nx
535releases (before 10), and allow other operating systems to mount this
536file systems at least in read-only mode.
537.Pp
538If you want a new installed file system to support extended attributes,
539change the file system type from
540.Dq FFSv2
541to
542.Dq FFSv2ea
543in the partitioning menu.
544You can also convert file systems later, using the
545.Xr fsck_ffs 8
546utility.
547More details are available in
548.Lk https://wiki.netbsd.org/tutorials/acls_and_extended_attributes_on_ffs "this guide" .
549.Pp
550If you are upgrading from a version of
551.Nx -current
552please also check the
553.Sx "Compatibility Issues With Previous NetBSD Releases" .
554.PP
555It is impossible to completely summarize the massive development that
556went into the
557.Nx
558\*V release.
559.ie \n[RELEASE_BRANCH] \{\
560The complete list of changes can be found in the following files:
561.br
562.Lk "\*[RELEASE_URL]/CHANGES" CHANGES
563.de showdotchanges
564.  nr ominor (\\$1-1)
565.  if \\n[ominor] .showdotchanges \\n[ominor]
566.  nr ominor (\\$1-1)
567.  br
568.  Lk "\*[RELEASE_URL]/CHANGES-\n[major].\\$1" "CHANGES-\\n[major].\\$1"
569..
570.showdotchanges \n[minor]
571.if (\n[nextminor] > \n[minor]) \{\
572.  br
573.  Lk "\*[RELEASE_URL]/CHANGES-\n[major].\n[nextminor]" "CHANGES-\\n[major].\n[nextminor]"
574.\}
575.br
576files in the top level directory of the NetBSD \n[major].\n[minor] release tree.
577.Pp
578.
579.\} \" \n[RELEASE_BRANCH]
580.el \{\
581The complete list of changes can be found in the following files:
582.br
583.Lk \*[RELEASE_URL]/CHANGES CHANGES
584.br
585.Lk \*[RELEASE_URL]/CHANGES.prev CHANGES.prev
586.\} \" !\n[RELEASE_BRANCH]
587.
588.Ss "Features to be removed in a later release"
589The following features are to be removed from
590.Nx
591in the future:
592.Bl -bullet -offset indent
593.It
594.Xr groff 1 .
595Man pages are now handled with
596.Xr mandoc 1 ,
597and
598.Xr groff 1
599can still be found in pkgsrc as
600.Pa textproc/groff .
601.It
602.Xr pf 4 .
603This packet filter is obsolete and unmaintained in
604.Nx .
605It will be eventually removed due to possible long-standing
606security issues and lack of multiprocessor support.
607New installations should use
608.Xr npf 7 .
609.El
610.Ss "The NetBSD Foundation"
611.Pp
612.
613The
614.Nx
615Foundation is a tax exempt, not-for-profit 501(c)(3) corporation
616that devotes itself to the traditional goals and spirit of the
617.Nx
618Project and owns the trademark of the word
619.Dq NetBSD .
620It supports the design, development, and adoption of
621.Nx
622worldwide.
623More information on the
624.Nx
625Foundation, its composition, aims, and work can be found at:
626.Lk https://www.NetBSD.org/foundation/
627.br_ne 10P
628.
629.Ss "Sources of NetBSD"
630.Pp
631.
632Refer to
633.Lk https://www.NetBSD.org/mirrors/ mirrors
634.br_ne 10P
635.
636.Ss "NetBSD \*V Release Contents
637.Pp
638.
639The root directory of the
640.Nx
641\*V release is organized as follows:
642.Pp
643.Pa .../NetBSD-\*V/
644.(tag README.files
645.It Li CHANGES
646.ie \n[RELEASE_BRANCH] Changes between the \n[oldvers].0 and \
647\n[major].0 releases.
648.el Changes after the netbsd-\n[major] branch.
649.if \n[RELEASE_BRANCH] \{\
650.It Li CHANGES-\\n[major].0
651Changes between the initial \n[major].0 branch and final release of \n[major].0.
652.de showdotchanges
653.  nr ominor (\\$1-1)
654.  if \\n[ominor] .showdotchanges \\n[ominor]
655.  nr ominor (\\$1-1)
656.  It Li CHANGES-\\n[major].\\$1
657Changes between the \n[major].\\n[ominor] and the \n[major].\\$1 release.
658..
659.if \n[minor] .showdotchanges \n[minor]
660.if (\n[nextminor] > \n[minor]) \{\
661.It Li CHANGES-\\n[major].\n[nextminor]
662Changes after the release of \n[major].\n[minor].
663.\} \" \n[nextminor] > \n[minor]
664.\} \" \n[RELEASE_BRANCH]
665.It Li CHANGES.prev
666Changes in previous
667.Nx
668releases.
669.if \n[FOR_RELEASE] \{\
670.It Li LAST_MINUTE
671Last minute changes and notes about the release.
672.\} \" \n[FOR_RELEASE]
673.It Li README.files
674README describing the distribution's contents.
675.It Pa images/
676Images (ISO 9660 or USB) for installing NetBSD.
677Depending on your system, these may be bootable.
678.It Pa source/
679Source distribution sets; see below.
680.tag)
681.Pp
682In addition to the files and directories listed above, there is one
683directory per architecture, for each of the architectures for which
684.Nx
685\*V has a binary distribution.
686.Pp
687The source distribution sets can be found in subdirectories of the
688.Pa source
689subdirectory of the distribution tree.
690They contain the complete sources to the system.
691The source distribution sets are as follows:
692.(tag sharesrc
693.It Sy gnusrc
694This set contains the
695.Dq gnu
696sources, including the source for the compiler, assembler, groff,
697and the other GNU utilities in the binary distribution sets.
698.It Sy sharesrc
699This set contains the
700.Dq share
701sources, which include the sources for the man pages not associated
702with any particular program; the sources for the typesettable document
703set; the dictionaries; and more.
704.It Sy src
705This set contains all of the base
706.Nx
707\*V sources which are not in
708.Sy gnusrc ,
709.Sy sharesrc ,
710or
711.Sy syssrc .
712.It Sy syssrc
713This set contains the sources to the
714.Nx
715\*V kernel for all architectures as well as the
716.Xr config 1
717utility.
718.It Sy xsrc
719This set contains the sources to the X Window System.
720.tag)
721.Pp
722All the above source sets are located in the
723.Pa source/sets
724subdirectory of the distribution tree.
725.Pp
726The source sets are distributed as compressed tar files.
727Except for the
728.Sy pkgsrc
729set, which is traditionally unpacked into
730.Pa /usr/pkgsrc ,
731all sets may be unpacked into
732.Pa /usr/src
733with the command:
734.Dl # Ic "cd / ; tar -zxpf set_name.\*[setsuffix]"
735.Pp
736In each of the source distribution set directories, there are
737files which contain the checksums of the files in the directory:
738.(tag SHA512 -offset indent
739.It Li MD5
740.Tn MD5
741digests in the format produced by the command:
742.br
743.Ic cksum -a MD5 Ar file .
744.It Li SHA512
745.Tn SHA512
746digests in the format produced by the command:
747.br
748.Ic cksum -a SHA512 Ar file .
749.tag)
750.Pp
751The SHA512 digest is safer, but MD5 checksums are provided so that a wider
752range of operating systems can check the integrity of the release files.
753.
754.so contents -----------------------------------------------
755.
756.
757.(Note
758Each directory in the \*M binary distribution also has its
759own checksum files, just as the source distribution does.
760.Note)
761.br_ne 7P
762.
763.Ss "NetBSD/\*M System Requirements and Supported Devices"
764.
765.so hardware -----------------------------------------------
766.br_ne 7P
767.
768.Ss "Getting the NetBSD System on to Useful Media"
769.
770.so xfer -----------------------------------------------
771.br_ne 7P
772.
773.Ss "Preparing your System for NetBSD installation"
774.
775.so prep -----------------------------------------------
776.br_ne 7P
777.
778.ie \n[mac68k] .Ss "Installing the NetBSD System (Sysinst Method)"
779.el .Ss "Installing the NetBSD System"
780.
781.so install -----------------------------------------------
782.br_ne 7P
783.
784.Ss "Post installation steps"
785.
786.so ../common/postinstall -----------------------------------------------
787.br_ne 7P
788.
789.Ss "Upgrading a previously-installed NetBSD System"
790.
791.so upgrade -----------------------------------------------
792.br_ne 7P
793.
794.Ss "Compatibility Issues With Previous NetBSD Releases"
795.Pp
796.
797Users upgrading from previous versions of
798.Nx
799may wish to bear the
800following problems and compatibility issues in mind when upgrading to
801.Nx
802\*V.
803.Pp
804Note that
805.Ic sysinst
806will automatically invoke
807.(disp
808postinstall fix
809.disp)
810and thus all issues that are fixed by
811.Ic postinstall
812by default will be handled.
813.Pp
814If you have ever run a version of
815.Nx -current
816between April 18, 2020 and September 23, 2022 (the version numbers
817used in the affected time range are between 9.99.56 and 9.99.106)
818your FFS file systems might have broken extended attributes stored.
819.Pp
820You should follow this
821.Lk https://wiki.netbsd.org/features/UFS2ea/ guide
822before booting the updated system multi-user for the first time.
823.Pp
824.Em Note that you do not need to do anything special if you never did run any affected kernel,
825especially if you have never run
826.Nx -current .
827.Pp
828A number of things have been removed from the
829.Nx
830\*V release.
831See the
832.Dq Components removed from NetBSD
833section near the beginning of this document for a list.
834.Ss "Using online NetBSD documentation"
835.Pp
836Documentation is available if you installed the manual
837distribution set.
838Traditionally, the
839.Dq man pages
840(documentation) are denoted by
841.Sq Li name(section) .
842Some examples of this are
843.Pp
844.(bullet -compact -offset indent
845.Xr intro 1 ,
846.It
847.Xr man 1 ,
848.It
849.Xr apropos 1 ,
850.It
851.Xr passwd 1 ,
852and
853.It
854.Xr passwd 5 .
855.bullet)
856.Pp
857The section numbers group the topics into several categories, but three
858are of primary interest: user commands are in section 1, file formats
859are in section 5, and administrative information is in section 8.
860.Pp
861.No The Em man
862command is used to view the documentation on a topic, and is
863started by entering
864.Ic man
865.Op Ar section
866.Ar topic .
867The brackets
868.Op \&
869around the
870section should not be entered, but rather indicate that the section is
871optional.
872If you don't ask for a particular section, the topic with the
873lowest numbered section name will be displayed.
874For instance, after logging in, enter
875.Pp
876.Dl # Ic "man passwd"
877.Pp
878to read the documentation for
879.Xr passwd 1 .
880To view the documentation for
881.Xr passwd 5 ,
882enter
883.Pp
884.Dl # Ic "man 5 passwd"
885.Pp
886instead.
887.Pp
888If you are unsure of what man page you are looking for, enter
889.Pp
890.Dl # Ic apropos Ar subject-word
891.Pp
892where
893.Ar subject-word
894is your topic of interest; a list of possibly
895related man pages will be displayed.
896.
897.Ss Administrivia
898.Pp
899.
900If you've got something to say, do so!
901We'd like your input.
902There are various mailing lists available via the mailing list
903server at
904.Mt majordomo@NetBSD.org .
905See
906.Lk https://www.NetBSD.org/mailinglists/
907for details.
908.Pp
909There are various mailing lists set up to deal with comments and
910questions about this release.
911Please send comments to:
912.Mt netbsd-comments@NetBSD.org .
913.Pp
914To report bugs, use the
915.Xr send-pr 1
916command shipped with
917.Nx ,
918and fill in as much information about the problem as you can.
919Good bug reports include lots of details.
920.Pp
921Bugs also can be submitted and queried with the web interface at
922.Lk https://www.NetBSD.org/support/send-pr.html
923.Pp
924There are also port-specific mailing lists, to discuss aspects of
925each port of
926.Nx .
927Use majordomo to find their addresses, or visit
928.Lk https://www.NetBSD.org/mailinglists/
929.Pp
930If
931you're interested in doing a serious amount of work on a specific
932port, you probably should contact the
933.Sq owner
934of that port (listed
935below).
936.Pp
937If you'd like to help with
938.Nx ,
939and have an idea as to how you could be useful, send us mail or subscribe to:
940.Mt netbsd-users@NetBSD.org .
941.Pp
942As a favor, please avoid mailing huge documents or files to these
943mailing lists.
944Instead, put the material you would have sent up for FTP or WWW somewhere,
945then mail the appropriate list about it.
946If you'd rather not do that, mail the list saying you'll send the data to
947those who want it.
948.
949.Ss Thanks go to
950.
951.(bullet
952The former members of UCB's Computer Systems Research Group,
953including (but not limited to):
954.Bd -unfilled -offset indent
955Keith Bostic
956Ralph Campbell
957Mike Karels
958Marshall Kirk McKusick
959.Ed
960.Pp
961for their work on
962.Bx
963systems, support, and encouragement.
964.It
965The Internet Systems Consortium, Inc. for hosting the
966.Nx
967FTP, CVS, AnonCVS, mail, mail archive, GNATS, SUP, Rsync and WWW servers.
968.It
969The Internet Research Institute in Japan for hosting the server
970which runs the CVSweb interface to the
971.Nx
972source tree.
973.It
974The Columbia University Computer Science Department for hosting
975the build cluster.
976.It
977The many organizations that provide
978.Nx
979mirror sites.
980.It
981Without CVS, this project would be impossible to manage, so our hats
982go off to Brian Berliner, Jeff Polk, and the various other people
983who've had a hand in making CVS a useful tool.
984.It
985We list the individuals and organizations
986that have made donations or loans of hardware and/or money, to support
987.Nx
988development, and deserve credit for it at
989.Lk https://www.NetBSD.org/donations/
990(If you're not on that list and should be, tell us!
991We probably were not able to get in touch with you, to verify that you
992wanted to be listed.)
993.It
994Finally, we thank all of the people who've put sweat and tears into
995developing
996.Nx
997since its inception in January, 1993.
998(Obviously, there are a lot more people who deserve thanks here.
999If you're one of them, and would like to be mentioned, tell us!)
1000.bullet)
1001.
1002.Ss "Legal Mumbo-Jumbo"
1003.Pp
1004.
1005All product names mentioned herein are trademarks or registered
1006trademarks of their respective owners.
1007.Pp
1008The following notices are required to satisfy the license terms of
1009the software that we have mentioned in this document:
1010.Pp
1011.nr save_size \n[.s]
1012.nr save_vs \n[.v]
1013.ps 8
1014.vs 9
1015.Ht <font size=-1>
1016.(item -compact
1017.so ../common/legal.common -----------------------------------------------
1018.item)
1019.Ht </font>
1020.ps
1021.vs
1022.Ss "The End"
1023