|
@@ -1,15 +1,21 @@
|
|
|
.TH PLAN9.INI 8
|
|
|
.SH NAME
|
|
|
-plan9.ini \- configuration file for PCs
|
|
|
+plan9.ini \- configuration file primarily for PCs
|
|
|
.SH SYNOPSIS
|
|
|
.I none
|
|
|
.SH DESCRIPTION
|
|
|
-When booting Plan 9 on a PC, the DOS program
|
|
|
+When booting Plan 9 on a PC, the bootstrap programs described in
|
|
|
.IR 9load (8)
|
|
|
-first reads a DOS file
|
|
|
-containing configuration information from the boot disk.
|
|
|
+first read,
|
|
|
+via TFTP or a FAT filesystem on the boot disk,
|
|
|
+a file containing configuration information.
|
|
|
This file,
|
|
|
-.BR plan9.ini ,
|
|
|
+.BI /cfg/pxe/ hex-digits
|
|
|
+(TFTP; see
|
|
|
+.IR 9load (8))
|
|
|
+or
|
|
|
+.B plan9.ini
|
|
|
+(FAT),
|
|
|
looks like a shell script containing lines of the form
|
|
|
.IP
|
|
|
.EX
|
|
@@ -17,16 +23,6 @@ name=\f2value\fP
|
|
|
.EE
|
|
|
.LP
|
|
|
each of which defines a kernel or device parameter.
|
|
|
-If
|
|
|
-.I 9load
|
|
|
-or
|
|
|
-.I 9pxeload
|
|
|
-loads the kernel over the network instead,
|
|
|
-this file will be named
|
|
|
-.BI /cfg/pxe/ hex-digits
|
|
|
-(see
|
|
|
-.IR 9load (8))
|
|
|
-on the local TFTP server.
|
|
|
.PP
|
|
|
Blank lines and
|
|
|
Carriage Returns
|
|
@@ -53,21 +49,25 @@ 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 bootstrap programs
|
|
|
+and the kernel to configure the hardware available,
|
|
|
+although nowadays the kernel can usually detect the attached hardware
|
|
|
+by itself.
|
|
|
The information it contains is also passed to the boot
|
|
|
process, and subsequently other programs,
|
|
|
as environment variables
|
|
|
(see
|
|
|
.IR boot (8)).
|
|
|
However, values whose names begin with an asterisk
|
|
|
-.B *
|
|
|
-are used by the kernel and are not converted into environment variables.
|
|
|
+.L *
|
|
|
+are used by the kernel and are stored in
|
|
|
+.L #ec
|
|
|
+rather than
|
|
|
+.LR #e .
|
|
|
.PP
|
|
|
The following sections describe how variables are used.
|
|
|
.SS ETHERNET
|
|
|
-.SS \fLetherX=value\fP
|
|
|
+.SS \fLetherX=\fIvalue
|
|
|
This defines an Ethernet interface.
|
|
|
.IR X ,
|
|
|
a unique monotonically increasing number beginning at 0,
|
|
@@ -81,9 +81,10 @@ detected are added.
|
|
|
Almost all cards can be automatically detected.
|
|
|
For debugging purposes, automatic probing can
|
|
|
be disabled by specifying the line
|
|
|
-.BR *noetherprobe= .
|
|
|
+.LR *noetherprobe= .
|
|
|
+.ig
|
|
|
This automatic probing is only done by the kernel, not by
|
|
|
-.IR 9load (8).
|
|
|
+the bootstrap programs.
|
|
|
Thus, if you want to load a kernel over the Ethernet, you need
|
|
|
to specify an
|
|
|
.B ether0
|
|
@@ -91,6 +92,7 @@ line so that
|
|
|
.I 9load
|
|
|
can find the Ethernet card, even if the kernel would
|
|
|
have automatically detected it.
|
|
|
+..
|
|
|
.PP
|
|
|
Some cards are software configurable and do not require all options.
|
|
|
Unspecified options default to the factory defaults.
|
|
@@ -98,7 +100,6 @@ Unspecified options default to the factory defaults.
|
|
|
Known
|
|
|
.IR TYPE s
|
|
|
are
|
|
|
-.\" .TF ga620
|
|
|
.TF vt6102
|
|
|
.PD
|
|
|
.TP
|
|
@@ -122,6 +123,7 @@ and other cards using the Alteon Acenic chip such as the
|
|
|
Alteon Acenic fiber and copper cards,
|
|
|
the DEC DEGPA-SA and the SGI Acenic.
|
|
|
Completely configurable.
|
|
|
+Can't boot through these due to enormous firmware loads.
|
|
|
.TP
|
|
|
.B dp83820
|
|
|
National Semiconductor DP83820-based Gigabit Ethernet adapters, notably
|
|
@@ -140,9 +142,6 @@ Can't boot through these due to enormous firmware loads.
|
|
|
.B i82598
|
|
|
The Intel 8259[89] 10-Gigabit Ethernet PCI-Express controllers.
|
|
|
Completely configurable.
|
|
|
-Can't boot through these due to lack of a
|
|
|
-.I 9load
|
|
|
-driver.
|
|
|
.TP
|
|
|
.B i82557
|
|
|
Cards using the Intel 8255[789] Fast Ethernet PCI Bus LAN Controller such as the
|
|
@@ -191,6 +190,9 @@ Completely configurable.
|
|
|
.B vt6102
|
|
|
The VIA VT6102 Fast Ethernet Controller (Rhine II).
|
|
|
.TP
|
|
|
+.B vt6105m
|
|
|
+The VIA VT6105M Fast Ethernet Controller (Rhine III).
|
|
|
+.TP
|
|
|
.B smc91cxx
|
|
|
SMC 91cXX chip-based PCMCIA adapters, notably the SMC EtherEZ card.
|
|
|
.TP
|
|
@@ -409,7 +411,8 @@ Intersil Prism 2.5 chipset.
|
|
|
(S)ATA controllers are autodetected.
|
|
|
.SS \fLusbX=type=uhci\fP
|
|
|
.SS \fLusbX=type=ohci\fP
|
|
|
-This specifies the settings for a USB UHCI or OHCI controller.
|
|
|
+.SS \fLusbX=type=ehci\fP
|
|
|
+This specifies the settings for a USB UHCI, OHCI or EHCI controller.
|
|
|
Like the Ethernet controllers, USB controllers are autodetected
|
|
|
after scanning for the ones listed in
|
|
|
.IR plan9.ini .
|
|
@@ -419,7 +422,7 @@ line.
|
|
|
Also like the Ethernet controllers, USB autoprobing can be
|
|
|
disabled by specifying the line
|
|
|
.BR *nousbprobe= .
|
|
|
-.SS \fLscsiX=value\fP
|
|
|
+.SS \fLscsiX=\fIvalue
|
|
|
This defines a SCSI interface which cannot be automatically detected
|
|
|
by the kernel.
|
|
|
.PP
|
|
@@ -466,8 +469,8 @@ and
|
|
|
.I slot
|
|
|
to use as a root device for bootstrapping.
|
|
|
.SS AUDIO
|
|
|
-.SS \fLaudioX=value\fP
|
|
|
-This defines a sound interface.
|
|
|
+.SS \fLaudioX=\fIvalue
|
|
|
+This defines a pre-USB sound interface.
|
|
|
.PP
|
|
|
Known types are
|
|
|
.TF ess1688
|
|
@@ -515,7 +518,7 @@ and need no configuration lines.
|
|
|
The line
|
|
|
.B serial=type=com
|
|
|
can be used to specify settings for a PCMCIA modem.
|
|
|
-.SS \fLmouseport=value\fP
|
|
|
+.SS \fLmouseport=\fIvalue
|
|
|
This specifies where the mouse is attached.
|
|
|
.I Value
|
|
|
can be
|
|
@@ -532,13 +535,13 @@ for COM1
|
|
|
.TP
|
|
|
.B 1
|
|
|
for COM2
|
|
|
-.SS \fLmodemport=value\fP
|
|
|
+.SS \fLmodemport=\fIvalue
|
|
|
Picks the UART line to call out on.
|
|
|
This is used when connecting to a file server over
|
|
|
an async line.
|
|
|
.I Value
|
|
|
is the number of the port.
|
|
|
-.SS \fLconsole=value params\fP
|
|
|
+.SS \fLconsole=\fIvalue params
|
|
|
This is used to specify the console device.
|
|
|
The default
|
|
|
value is
|
|
@@ -581,7 +584,7 @@ with odd parity.
|
|
|
.SS "PC CARD"
|
|
|
.SS \fLpccard0=disabled\fP
|
|
|
Disable probing for and automatic configuration of PC card controllers.
|
|
|
-.SS \fLpcmciaX=type=XXX irq=value\fP
|
|
|
+.SS \fLpcmciaX=type=XXX irq=\fIirq
|
|
|
If the default IRQ for the
|
|
|
PCMCIA
|
|
|
is correct, this entry can be omitted. The value of
|
|
@@ -589,15 +592,49 @@ is correct, this entry can be omitted. The value of
|
|
|
is ignored.
|
|
|
.SS \fLpcmcia0=disabled\fP
|
|
|
Disable probing for and automatic configuration of PCMCIA controllers.
|
|
|
+.SS NVRAM
|
|
|
+.SS \fLnvram=\fIfile\fP
|
|
|
+.SS \fLnvrlen=\fIlength\fP
|
|
|
+.SS \fLnvroff=\fIoffset\fP
|
|
|
+This is used to specify an nvram device and optionally the length of the ram
|
|
|
+and read/write offset to use.
|
|
|
+These values are consulted by
|
|
|
+.I readnvram
|
|
|
+(see
|
|
|
+.IR authsrv (2)).
|
|
|
+The most common use of the nvram is to hold a
|
|
|
+.IR secstore (1)
|
|
|
+password for use by
|
|
|
+.IR factotum (4).
|
|
|
+.SS \fLnvr=\fIvalue
|
|
|
+This is used by the WORM file server kernel to locate a file holding information
|
|
|
+to configure the file system.
|
|
|
+The file cannot live on a SCSI disk.
|
|
|
+The default is
|
|
|
+.B fd!0!plan9.nvr
|
|
|
+(sic),
|
|
|
+unless
|
|
|
+.B bootfile
|
|
|
+is set, in which case it is
|
|
|
+.B plan9.nvr
|
|
|
+on the same disk as
|
|
|
+.BR bootfile .
|
|
|
+The syntax is either
|
|
|
+.BI fd! unit ! name
|
|
|
+or
|
|
|
+.BI hd! unit ! name
|
|
|
+where
|
|
|
+.I unit
|
|
|
+is the numeric unit id.
|
|
|
+This variant syntax is a vestige of the file server kernel's origins.
|
|
|
.SS BOOTING
|
|
|
-.SS \fLbootfile=value\fP
|
|
|
+.SS \fLbootfile=\fIvalue
|
|
|
This is used to direct the actions of
|
|
|
-.IR 9load (8)
|
|
|
+the bootstrap programs
|
|
|
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)
|
|
|
+.SS \fLrootdir=\fIdir
|
|
|
+.SS \fLrootspec=\fIspec
|
|
|
+These are used by the bootstrap programs
|
|
|
to identify the directory
|
|
|
.I dir
|
|
|
to make the root directory for the kernel, and the
|
|
@@ -609,7 +646,7 @@ in
|
|
|
.IR bind (2))
|
|
|
on which it can be found.
|
|
|
These are usually used to test variant file systems for distributions, etc.
|
|
|
-.SS \fLbootargs=value\fP
|
|
|
+.SS \fLbootargs=\fIargs
|
|
|
The value of this variable is passed to
|
|
|
.IR boot (8)
|
|
|
by the kernel as the name of the root file system.
|
|
@@ -625,17 +662,17 @@ partition, the definition might read
|
|
|
See
|
|
|
.IR boot (8)
|
|
|
for more.
|
|
|
-.SS \fLnobootprompt=value\fP
|
|
|
+.SS \fLnobootprompt=\fIroot
|
|
|
Suppress the
|
|
|
.L "root from"
|
|
|
prompt and use
|
|
|
-.I value
|
|
|
+.I root
|
|
|
as the answer instead.
|
|
|
-.SS \fLuser=value\fP
|
|
|
+.SS \fLuser=\fIuser
|
|
|
Suppress the
|
|
|
.L "user"
|
|
|
prompt and use
|
|
|
-.I value
|
|
|
+.I user
|
|
|
as the answer instead.
|
|
|
.SS \fLdebugfactotum=\fP
|
|
|
Causes
|
|
@@ -645,7 +682,7 @@ to start
|
|
|
with the
|
|
|
.B -p
|
|
|
option, so that it can be debugged.
|
|
|
-.SS \fLfactotumopts=options\fP
|
|
|
+.SS \fLfactotumopts=\fIoptions
|
|
|
Causes
|
|
|
.IR boot (8)
|
|
|
to start
|
|
@@ -653,7 +690,7 @@ to start
|
|
|
with the given
|
|
|
.IR options ,
|
|
|
which must be a single word (i.e., contain no whitespace).
|
|
|
-.SS \fLventi=value\fP
|
|
|
+.SS \fLventi=\fIvalue
|
|
|
When booting from a local fossil server backed by a local
|
|
|
or remote venti server,
|
|
|
this variable specifies how to establish the connection to the
|
|
@@ -661,22 +698,22 @@ venti server.
|
|
|
See
|
|
|
.IR boot (8)
|
|
|
for more.
|
|
|
-.SS \fLcfs=value\fP
|
|
|
-This gives the name of the file holding the disk partition
|
|
|
+.SS \fLcfs=\fIpartition
|
|
|
+This names the file holding the disk partition
|
|
|
for the cache file system,
|
|
|
.IR cfs (4).
|
|
|
Extending the
|
|
|
.B bootargs
|
|
|
example, one would write
|
|
|
.BR cfs=#S/sdC0/cache .
|
|
|
-.SS \fLbootdisk=value\fP
|
|
|
+.SS \fLbootdisk=\fIvalue
|
|
|
This deprecated variable was used to specify the disk used by
|
|
|
the cache file system and other disk-resident services.
|
|
|
It is superseded by
|
|
|
.B bootargs
|
|
|
and
|
|
|
.BR cfs .
|
|
|
-.SS \fLpartition=value\fP
|
|
|
+.SS \fLpartition=\fIvalue
|
|
|
This defines the partition table
|
|
|
.IR 9load (8)
|
|
|
will examine to find disk partitioning information.
|
|
@@ -691,7 +728,7 @@ consults only the first table,
|
|
|
only the second.
|
|
|
.SS \fLreadparts=\fP
|
|
|
Causes
|
|
|
-.I boot
|
|
|
+.IR boot (8)
|
|
|
to look for MBR and Plan 9 partition tables on all
|
|
|
.IR sd (3)
|
|
|
disks, even before
|
|
@@ -699,10 +736,12 @@ disks, even before
|
|
|
is started, so NVRAM, for example, may be found.
|
|
|
On PCs,
|
|
|
.I 9load
|
|
|
-normally does this,
|
|
|
-so this variable is intended for other architectures.
|
|
|
-.SS \fLfs=a.b.c.d\fP
|
|
|
-.SS \fLauth=a.b.c.d\fP
|
|
|
+(but not
|
|
|
+.IR 9load )
|
|
|
+normally does this and passes the partitions found in
|
|
|
+.BR #ec/sd\fICn\fPpart .
|
|
|
+.SS \fLfs=\fIa.b.c.d
|
|
|
+.SS \fLauth=\fIa.b.c.d
|
|
|
These specify the IP address of the file and authentication server
|
|
|
to use when mounting a network-provided root file system.
|
|
|
They are used only if the addresses cannot be determined via DHCP.
|
|
@@ -714,7 +753,7 @@ This variable disables such switches.
|
|
|
.SS \fL*noe820scan=\fP
|
|
|
When available, the PC kernel uses the BIOS E820 memory map
|
|
|
to size memory. This variable disables the scan.
|
|
|
-.SS \fL*maxmem=value\fP
|
|
|
+.SS \fL*maxmem=\fIaddress
|
|
|
This defines the maximum physical address that the system will scan when sizing memory.
|
|
|
By default the PC operating system will scan up to 3.75 gigabytes
|
|
|
(0xF0000000, the base of kernel virtual address space), but setting
|
|
@@ -723,10 +762,10 @@ will limit the scan.
|
|
|
.B *maxmem
|
|
|
must be less than 3.75 gigabytes.
|
|
|
This variable is not consulted if using the E820 memory map.
|
|
|
-.SS \fL*kernelpercent=value\fP
|
|
|
-This defines what percentage of available memory is reserved for the kernel allocation pool.
|
|
|
+.SS \fL*kernelpercent=\fIpercent
|
|
|
+This defines the percentage of available memory reserved for the kernel allocation pool.
|
|
|
The remainder is left for user processes. The default
|
|
|
-.I value
|
|
|
+.I percent
|
|
|
is
|
|
|
.B 30
|
|
|
on CPU servers,
|
|
@@ -739,7 +778,7 @@ Terminals use more kernel memory because
|
|
|
.IR draw (3)
|
|
|
maintains its graphic images in kernel memory.
|
|
|
This deprecated option is rarely necessary in newer kernels.
|
|
|
-.SS \fL*nomce=value\fP
|
|
|
+.SS \fL*nomce=\fIvalue
|
|
|
If machine check exceptions are supported by the processor,
|
|
|
then they are enabled by default.
|
|
|
Setting this variable to
|
|
@@ -751,23 +790,23 @@ Setting
|
|
|
.B *nomp
|
|
|
restricts the kernel to starting only one processor and using the
|
|
|
traditional interrupt controller.
|
|
|
-.SS \fL*ncpu=value\fP
|
|
|
+.SS \fL*ncpu=\fIcpus\fP
|
|
|
Setting
|
|
|
.B *ncpu
|
|
|
restricts the kernel to starting at most
|
|
|
-.I value
|
|
|
+.I cpus
|
|
|
processors.
|
|
|
-.SS \fL*pcimaxbno=value\fP
|
|
|
-This puts a limit on the maximum bus number probed
|
|
|
+.SS \fL*pcimaxbno=\fIbno\fP
|
|
|
+Limits the maximum bus number probed
|
|
|
on a PCI bus (default 7).
|
|
|
For example, a
|
|
|
-.I value
|
|
|
+.I bno
|
|
|
of 1 should suffice on a 'standard' motherboard with an AGP slot.
|
|
|
This, and
|
|
|
.B *pcimaxdno
|
|
|
below are rarely used and only on troublesome or suspect hardware.
|
|
|
-.SS \fL*pcimaxdno=value\fP
|
|
|
-This puts a limit on the maximum device number probed
|
|
|
+.SS \fL*pcimaxdno=\fIdno\fP
|
|
|
+Limits the maximum device number probed
|
|
|
on a PCI bus (default 31).
|
|
|
.SS \fL*nopcirouting=\fP
|
|
|
Disable pci routing during boot. May solve interrupt routing
|
|
@@ -778,14 +817,14 @@ Useful if there is only a limited cga screen available,
|
|
|
otherwise the textual information about the panic may scroll off.
|
|
|
.\" .SS \fL*nobios=\fP
|
|
|
.\" what does this do? something with pci
|
|
|
-.SS \fLioexclude=value\fP
|
|
|
+.SS \fLioexclude=\fIrange\fP
|
|
|
Specifies a list of ranges of I/O ports to exclude from use by drivers.
|
|
|
Ranges are inclusive on both ends and separated by commas.
|
|
|
For example:
|
|
|
.EX
|
|
|
ioexclude=0x330-0x337,0x430-0x43F
|
|
|
.EE
|
|
|
-.SS \fLumbexclude=value\fP
|
|
|
+.SS \fLumbexclude=\fIrange\fP
|
|
|
Specifies a list of ranges of UMB to exclude from use by drivers.
|
|
|
Ranges are inclusive on both ends and separated by commas.
|
|
|
For example:
|
|
@@ -803,15 +842,15 @@ battery life (see
|
|
|
.IR stats (8)).
|
|
|
It is not on by default because it causes problems on some laptops.
|
|
|
.SS VIDEO
|
|
|
-.SS \fLmonitor=value\fP
|
|
|
-.SS \fLvgasize=value\fP
|
|
|
+.SS \fLmonitor=\fImonitor
|
|
|
+.SS \fLvgasize=\fIx\fPx\fIy\fPx\fId
|
|
|
These are used not by the kernel but by
|
|
|
.I termrc
|
|
|
(see
|
|
|
.IR cpurc (8))
|
|
|
when starting
|
|
|
.IR vga (8).
|
|
|
-.SS \fL*dpms=value\fP
|
|
|
+.SS \fL*dpms=\fIvalue
|
|
|
This is used to specify the screen blanking behavior of the MGA4xx
|
|
|
video driver.
|
|
|
Values are
|
|
@@ -821,41 +860,6 @@ and
|
|
|
.BR off .
|
|
|
The first two specify differing levels of power saving;
|
|
|
the third turns the monitor off completely.
|
|
|
-.SS NVRAM
|
|
|
-.SS \fLnvram=file\fP
|
|
|
-.SS \fLnvrlen=length\fP
|
|
|
-.SS \fLnvroff=offset\fP
|
|
|
-This is used to specify an nvram device and optionally the length of the ram
|
|
|
-and read/write offset to use.
|
|
|
-These values are consulted by
|
|
|
-.I readnvram
|
|
|
-(see
|
|
|
-.IR authsrv (2)).
|
|
|
-The most common use of the nvram is to hold a
|
|
|
-.IR secstore (1)
|
|
|
-password for use by
|
|
|
-.IR factotum (4).
|
|
|
-.SS \fLnvr=value\fP
|
|
|
-This is used by the WORM file server kernel to locate a file holding information
|
|
|
-to configure the file system.
|
|
|
-The file cannot live on a SCSI disk.
|
|
|
-The default is
|
|
|
-.B fd!0!plan9.nvr
|
|
|
-(sic),
|
|
|
-unless
|
|
|
-.B bootfile
|
|
|
-is set, in which case it is
|
|
|
-.B plan9.nvr
|
|
|
-on the same disk as
|
|
|
-.BR bootfile .
|
|
|
-The syntax is either
|
|
|
-.BI fd! unit ! name
|
|
|
-or
|
|
|
-.BI hd! unit ! name
|
|
|
-where
|
|
|
-.I unit
|
|
|
-is the numeric unit id.
|
|
|
-This variant syntax is a vestige of the file server kernel's origins.
|
|
|
.SS Multiple Configurations
|
|
|
.PP
|
|
|
A
|