Training courses

Kernel and Embedded Linux

Bootlin training courses

Embedded Linux, kernel,
Yocto Project, Buildroot, real-time,
graphics, boot time, debugging...

Bootlin logo

Elixir Cross Referencer

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
.\"	$NetBSD: main,v 1.570 2022/12/16 16:58:14 martin Exp $
.\"
.\" Copyright (c) 1999-2012 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.ig

	To "regenerate" this file, go up one level to src/distrib/notes
	and type "make".  This will create
	src/distrib/notes/<arch>/INSTALL.*.

	We keep most of the notes the same on HEAD and release branches,
	but some of this are not appropriate for HEAD/current. Also
	some locations differ for actual release, so we distinguish
	between:

	RELEASE_BRANCH == 1
		this is on a release branch (not -current)
	RELEASE_BRANCH == 0
		this is current, not yet branched
	FOR_RELEASE == 1
		this is an official release (will be signed and placed
		on ftp/cdn)
	FOR_RELEASE == 0
		this is a local build or a "daily" build on the build
		cluster
..
.
.tm Processing INSTALL
.
.\"	--------------------  CONFIGURATION  --------------------
.
.nr oldvers ( \n[major] - 1 )
.ie \n[FOR_RELEASE] \{\
.ds RELEASE_URL https://cdn.NetBSD.org/pub/NetBSD/NetBSD-\*V
.\}
.el \{\
.ie \n[RELEASE_BRANCH] \{\
.ds ftppath netbsd-\n[major]
.\} \" \n[RELEASE_BRANCH]
.el .ds ftppath HEAD
.ds RELEASE_URL https://nycdn.NetBSD.org/pub/NetBSD-daily/\*[ftppath]/latest
.\} \" !\n[FOR_RELEASE]
.nr DOC_XR 1
.ds MACHINE_LIST acorn32 algor alpha amd64 amiga amigappc arc atari
.as MACHINE_LIST " bebox cats cesfic cobalt dreamcast emips evbarm evbmips
.as MACHINE_LIST " evbppc evbsh3 ews4800mips hp300 hppa hpcarm hpcmips hpcsh
.as MACHINE_LIST " i386 ibmnws iyonix landisk luna68k mac68k macppc mipsco
.as MACHINE_LIST " mmeye mvme68k mvmeppc netwinder news68k newsmips next68k
.as MACHINE_LIST " ofppc playstation2 pmax prep rs6000 sandpoint sbmips
.as MACHINE_LIST " sgimips shark sparc sparc64 sun2 sun3 vax x68k zaurus .
.so \*[.CURDIR]/../common/macros
.
.\" Override <title> for HTML output
.if rHTML .ds title-section Installation procedure for NetBSD/\*M \*V
.Dd \*[cur_date]
.Dt INSTALL 8
.Os NetBSD/\*M \*V
.Sh NAME
.Nm INSTALL
.Nd Installation procedure for
.Nx*M .
.Sh CONTENTS
.Tc
.Sh DESCRIPTION
.
.Ss About this Document
.Pp
.
This document describes the installation procedure for
.Nx
\*V on the
.Em \*M
platform.
It is available in four different formats titled
.Pa INSTALL. Ns Ar ext ,
where
.Ar \&.ext
is one of
.Pa \&.ps , \&.html , \&.more ,
.No or Pa \&.txt :
.(tag \&.morex -offset indent
.It Pa \&.ps
PostScript.
.It Pa \&.html
.No Standard Internet Tn HTML .
.It Pa \&.more
The enhanced text format used on
.Ul
systems by the
.Xr more 1
and
.Xr less 1
pager utility programs.
This is the format in which the on-line
.Em man
pages are generally presented.
.It Pa \&.txt
Plain old
.Tn ASCII .
.tag)
.Pp
You are reading the
.Em \*[format]
version.
.
.if \n[i386]:\n[macppc]:\n[sparc]:\n[sparc64]:\n[amd64] \{\
.Ss "Quick install notes for the impatient"
.Pp
This section contains some brief notes describing what you need to
install
.Nx
\*V on a machine of the \*M architecture.
.Bl -bullet
.It
Fetch files needed to install
.Nx .
.if \n[i386]:\n[amd64] \{\
.Pp
Option 1: bootable CD-ROM images or USB images containing the
full distribution.
.Pp
These can be found
on an FTP site near you, usually located in the
.Pa /pub/NetBSD/images/
directory.
Check the list of
.Nx
.Lk https://www.NetBSD.org/mirrors mirrors
for details.
.Pp
Option 2: bootable CD-ROM images from
.Pa \*M/installation/cdrom/ .
.Pp
These images are bootable, but do not contain binary sets.
They are intended for network installs or system repair.
.Pa boot.iso
is for VGA console installation, and
.Pa boot-com.iso
is for installation over serial console (com0, 9600 baud).
.Pp
.\} \" amd64:i386
.if \n[i386] \{\
Option 3: boot floppy images from
.Pa \*M/installation/floppy/ .
.Pp
.Pa boot1.fs
and
.Pa boot2.fs
are floppy images for VGA console installation.
.Pa boot-com1.fs
and
.Pa boot-com2.fs
are for installation via serial console (com0, 9600 baud).
.\} \" i386
.if \n[i386]:\n[amd64] \{\
.It
The default kernel on CD-ROMs has ACPI enabled.
This is known to cause issues on a few machines which have buggy ACPI
implementations.
.Pp
To boot with ACPI disabled, interrupt the menu and enter the
.Nx
boot prompt.
Type
.Ic boot -2
to boot with ACPI disabled.
.\} \" amd64:i386
.if \n[macppc] \{\
The files depend on which model you
are using and how you plan to boot your machine.
For systems with built-in floppy drives (Open Firmware 1 or 2),
fetch the pair of boot floppy images
.Pa macppc/installation/floppy/boot1.fs
and
.Pa macppc/installation/floppy/boot2.fs ,
which include the bootloader and installation kernel.
For systems without floppy drives (most are Open Firmware 3), fetch the
bootloader
.Pa macppc/installation/ofwboot.xcf
and the installation kernel
.Pa macppc/binary/kernel/netbsd-GENERIC_MD.gz .
If you have a CD-R, you can fetch the CD image,
.Pa NetBSD-\*V-macppc.iso .
.\}
.if \n[sparc] \{\
Fetch a CD image,
.Pa NetBSD-\*V-sparc.iso .
You need the CD to boot your system.
.\}
.if \n[sparc64] \{\
This is either a CD image
.Pq Pa NetBSD-\*V-sparc64.iso
which can be booted directly, or the installation kernel and bootloader
.Pq Pa sparc64/binary/kernel/netbsd-INSTALL.gz No and Pa sparc64/installation/misc/ofwboot
which can be booted from a
.Tn Solaris
or
.Nx
partition.
.\}
.if \n[macppc]:\n[sparc]:\n[sparc64] \{\
Alternatively, you may netboot the installation kernel.  This process is
covered below, in detail.
.\}
.It
The actual binary distribution is in the
.Pa \*M/binary/sets/
directory.
When you boot the install
.if \n[amd64] image or CD-ROM,
.if \n[i386] image, CD-ROM or floppies,
.if \n[macppc] kernel from floppies, hard drive, or CD-ROM,
.if \n[sparc] CD-ROM,
.if \n[sparc64] CD-ROM or installation kernel,
the installation program
can fetch these files for you (using, e.g., ftp)
if you have a network connection.
There are several other methods to get the binary sets onto
your machine.
.Pp
You will at a minimum need
.ie \n[i386]:\n[amd64] \{\
one of the kernel sets, typically
.Pa kern-GENERIC.\*[setsuffix] ,
as well as
.\}
.el \{\
the following sets:
.Pa kern-GENERIC.\*[setsuffix] ,
.\}
.Pa base.\*[setsuffix]
and
.Pa etc.\*[setsuffix] .
In a typical workstation installation you will probably want
all the installation sets.
.if \n[i386]:\n[amd64] \{\
.It
Write the boot images
.Pp
Many commercial and freeware programs are available to burn CD-ROMs.
.Pp
If installing via USB, you must first uncompress the USB image, which
is gzipped.
.if \n[amd64] \{\
Note the \*M architecture has two images, NetBSD-\*V-\*M-install.img.gz
and NetBSD-\*V-\*M-bios-install.img.gz. The latter is intended for older
hardware which is unable to boot using a hybrid MBR and GPT image.
.\}
.Dl $ Ic "gunzip NetBSD-\*V-\*M-install.img.gz"
Next, write the USB image to a USB stick/drive.
Note that this will overwrite any existing data on the device that you
specify, so double check the device before running!
On
.Ul
operating systems, use a command similar to the following,
replacing
.Pa /dev/rsd0d
with the appropriate device for your system:
.Dl # Ic "dd if=NetBSD-\*V-\*M-install.img of=/dev/rsd0d bs=32k"
On Windows, you will need to use a program such as
.Lk http://sourceforge.net/projects/win32diskimager/ "Win32 Disk Imager" ,
or
.Lk https://www.NetBSD.org/~martin/rawrite32 Rawrite32 .
If you have problems writing a raw image to a floppy,
the
.Ic rawrite.exe
MS-DOS program
in the
.Pa \*M/installation/misc/
directory may be of help.
.\}
.if \n[macppc] \{\
.It
If your \*M has a floppy drive, create the pair of boot floppies using
.Ic suntar
(MacOS 9),
.Ic rawrite
(Windows), or
.Ic dd
(any
.Ul
system with floppy support).  If your system has Open Firmware 3, drag
.Pa ofwboot.xcf No and Pa netbsd-GENERIC_MD.gz
to your hard drive icon (the top level of the drive, not the desktop).
If you are using the CD image, burn it now.
.\}
.if \n[sparc] \{\
.It
Make sure your sparc's CD-ROM drive is bootable.
Burn the CD.
.\}
.if \n[sparc64] \{\
.It
Burn the CD or put the installation kernel and bootloader
at the root level of a bootable
.Tn Solaris
or
.Nx
partition.
.\}
.Pp
The media you just prepared will be used to boot the installation
kernel, which contains all the tools required to install
.Nx .
.if \n[macppc] \{\
.It
Determine your machine's model, quirks, and Open Firmware version from the
.Nx*M
.Lk https://www.NetBSD.org/ports/macppc/models.html "Model Support webpage" .
.Pp
At present,
.Nx*M
cannot exist on the same hard drive as
.Tn Mac OS
unless you partition your disk before running the installer.
Open Firmware versions prior to 3 require a dedicated
.Nx
drive \(em you must use the entire disk,
partitioned with the installation tools.
Open Firmware version 3 cannot boot into
.Nx
on a drive partitioned with the installation tools, you must partition
your disk before running the installer, then select the
.Dq Me "Re-install sets or install additional sets"
option in the installer (selecting the
.Dq Me "Install NetBSD to hard disk"
or
.Dq Me "Upgrade NetBSD on a hard disk"
options will render your drive unbootable).
If you are unsure, you may want to read the section below on
.Sx Partitioning your hard drive for NetBSD
.It
For systems with Open Firmware versions prior to 3, you may need to use
Apple's System Disk utility to enter Open Firmware and use your screen and
keyboard.
To enter Open Firmware, hold down the
.Key COMMAND-OPTION-O-F
keys after the boot chime starts, but before the chime ends.
Entering Open Firmware versions prior to 3 is usually the most frustrating
part of installation \(em you may want to read the section below on
.Sx Older Open Firmware System Preparation
.Pp
You should have the Open Firmware
.Dq Pa "0 \*[Gt]"
prompt on your screen before attempting to boot
.Nx*M .
.\}
.if \n[macppc] \{\
.It
At the Open Firmware prompt, type the command to boot.
To boot from the installation floppies, the command is
.Dq Ic "boot fd:0" .
For the install kernel and bootloader on your hard drive (Open Firmware
3), the command is
.Dq Ic "boot hd:,\eofwboot.xcf netbsd-GENERIC_MD.gz" .
.Pp
For boot CDs, the command is something like
.Dq Ic "boot cd:,\eofwboot.xcf netbsd.macppc"
(for Open Firmware 3) or
.Dq Ic "boot scsi-int/sd@3:0 NETBSD.MACPPC"
(for earlier Open Firmware versions).
You will need to use the correct case for
.Ic OFWBOOT.XCF No and Ic NETBSD.MACPPC
depending on how your version of Open Firmware interprets the ISO
file system.
You may need to replace
.Ic cd
with
.Ic "scsi/sd@3 , scsi-int/sd@3 , ata/atapi-disk ,"
or some other device alias.
You should also use the Open Firmware
.Ic dir
command to confirm that the
.Nx*M
kernel is called
.Pa NETBSD.MACPPC .
You may want to read the section below on
.Sx Open Firmware boot syntax
.\}
.if \n[macppc] \{\
.It
.Pp
PowerPC 601 machines need to use separate boot floppies 
.Pa macppc/installation/floppy/boot601_1.fs
and
.Pa macppc/installation/floppy/boot602_2.fs ,
a different kernel set
.Pa kern-GENERIC_601.\*[setsuffix] ,
and a different install kernel
.Pa netbsd-INSTALL_601.gz .
The same boot CD can be used but at the boot prompt you must specify
the 601 kernel, i.e., replace
.Ic netbsd.macppc
with
.Ic netbsd.601
.
.\}
.if \n[sparc]:\n[sparc64] \{\
.It
You will need to get to the
.if \n[sparc] OpenBoot PROM
.if \n[sparc64] OpenFirmware
.Dq Ic "ok"
prompt.
After your system first powers on and displays some initial information,
press the
.Key STOP-A
keys, or send a BREAK if you're on a serial console.
At the
.Dq Ic "ok"
prompt, type the command to boot your system into
.Nx .
.\}
.if \n[sparc] \{\
The command to boot from CD is one of the following commands (depending on
your model):
.Dq Ic b sd(,30,) ,
.Dq Ic boot sd(,30,) ,
or
.Dq Ic boot cdrom .
.\}
.if \n[sparc64] \{\
The command to boot from CD is:
.Dq Ic boot cdrom .
The command to boot the
.Nx
kernel from a
.Tn Solaris
or
.Nx
partition depends on which disk and partition it is on.
To boot from the first partition of the first (primary) disk:
.Dq Ic "boot disk:a /ofwboot -a" .
When it asks you for a kernel, specify
.Dq Ic "netbsd-INSTALL.gz"
.\}
.It
For third-party programs which are not part of the base
.Nx
distribution, you will want to explore the
.Ic pkgsrc
package management system, which contains thousands of third-party software
applications.
.El
.\}
.Ss "What is NetBSD?"
.Pp
.
The
.Nx
Operating System is a fully functional open-source operating system derived
from the University of California, Berkeley Networking Release 2 (Net/2),
4.4BSD-Lite, and 4.4BSD-Lite2 sources.
.Nx
runs on many different different system architectures (ports)
across a variety of distinct CPU families, and is being ported to more.
The
.Nx
\*V release contains complete binary releases for most of these
system architectures, with preliminary support for the others included in
source form.
Please see the
.Nx
.Lk https://www.NetBSD.org/ website
for information on them.
.Pp
.Nx
is a completely integrated system.
In addition to its highly portable, high performance kernel,
.nh
.Nx
features a complete set of user utilities, compilers for several
languages, the X Window System, firewall software
and numerous other tools, all accompanied by full source code.
.Pp
.\" XXX Should we include some text here about NetBSD's license
.\" policies and how commercial-friendly it is?
.Nx
is a creation of the members of the Internet community.
Without the unique cooperation and coordination the net makes
possible,
.Nx
would not exist.
.
.ie \n[RELEASE_BRANCH] .Ss Changes Between The NetBSD \n[oldvers] \
and \n[major] Releases
.el .Ss Changes Between The NetBSD \n[oldvers] and \
\n[major] Releases, and newer
.Pp
The
.Nx
\*V release
provides many significant changes, including support for many new
devices, hundreds of bug fixes, new and updated kernel subsystems, and
numerous userland enhancements.
The result of these improvements is a stable operating system fit for
production use that rivals most commercially available systems.
.Pp
.if !\n[RELEASE_BRANCH] \{ \
Please note that this build is a development snapshot, not a formal release.
You are testing the bleeding edge of
.Nx
development, and no formal or informal testing may have been done for
this snapshot (yet).
.Pp
.\} \" !\n[RELEASE_BRANCH] \{
One important new feature in this release is the support for extended
attributes and access controll lists on FFS file systems.
.Pp
For new installations the installer will default to disable this features,
so the file system is compatible with older
.Nx
releases (before 10), and allow other operating systems to mount this
file systems at least in read-only mode.
.Pp
If you want a new installed file system to support extended attributes,
change the file system type from
.Dq FFSv2
to
.Dq FFSv2ea
in the partitioning menu.
You can also convert file systems later, using the
.Xr fsck_ffs 8
utility.
More details are available in
.Lk https://wiki.netbsd.org/tutorials/acls_and_extended_attributes_on_ffs "this guide" .
.Pp
If you are upgrading from a version of
.Nx -current
please also check the
.Sx "Compatibility Issues With Previous NetBSD Releases" .
.PP
It is impossible to completely summarize the massive development that
went into the
.Nx
\*V release.
.ie \n[RELEASE_BRANCH] \{\
The complete list of changes can be found in the following files:
.br
.Lk "\*[RELEASE_URL]/CHANGES" CHANGES
.de showdotchanges
.  nr ominor (\\$1-1)
.  if \\n[ominor] .showdotchanges \\n[ominor]
.  nr ominor (\\$1-1)
.  br
.  Lk "\*[RELEASE_URL]/CHANGES-\n[major].\\$1" "CHANGES-\\n[major].\\$1"
..
.showdotchanges \n[minor]
.if (\n[nextminor] > \n[minor]) \{\
.  br
.  Lk "\*[RELEASE_URL]/CHANGES-\n[major].\n[nextminor]" "CHANGES-\\n[major].\n[nextminor]"
.\}
.br
files in the top level directory of the NetBSD \n[major].\n[minor] release tree.
.Pp
.
.\} \" \n[RELEASE_BRANCH]
.el \{\
The complete list of changes can be found in the following files:
.br
.Lk \*[RELEASE_URL]/CHANGES CHANGES
.br
.Lk \*[RELEASE_URL]/CHANGES.prev CHANGES.prev
.\} \" !\n[RELEASE_BRANCH]
.
.Ss "Features to be removed in a later release"
The following features are to be removed from
.Nx
in the future:
.Bl -bullet -offset indent
.It
.Xr groff 1 .
Man pages are now handled with
.Xr mandoc 1 ,
and
.Xr groff 1
can still be found in pkgsrc as
.Pa textproc/groff .
.It
.Xr pf 4 .
This packet filter is obsolete and unmaintained in
.Nx .
It will be eventually removed due to possible long-standing
security issues and lack of multiprocessor support.
New installations should use
.Xr npf 7 .
.El
.Ss "The NetBSD Foundation"
.Pp
.
The
.Nx
Foundation is a tax exempt, not-for-profit 501(c)(3) corporation
that devotes itself to the traditional goals and spirit of the
.Nx
Project and owns the trademark of the word
.Dq NetBSD .
It supports the design, development, and adoption of
.Nx
worldwide.
More information on the
.Nx
Foundation, its composition, aims, and work can be found at:
.Lk https://www.NetBSD.org/foundation/
.br_ne 10P
.
.Ss "Sources of NetBSD"
.Pp
.
Refer to
.Lk https://www.NetBSD.org/mirrors/ mirrors
.br_ne 10P
.
.Ss "NetBSD \*V Release Contents
.Pp
.
The root directory of the
.Nx
\*V release is organized as follows:
.Pp
.Pa .../NetBSD-\*V/
.(tag README.files
.It Li CHANGES
.ie \n[RELEASE_BRANCH] Changes between the \n[oldvers].0 and \
\n[major].0 releases.
.el Changes after the netbsd-\n[major] branch.
.if \n[RELEASE_BRANCH] \{\
.It Li CHANGES-\\n[major].0
Changes between the initial \n[major].0 branch and final release of \n[major].0.
.de showdotchanges
.  nr ominor (\\$1-1)
.  if \\n[ominor] .showdotchanges \\n[ominor]
.  nr ominor (\\$1-1)
.  It Li CHANGES-\\n[major].\\$1
Changes between the \n[major].\\n[ominor] and the \n[major].\\$1 release.
..
.if \n[minor] .showdotchanges \n[minor]
.if (\n[nextminor] > \n[minor]) \{\
.It Li CHANGES-\\n[major].\n[nextminor]
Changes after the release of \n[major].\n[minor].
.\} \" \n[nextminor] > \n[minor]
.\} \" \n[RELEASE_BRANCH]
.It Li CHANGES.prev
Changes in previous
.Nx
releases.
.if \n[FOR_RELEASE] \{\
.It Li LAST_MINUTE
Last minute changes and notes about the release.
.\} \" \n[FOR_RELEASE]
.It Li README.files
README describing the distribution's contents.
.It Pa images/
Images (ISO 9660 or USB) for installing NetBSD.
Depending on your system, these may be bootable.
.It Pa source/
Source distribution sets; see below.
.tag)
.Pp
In addition to the files and directories listed above, there is one
directory per architecture, for each of the architectures for which
.Nx
\*V has a binary distribution.
.Pp
The source distribution sets can be found in subdirectories of the
.Pa source
subdirectory of the distribution tree.
They contain the complete sources to the system.
The source distribution sets are as follows:
.(tag sharesrc
.It Sy gnusrc
This set contains the
.Dq gnu
sources, including the source for the compiler, assembler, groff,
and the other GNU utilities in the binary distribution sets.
.It Sy sharesrc
This set contains the
.Dq share
sources, which include the sources for the man pages not associated
with any particular program; the sources for the typesettable document
set; the dictionaries; and more.
.It Sy src
This set contains all of the base
.Nx
\*V sources which are not in
.Sy gnusrc ,
.Sy sharesrc ,
or
.Sy syssrc .
.It Sy syssrc
This set contains the sources to the
.Nx
\*V kernel for all architectures as well as the
.Xr config 1
utility.
.It Sy xsrc
This set contains the sources to the X Window System.
.tag)
.Pp
All the above source sets are located in the
.Pa source/sets
subdirectory of the distribution tree.
.Pp
The source sets are distributed as compressed tar files.
Except for the
.Sy pkgsrc
set, which is traditionally unpacked into
.Pa /usr/pkgsrc ,
all sets may be unpacked into
.Pa /usr/src
with the command:
.Dl # Ic "cd / ; tar -zxpf set_name.\*[setsuffix]"
.Pp
In each of the source distribution set directories, there are
files which contain the checksums of the files in the directory:
.(tag SHA512 -offset indent
.It Li MD5
.Tn MD5
digests in the format produced by the command:
.br
.Ic cksum -a MD5 Ar file .
.It Li SHA512
.Tn SHA512
digests in the format produced by the command:
.br
.Ic cksum -a SHA512 Ar file .
.tag)
.Pp
The SHA512 digest is safer, but MD5 checksums are provided so that a wider
range of operating systems can check the integrity of the release files.
.
.so contents -----------------------------------------------
.
.
.(Note
Each directory in the \*M binary distribution also has its
own checksum files, just as the source distribution does.
.Note)
.br_ne 7P
.
.Ss "NetBSD/\*M System Requirements and Supported Devices"
.
.so hardware -----------------------------------------------
.br_ne 7P
.
.Ss "Getting the NetBSD System on to Useful Media"
.
.so xfer -----------------------------------------------
.br_ne 7P
.
.Ss "Preparing your System for NetBSD installation"
.
.so prep -----------------------------------------------
.br_ne 7P
.
.ie \n[mac68k] .Ss "Installing the NetBSD System (Sysinst Method)"
.el .Ss "Installing the NetBSD System"
.
.so install -----------------------------------------------
.br_ne 7P
.
.Ss "Post installation steps"
.
.so ../common/postinstall -----------------------------------------------
.br_ne 7P
.
.Ss "Upgrading a previously-installed NetBSD System"
.
.so upgrade -----------------------------------------------
.br_ne 7P
.
.Ss "Compatibility Issues With Previous NetBSD Releases"
.Pp
.
Users upgrading from previous versions of
.Nx
may wish to bear the
following problems and compatibility issues in mind when upgrading to
.Nx
\*V.
.Pp
Note that
.Ic sysinst
will automatically invoke
.(disp
postinstall fix
.disp)
and thus all issues that are fixed by
.Ic postinstall
by default will be handled.
.Pp
If you have ever run a version of
.Nx -current
between April 18, 2020 and September 23, 2022 (the version numbers
used in the affected time range are between 9.99.56 and 9.99.106)
your FFS file systems might have broken extended attributes stored.
.Pp
You should follow this
.Lk https://wiki.netbsd.org/features/UFS2ea/ guide
before booting the updated system multi-user for the first time.
.Pp
.Em Note that you do not need to do anything special if you never did run any affected kernel,
especially if you have never run
.Nx -current .
.Pp
A number of things have been removed from the
.Nx
\*V release.
See the
.Dq Components removed from NetBSD
section near the beginning of this document for a list.
.Ss "Using online NetBSD documentation"
.Pp
Documentation is available if you installed the manual
distribution set.
Traditionally, the
.Dq man pages
(documentation) are denoted by
.Sq Li name(section) .
Some examples of this are
.Pp
.(bullet -compact -offset indent
.Xr intro 1 ,
.It
.Xr man 1 ,
.It
.Xr apropos 1 ,
.It
.Xr passwd 1 ,
and
.It
.Xr passwd 5 .
.bullet)
.Pp
The section numbers group the topics into several categories, but three
are of primary interest: user commands are in section 1, file formats
are in section 5, and administrative information is in section 8.
.Pp
.No The Em man
command is used to view the documentation on a topic, and is
started by entering
.Ic man
.Op Ar section
.Ar topic .
The brackets
.Op \&
around the
section should not be entered, but rather indicate that the section is
optional.
If you don't ask for a particular section, the topic with the
lowest numbered section name will be displayed.
For instance, after logging in, enter
.Pp
.Dl # Ic "man passwd"
.Pp
to read the documentation for
.Xr passwd 1 .
To view the documentation for
.Xr passwd 5 ,
enter
.Pp
.Dl # Ic "man 5 passwd"
.Pp
instead.
.Pp
If you are unsure of what man page you are looking for, enter
.Pp
.Dl # Ic apropos Ar subject-word
.Pp
where
.Ar subject-word
is your topic of interest; a list of possibly
related man pages will be displayed.
.
.Ss Administrivia
.Pp
.
If you've got something to say, do so!
We'd like your input.
There are various mailing lists available via the mailing list
server at
.Mt majordomo@NetBSD.org .
See
.Lk https://www.NetBSD.org/mailinglists/
for details.
.Pp
There are various mailing lists set up to deal with comments and
questions about this release.
Please send comments to:
.Mt netbsd-comments@NetBSD.org .
.Pp
To report bugs, use the
.Xr send-pr 1
command shipped with
.Nx ,
and fill in as much information about the problem as you can.
Good bug reports include lots of details.
.Pp
Bugs also can be submitted and queried with the web interface at
.Lk https://www.NetBSD.org/support/send-pr.html
.Pp
There are also port-specific mailing lists, to discuss aspects of
each port of
.Nx .
Use majordomo to find their addresses, or visit
.Lk https://www.NetBSD.org/mailinglists/
.Pp
If
you're interested in doing a serious amount of work on a specific
port, you probably should contact the
.Sq owner
of that port (listed
below).
.Pp
If you'd like to help with
.Nx ,
and have an idea as to how you could be useful, send us mail or subscribe to:
.Mt netbsd-users@NetBSD.org .
.Pp
As a favor, please avoid mailing huge documents or files to these
mailing lists.
Instead, put the material you would have sent up for FTP or WWW somewhere,
then mail the appropriate list about it.
If you'd rather not do that, mail the list saying you'll send the data to
those who want it.
.
.Ss Thanks go to
.
.(bullet
The former members of UCB's Computer Systems Research Group,
including (but not limited to):
.Bd -unfilled -offset indent
Keith Bostic
Ralph Campbell
Mike Karels
Marshall Kirk McKusick
.Ed
.Pp
for their work on
.Bx
systems, support, and encouragement.
.It
The Internet Systems Consortium, Inc. for hosting the
.Nx
FTP, CVS, AnonCVS, mail, mail archive, GNATS, SUP, Rsync and WWW servers.
.It
The Internet Research Institute in Japan for hosting the server
which runs the CVSweb interface to the
.Nx
source tree.
.It
The Columbia University Computer Science Department for hosting
the build cluster.
.It
The many organizations that provide
.Nx
mirror sites.
.It
Without CVS, this project would be impossible to manage, so our hats
go off to Brian Berliner, Jeff Polk, and the various other people
who've had a hand in making CVS a useful tool.
.It
We list the individuals and organizations
that have made donations or loans of hardware and/or money, to support
.Nx
development, and deserve credit for it at
.Lk https://www.NetBSD.org/donations/
(If you're not on that list and should be, tell us!
We probably were not able to get in touch with you, to verify that you
wanted to be listed.)
.It
Finally, we thank all of the people who've put sweat and tears into
developing
.Nx
since its inception in January, 1993.
(Obviously, there are a lot more people who deserve thanks here.
If you're one of them, and would like to be mentioned, tell us!)
.bullet)
.
.Ss "Legal Mumbo-Jumbo"
.Pp
.
All product names mentioned herein are trademarks or registered
trademarks of their respective owners.
.Pp
The following notices are required to satisfy the license terms of
the software that we have mentioned in this document:
.Pp
.nr save_size \n[.s]
.nr save_vs \n[.v]
.ps 8
.vs 9
.Ht <font size=-1>
.(item -compact
.so ../common/legal.common -----------------------------------------------
.item)
.Ht </font>
.ps
.vs
.Ss "The End"