xfnw/plan9fox
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

plan.ini(8): document new kernel options

Browse source
This commit is contained in:
cinap_lenrek 2011-11-05 05:17:26 +01:00
parent 0bddb7e28d
commit d8c69ebafd
1 changed files with 68 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

113
sys/man/8/plan9.ini
View file

@ -55,7 +55,7 @@ are used by the kernel and are not converted into environment variables.
.PP .PP
The following sections describe how variables are used. The following sections describe how variables are used.
.SS ETHERNET .SS ETHERNET
.SS \fLetherX=value\fP .SS \fLether\fIX\fL=\fIvalue\fP
This defines an Ethernet interface. This defines an Ethernet interface.
.IR X , .IR X ,
a unique monotonically increasing number beginning at 0, a unique monotonically increasing number beginning at 0,
@ -384,8 +384,10 @@ Intersil Prism 2.5 chipset.
.SS DISKS, TAPES .SS DISKS, TAPES
(S)ATA controllers are autodetected. (S)ATA controllers are autodetected.
.SS \fL*nodma=\fP .SS \fL*nodma=\fP
disable DMA on ata devices. disables dma on ata devices.
.SS \fLscsiX=value\fP .SS \fL*sd\fIXX\fLdma=on\fP
explicitly enables dma on a specific ata device.
.SS \fLscsi\fIX\fL=value\fP
This defines a SCSI interface which cannot be automatically detected This defines a SCSI interface which cannot be automatically detected
by the kernel. by the kernel.
.PP .PP
@ -432,7 +434,7 @@ and
.I slot .I slot
to use as a root device for bootstrapping. to use as a root device for bootstrapping.
.SS AUDIO .SS AUDIO
.SS \fLaudioX=value\fP .SS \fLaudio\fIX\fL=\fIvalue\fP
This defines a sound interface. This defines a sound interface.
.PP .PP
Known types are Known types are
@ -481,7 +483,7 @@ and need no configuration lines.
The line The line
.B serial=type=com .B serial=type=com
can be used to specify settings for a PCMCIA modem. can be used to specify settings for a PCMCIA modem.
.SS \fLmouseport=value\fP .SS \fLmouseport=\fIvalue\fP
This specifies where the mouse is attached. This specifies where the mouse is attached.
.I Value .I Value
can be can be
@ -498,16 +500,17 @@ for COM1
.TP .TP
.B 1 .B 1
for COM2 for COM2
.SS \fLmodemport=value\fP .SS \fLmodemport=\fIvalue\fP
Picks the UART line to call out on. Picks the UART line to call out on.
This is used when connecting to a file server over This is used when connecting to a file server over
an async line. an async line.
.I Value .I Value
is the number of the port. is the number of the port.
.SS \fLconsole=value params\fP .SS \fLconsole=\fIvalue params\fP
This is used to specify the console device. This is used to specify the console device.
The default The default
value is .I value
is
.BR cga ; .BR cga ;
a number a number
.B 0 .B 0
@ -547,7 +550,7 @@ with odd parity.
.SS "PC CARD" .SS "PC CARD"
.SS \fLpccard0=disabled\fP .SS \fLpccard0=disabled\fP
Disable probing for and automatic configuration of PC card controllers. Disable probing for and automatic configuration of PC card controllers.
.SS \fLpcmciaX=type=XXX irq=value\fP .SS \fLpcmcia\fIX\fL=type=XXX irq=\fIvalue\fP
If the default IRQ for the If the default IRQ for the
PCMCIA PCMCIA
is correct, this entry can be omitted. The value of is correct, this entry can be omitted. The value of
@ -556,34 +559,37 @@ is ignored.
.SS \fLpcmcia0=disabled\fP .SS \fLpcmcia0=disabled\fP
Disable probing for and automatic configuration of PCMCIA controllers. Disable probing for and automatic configuration of PCMCIA controllers.
.SS BOOTING .SS BOOTING
.SS \fLbootfile=value\fP .SS \fLbootfile=\fIvalue\fP
This is used to direct the actions of This is used to direct the actions of
.IR 9boot (8) .IR 9boot (8)
by naming the file from which to load the kernel in by naming the file from which to load the kernel in
the current BIOS boot device. the current BIOS boot device.
.SS \fLbootargs=value\fP .SS \fLbootargs=\fIvalue\fP
The value of this variable is passed to The
.I value
of this variable is passed to
.IR boot (8) .IR boot (8)
by the kernel as the name of the root file system. by the kernel as the name of the root file system to
automatically mount and boot into.
It is typically used to specify additional arguments to It is typically used to specify additional arguments to
pass to pass to
.IR kfs (4) .IR cwfs (4)
or or
.IR ipconfig (8). .IR ipconfig (8).
For example, if the system is to run from a local For example, if the system is to run from a local
.IR kfs (4) .IR cwfs (4)
partition, the definition might read partition, the definition might read
.BR bootargs=local!#S/sdC0/fs . .BR bootargs=local!/dev/sdC0/fscache .
See See
.IR boot (8) .IR boot (8)
for more. for more.
.SS \fLnobootprompt=value\fP .SS \fLnobootprompt=\fIvalue\fP
Suppress the Suppress the
.L "root from" .L "root from"
prompt and use prompt and use
.I value .I value
as the answer instead. as the answer instead.
.SS \fLuser=value\fP .SS \fLuser=\fIvalue\fP
Suppress the Suppress the
.L "user" .L "user"
prompt and use prompt and use
@ -597,7 +603,7 @@ to start
with the with the
.B -p .B -p
option, so that it can be debugged. option, so that it can be debugged.
.SS \fLfactotumopts=options\fP .SS \fLfactotumopts=\fIoptions\fP
Causes Causes
.IR boot (8) .IR boot (8)
to start to start
@ -605,15 +611,7 @@ to start
with the given with the given
.IR options , .IR options ,
which must be a single word (i.e., contain no whitespace). which must be a single word (i.e., contain no whitespace).
.SS \fLventi=value\fP .SS \fLcfs=\fIvalue\fP
When booting from a local server backed by a local
or remote venti server,
this variable specifies how to establish the connection to the
venti server.
See
.IR boot (8)
for more.
.SS \fLcfs=value\fP
This gives the name of the file holding the disk partition This gives the name of the file holding the disk partition
for the cache file system, for the cache file system,
.IR cfs (4). .IR cfs (4).
@ -621,19 +619,29 @@ Extending the
.B bootargs .B bootargs
example, one would write example, one would write
.BR cfs=#S/sdC0/cache . .BR cfs=#S/sdC0/cache .
.SS \fLbootdisk=value\fP .SS \fLbootdisk=\fIvalue\fP
This deprecated variable was used to specify the disk used by This deprecated variable was used to specify the disk used by
the cache file system and other disk-resident services. the cache file system and other disk-resident services.
It is superseded by It is superseded by
.B bootargs .B bootargs
and and
.BR cfs . .BR cfs .
.SS \fLfs=a.b.c.d\fP .SS \fLfs=\fIa.b.c.d\fP
.SS \fLauth=a.b.c.d\fP .SS \fLauth=\fIa.b.c.d\fP
These specify the IP address of the file and authentication server These specify the IP address of the file and authentication server
to use when mounting a network-provided root file system. to use when mounting a network-provided root file system.
They are used only if the addresses cannot be determined via DHCP. They are used only if the addresses cannot be determined via DHCP.
.SS PROCESSOR .SS PROCESSOR
.SS \fLe820=\fIstart end ...\fP
This variable is automatically generated by the boot loader (see
.IR 9boot (8))
by doing a BIOS E820 memory scan while still in realmode and
passed to the kernel. The format is a unordered list of
hexadecimal 64-bit
.I start
and
.I end
addresses of the usable memory areas.
.SS \fL*norealmode=\fP .SS \fL*norealmode=\fP
The PC kernel switches the processor to 16-bit real mode The PC kernel switches the processor to 16-bit real mode
to run BIOS interrupts, for example to find the memory map or to enable VESA. to run BIOS interrupts, for example to find the memory map or to enable VESA.
@ -641,7 +649,7 @@ This variable disables such switches.
.SS \fL*noe820scan=\fP .SS \fL*noe820scan=\fP
When available, the PC kernel uses the BIOS E820 memory map When available, the PC kernel uses the BIOS E820 memory map
to size memory. This variable disables the scan. to size memory. This variable disables the scan.
.SS \fL*maxmem=value\fP .SS \fL*maxmem=\fIvalue\fP
This defines the maximum physical address that the system will scan when sizing memory. 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 By default the PC operating system will scan up to 3.75 gigabytes
(0xF0000000, the base of kernel virtual address space), but setting (0xF0000000, the base of kernel virtual address space), but setting
@ -650,7 +658,7 @@ will limit the scan.
.B *maxmem .B *maxmem
must be less than 3.75 gigabytes. must be less than 3.75 gigabytes.
This variable is not consulted if using the E820 memory map. This variable is not consulted if using the E820 memory map.
.SS \fL*kernelpercent=value\fP .SS \fL*kernelpercent=\fIvalue\fP
This defines what percentage of available memory is reserved for the kernel allocation pool. This defines what percentage of available memory is reserved for the kernel allocation pool.
The remainder is left for user processes. The default The remainder is left for user processes. The default
.I value .I value
@ -666,7 +674,7 @@ Terminals use more kernel memory because
.IR draw (3) .IR draw (3)
maintains its graphic images in kernel memory. maintains its graphic images in kernel memory.
This deprecated option is rarely necessary in newer kernels. This deprecated option is rarely necessary in newer kernels.
.SS \fL*nomce=value\fP .SS \fL*nomce=\fIvalue\fP
If machine check exceptions are supported by the processor, If machine check exceptions are supported by the processor,
then they are enabled by default. then they are enabled by default.
Setting this variable to Setting this variable to
@ -678,12 +686,18 @@ Setting
.B *nomp .B *nomp
restricts the kernel to starting only one processor and using the restricts the kernel to starting only one processor and using the
traditional interrupt controller. traditional interrupt controller.
.SS \fL*ncpu=value\fP .SS \fL*ncpu=\fIvalue\fP
Setting Setting
.B *ncpu .B *ncpu
restricts the kernel to starting at most restricts the kernel to starting at most
.I value .I value
processors. processors.
.SS \fL*msi=\fP
Enables message signaled interrupts on devices that support it (see
.IR icanhasmsi (8)).
It is mutually exclusive with the
.B *nomp=
option.
.SS \fL*pcimaxbno=value\fP .SS \fL*pcimaxbno=value\fP
This puts a limit on the maximum bus number probed This puts a limit on the maximum bus number probed
on a PCI bus (default 7). on a PCI bus (default 7).
@ -693,7 +707,7 @@ of 1 should suffice on a 'standard' motherboard with an AGP slot.
This, and This, and
.B *pcimaxdno .B *pcimaxdno
below are rarely used and only on troublesome or suspect hardware. below are rarely used and only on troublesome or suspect hardware.
.SS \fL*pcimaxdno=value\fP .SS \fL*pcimaxdno=\fIvalue\fP
This puts a limit on the maximum device number probed This puts a limit on the maximum device number probed
on a PCI bus (default 31). on a PCI bus (default 31).
.SS \fL*nopcirouting=\fP .SS \fL*nopcirouting=\fP
@ -705,14 +719,14 @@ Useful if there is only a limited cga screen available,
otherwise the textual information about the panic may scroll off. otherwise the textual information about the panic may scroll off.
.\" .SS \fL*nobios=\fP .\" .SS \fL*nobios=\fP
.\" what does this do? something with pci .\" what does this do? something with pci
.SS \fLioexclude=value\fP .SS \fLioexclude=\fIvalue\fP
Specifies a list of ranges of I/O ports to exclude from use by drivers. 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. Ranges are inclusive on both ends and separated by commas.
For example: For example:
.EX .EX
ioexclude=0x330-0x337,0x430-0x43F ioexclude=0x330-0x337,0x430-0x43F
.EE .EE
.SS \fLumbexclude=value\fP .SS \fLumbexclude=\fIvalue\fP
Specifies a list of ranges of UMB to exclude from use by drivers. Specifies a list of ranges of UMB to exclude from use by drivers.
Ranges are inclusive on both ends and separated by commas. Ranges are inclusive on both ends and separated by commas.
For example: For example:
@ -730,15 +744,20 @@ battery life (see
.IR stats (8)). .IR stats (8)).
It is not on by default because it causes problems on some laptops. It is not on by default because it causes problems on some laptops.
.SS VIDEO .SS VIDEO
.SS \fLmonitor=value\fP .SS \fLmonitor=\fIvalue\fP
.SS \fLvgasize=value\fP .SS \fLvgasize=\fIvalue\fP
These are used not by the kernel but by These are used not by the kernel but by
.I termrc .I termrc
(see (see
.IR cpurc (8)) .IR cpurc (8))
when starting when starting
.IR vga (8). .IR vga (8).
.SS \fL*dpms=value\fP If
.I value
is set to
.B ask
then the user is prompted for a choice on boot.
.SS \fL*dpms=\fIvalue\fP
This is used to specify the screen blanking behavior of the MGA4xx This is used to specify the screen blanking behavior of the MGA4xx
video driver. video driver.
Values are Values are
@ -748,10 +767,14 @@ and
.BR off . .BR off .
The first two specify differing levels of power saving; The first two specify differing levels of power saving;
the third turns the monitor off completely. the third turns the monitor off completely.
.SS \fL*vesashadow=\fP
This enables the shadow framebuffer or softscreen of the VESA
video driver. This is usefull on devices where access to
the physical framebuffer is slow.
.SS NVRAM .SS NVRAM
.SS \fLnvram=file\fP .SS \fLnvram=\fIfile\fP
.SS \fLnvrlen=length\fP .SS \fLnvrlen=\fIlength\fP
.SS \fLnvroff=offset\fP .SS \fLnvroff=\fIoffset\fP
This is used to specify an nvram device and optionally the length of the ram This is used to specify an nvram device and optionally the length of the ram
and read/write offset to use. and read/write offset to use.
These values are consulted by These values are consulted by
@ -762,7 +785,7 @@ The most common use of the nvram is to hold a
.IR secstore (1) .IR secstore (1)
password for use by password for use by
.IR factotum (4). .IR factotum (4).
.SS \fLnvr=value\fP .SS \fLnvr=\fIvalue\fP
This is used by the WORM file server kernel to locate a file holding information This is used by the WORM file server kernel to locate a file holding information
to configure the file system. to configure the file system.
The file cannot live on a SCSI disk. The file cannot live on a SCSI disk.