]> git.lizzy.rs Git - plan9front.git/commitdiff
update manpages for 9boot
authorcinap_lenrek <cinap_lenrek@centraldogma>
Fri, 15 Apr 2011 20:48:57 +0000 (20:48 +0000)
committercinap_lenrek <cinap_lenrek@centraldogma>
Fri, 15 Apr 2011 20:48:57 +0000 (20:48 +0000)
sys/man/8/9boot [new file with mode: 0644]
sys/man/8/booting
sys/man/8/plan9.ini

diff --git a/sys/man/8/9boot b/sys/man/8/9boot
new file mode 100644 (file)
index 0000000..bb5d18e
--- /dev/null
@@ -0,0 +1,87 @@
+.TH 9BOOT 8
+.SH NAME
+9bootfat, 9bootiso, 9bootpxe \- bootloaders for pc FAT, ISO and PXE network booting
+.SH SYNOPSIS
+started by BIOS or chainloaded by partition bootsector
+.SH DESCRIPTION
+The bootloader is responsible for reading the
+.IR plan9.ini (8)
+boot parameters and boot a kernel. It interprets the
+.B bootfile=
+parameter as a file path on the current boot media
+to locate the kernel image. The path should be in all
+lower case except for
+.IR 9bootpxe
+wich supports case sensitive file names. Read parameters
+are echoed on the console. The boot procedure
+can be interrupted by pressing any key after the configuration
+was read. Then a interactive boot console is shown with a
+.B >
+prompt. The syntax of the boot console is the same as in
+the
+.IR plan9.ini (8)
+file. The word
+.B clear
+will reset all current parameters and
+.B boot
+will end the console and start booting the kernel. The boot
+console is entered automatically when boot failed, no
+.B bootfile=
+parameter is specified or no 
+.IR plan9.ini (8)
+was found.
+.SH FAT BOOTING
+The
+.IR 9bootfat
+program is responsible for loading the kernel from
+the
+.IR 9fat
+partition into memory and pass it the
+.IR plan9.ini (8)
+boot parameters. It gets chainloaded by
+.IR pbs
+wich locates it in the root of the active
+FAT partition as
+.B 9BOOTFAT
+file.
+Then
+.B plan9.ini
+is read from the root directory of the FAT
+filesystem.
+.SH CDROM BOOTING
+Booting from cdrom requires
+.IR 9bootiso
+to be included in the iso image under
+.B 386/9bootiso
+and also
+set as a non emulation bootblock see
+.IR mk9660 (8) .
+The BIOS loads the first 2K of 
+.B 386/9bootiso
+into memory and passes execution to it. The program
+then reads the rest of its code from the file to chainload itself.
+Boot parameters are read from
+.B cfg/plan9.ini
+file.
+.SH NETWORK BOOTING
+With a PXE capable BIOS and network card, it is possible for
+a machine to download
+.IR 9bootpxe
+from a tftp server and load the kernel from there. The
+.B bootf=/386/9bootpxe
+in the machines
+.IR ndb (6)
+entry will tell the PXE BIOS to use it.
+.BR
+Once started,
+.IR 9bootpxe
+will read the file
+.B /cfg/pxe/$ether
+from the tftp server, where
+.B $ether
+is the mac address of the used network card
+in lower case hex, and use it as
+.IR plan9.ini (8)
+file.
+.SH SOURCE
+.BR /sys/src/boot/pc .
index 288f4cc258e5504d2bf75131ca5c0f6ae51bb27c..dc19cf3d60c888716a4a6cde4227b40490f33bdb 100644 (file)
@@ -24,20 +24,21 @@ reboots the machine;
 other methods of rebooting are mentioned for some machines.
 .SS PCs
 To boot a PC, it is necessary to get
-.B /386/9load
+.B /386/9bootfat
+.B /386/9bootiso
 or
-.B /386/9pxeload
+.B /386/9bootpxe
 loaded into memory.
 There are many ways to do this.  A Plan 9 boot floppy prepared by
 .B format
 (see
 .IR prep (8))
 will load
-.B 9load
+.B 9bootfat
 when the PC is reset or powered on.
 Other methods are described in 
-.IR 9load (8).
-.B 9load
+.IR 9boot (8).
+.B 9boot
 then locates and loads a Plan 9 kernel, using configuration information
 from the file
 .B plan9.ini
@@ -45,7 +46,7 @@ stored in the
 .B 9fat
 configuration partition or on a DOS file system.
 See 
-.IR 9load (8)
+.IR 9boot (8)
 for details.
 .PP
 Once the kernel is booted, it behaves like the others.
@@ -252,7 +253,7 @@ when reset.
 .
 .SH "SEE ALSO"
 .IR ndb (6),
-.IR 9load (8),
+.IR 9boot (8),
 .IR boot (8),
 .IR init (8),
 .IR plan9.ini (8)
index 381652fe2de6b8b6c066e13733217914e2699cb2..376ca60d899e58d0e6bfff5039f2f7facb92f964 100644 (file)
@@ -43,9 +43,7 @@ and for Ethernets an override of the physical network address.
 Not all elements are relevant to all devices; the relevant values
 and their defaults are defined below in the description of each device.
 .PP
-The file is used by
-.B 9load
-and the kernel to configure the hardware available.
+The file is used by the kernel to configure the hardware available.
 The information it contains is also passed to the boot
 process, and subsequently other programs,
 as environment variables
@@ -397,6 +395,8 @@ Intersil Prism 2.5 chipset.
 .
 .SS DISKS, TAPES
 (S)ATA controllers are autodetected.
+.SS \fL*nodma=\fP
+disable DMA on ata devices.
 .SS \fLusbX=type=uhci\fP
 .SS \fLusbX=type=ohci\fP
 This specifies the settings for a USB UHCI or OHCI controller.
@@ -582,23 +582,9 @@ Disable probing for and automatic configuration of PCMCIA controllers.
 .SS BOOTING
 .SS \fLbootfile=value\fP
 This is used to direct the actions of
-.IR 9load (8)
-by naming the device and file from which to load the kernel.
-.SS \fLrootdir=dir\fP
-.SS \fLrootspec=spec\fP
-These are used by
-.IR 9load (8)
-to identify the directory
-.I dir
-to make the root directory for the kernel, and the
-file system specifier
-.I spec
-(see
-.B mount
-in
-.IR bind (2))
-on which it can be found.
-These are usually used to test variant file systems for distributions, etc.
+.IR 9boot (8)
+by naming the file from which to load the kernel in
+the current BIOS boot device.
 .SS \fLbootargs=value\fP
 The value of this variable is passed to
 .IR boot (8)
@@ -834,157 +820,24 @@ where
 .I unit
 is the numeric unit id.
 This variant syntax is a vestige of the file server kernel's origins.
-.SH Multiple Configurations
-.PP
-A
-.B plan9.ini
-file may contain multiple configurations,
-each within a block beginning with a line
-.EX
-       [tag]
-.EE
-A special block with the tag
-.B menu
-gives a list of blocks from which the user may
-interactively select the contents of
-.BR plan9.ini .
-There may also be multiple blocks with the tag
-.B common
-which will be included in all selections;
-if any lines appear in
-.B plan9.ini
-before the first block,
-they are treated as a
-.B common
-block.
-.LP
-Within the
-.B menu
-block the following configuration lines are allowed:
-.SS \fLmenuitem=tag[, description]
-The block identified by
-.B tag
-will appear in the presented menu.
-The menu entry will consist of the
-.B tag
-unless the optional
-.B description
-is given.
-.SS \fLmenudefault=tag[, timeout]
-Identifies a default block to be given in the
-menu selection prompt.
-If the optional
-.B timeout
-is given (in seconds),
-the default block will be selected if there is no user
-input within the timeout period.
-.SS \fLmenuconsole=value[, baud]
-Selects a serial console upon which to present the menu
-as no
-.B console
-or
-.B baud
-configuration information will have been processed yet
-(the
-.B plan9.ini
-contents are still to be decided...).
-.LP
-In response to the menu being printed,
-the user is prompted to select a menu item from the list.
-If the numeric response is followed by a
-.BR p ,
-the selected configuration is printed and the menu presented
-again.
-.LP
-The line
-.EX
-       menuitem=tag
-.EE
-is prefixed to the selected configuration as an aid to
-user-level initialization scripts.
 .SH EXAMPLES
 .PP
 A representative
 .BR plan9.ini :
 .IP
 .EX
-% cat /n/c:/plan9.ini
+% cat /n/9fat:/plan9.ini
 ether0=type=3C509
 mouseport=ps2
 modemport=1
 serial0=type=generic port=0x3E8 irq=5
 monitor=445x
 vgasize=1600x1200x8
+bootfile=/386/9pcf
 %
 .EE
-.PP
-Minimum CONFIG.SYS and AUTOEXEC.BAT files to use
-COM2 as a console:
-.IP
-.EX
-% cat /n/c:/config.sys
-SHELL=COMMAND.COM COM2 /P
-% cat /n/c:/autoexec.bat
-@ECHO OFF
-PROMPT $p$g
-PATH C:\eDOS;C:\eBIN
-mode com2:96,n,8,1,p
-SET TEMP=C:\eTMP
-%
-.EE
-.PP
-Simple
-.B plan9.ini
-with multiple configurations:
-.IP
-.EX
-[menu]
-menuitem=vga, Plan 9 with VGA
-menuitem=novga, Plan 9 no automatic VGA
-menudefault=vga
-
-[vga]
-monitor=multisync135
-vgasize=1024x768x8
-
-[novga]
-
-[common]
-ether0=type=i82557
-audio0=type=sb16 port=0x220 irq=5 dma=1
-.EE
-.PP
-With this, the following menu will be presented on boot:
-.IP
-.EX
-Plan 9 Startup Menu:
-====================
-    1. Plan 9 with VGA
-    2. Plan 9 no automatic VGA
-Selection[default==1]:
-.EE
-.PP
-Selecting item 1 generates the following
-.B plan9.ini
-to be used by the remainder of the bootstrap process:
-.IP
-.EX
-menuitem=vga
-monitor=multisync135
-vgasize=1024x768x8
-ether0=type=i82557
-audio0=type=sb16 port=0x220 irq=5 dma=1
-.EE
-.PP
-and selecting item 2:
-.IP
-.EX
-menuitem=novga
-ether0=type=i82557
-audio0=type=sb16 port=0x220 irq=5 dma=1
-.EE
 .SH "SEE ALSO"
-.IR 9load (8),
+.IR 9boot (8),
 .IR booting (8),
 .IR boot (8)
 .SH BUGS