plan9.ini 24 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027
  1. .TH PLAN9.INI 8
  2. .SH NAME
  3. plan9.ini \- configuration file primarily for PCs
  4. .SH SYNOPSIS
  5. .I none
  6. .SH DESCRIPTION
  7. When booting Plan 9 on a PC, the bootstrap programs described in
  8. .IR 9boot (8)
  9. first read,
  10. via TFTP or a FAT filesystem on the boot disk,
  11. a file containing configuration information.
  12. This file,
  13. .BI /cfg/pxe/ hex-digits
  14. (TFTP; see
  15. .IR 9boot (8))
  16. or
  17. .B plan9.ini
  18. (FAT),
  19. looks like a shell script containing lines of the form
  20. .IP
  21. .EX
  22. name=\f2value\fP
  23. .EE
  24. .LP
  25. each of which defines a kernel or device parameter.
  26. .PP
  27. Blank lines and
  28. Carriage Returns
  29. .IB ( \er )
  30. are ignored.
  31. .B #
  32. comments are ignored, but are only recognised if
  33. .L #
  34. appears at the start of a line.
  35. .PP
  36. For devices, the generic format of
  37. .I value
  38. is
  39. .IP
  40. .EX
  41. type=TYPE [port=N] [irq=N] [mem=N] [size=N] [dma=N] [ea=N]
  42. .EE
  43. .LP
  44. specifying the controller type,
  45. the base I/O port of the interface, its interrupt
  46. level, the physical starting address of any mapped memory,
  47. the length in bytes of that memory, the DMA channel,
  48. and for Ethernets an override of the physical network address.
  49. Not all elements are relevant to all devices; the relevant values
  50. and their defaults are defined below in the description of each device.
  51. .PP
  52. The file is used by the bootstrap programs
  53. and the kernel to configure the hardware available,
  54. although nowadays the kernel can usually detect the attached hardware
  55. by itself.
  56. The information it contains is also passed to the boot
  57. process, and subsequently other programs,
  58. as environment variables
  59. (see
  60. .IR boot (8)).
  61. However, values whose names begin with an asterisk
  62. .L *
  63. are used by the kernel and are stored in
  64. .L #ec
  65. rather than
  66. .LR #e .
  67. .PP
  68. The following sections describe how variables are used.
  69. .SS ETHERNET
  70. .SS \fLetherX=\fIvalue
  71. This defines an Ethernet interface.
  72. .IR X ,
  73. a unique monotonically increasing number beginning at 0,
  74. identifies an Ethernet card to be probed at system boot.
  75. Probing stops when a card is found or there is no line for
  76. .BR etherX+1 .
  77. After probing as directed by the
  78. .BI ether X
  79. lines, any remaining Ethernet cards that can be automatically
  80. detected are added.
  81. Almost all cards can be automatically detected.
  82. For debugging purposes, automatic probing can
  83. be disabled by specifying the line
  84. .LR *noetherprobe= .
  85. .ig
  86. This automatic probing is only done by the kernel, not by
  87. the bootstrap programs.
  88. Thus, if you want to load a kernel over the Ethernet, you need
  89. to specify an
  90. .B ether0
  91. line so that
  92. .I 9boot
  93. can find the Ethernet card, even if the kernel would
  94. have automatically detected it.
  95. ..
  96. .PP
  97. Many cards are software configurable and do not require all options.
  98. Unspecified options default to the factory defaults.
  99. .PP
  100. Known
  101. .IR TYPE s
  102. are
  103. .TF vt6102
  104. .PD
  105. .TP
  106. .B igbe
  107. The Intel 8254X Gigabit Ethernet controllers,
  108. as found on the Intel PRO/1000 adapters for copper (not fiber).
  109. Completely configurable.
  110. .TP
  111. .B igbepcie
  112. The Intel 8256[36], 8257[12], and 82573[ev] Gigabit Ethernet
  113. PCI-Express controllers.
  114. Completely configurable.
  115. .TP
  116. .B rtl8169
  117. The Realtek 8169 Gigabit Ethernet controller.
  118. Completely configurable.
  119. .TP
  120. .B ga620
  121. Netgear GA620 and GA620T Gigabit Ethernet cards,
  122. and other cards using the Alteon Acenic chip such as the
  123. Alteon Acenic fiber and copper cards,
  124. the DEC DEGPA-SA and the SGI Acenic.
  125. Completely configurable.
  126. .TP
  127. .B dp83820
  128. National Semiconductor DP83820-based Gigabit Ethernet adapters, notably
  129. the D-Link DGE-500T.
  130. Completely configurable.
  131. .TP
  132. .B vgbe
  133. The VIA Velocity Gigabit Ethernet controller.
  134. Known to drive the VIA8237 (ABIT AV8), but at 100Mb/s full-duplex only.
  135. .TP
  136. .B m10g
  137. The Myricom 10-Gigabit Ethernet 10G-PCIE-8A controller.
  138. Completely configurable.
  139. .TP
  140. .B i82598
  141. The Intel 8259[89] 10-Gigabit Ethernet PCI-Express controllers.
  142. Completely configurable.
  143. .TP
  144. .B i82557
  145. Cards using the Intel 8255[789] Fast Ethernet PCI Bus LAN Controller such as the
  146. Intel EtherExpress PRO/100B.
  147. Completely configurable, no options need be given.
  148. If you need to force the media, specify
  149. one of the options (no value)
  150. .BR 10BASE-T ,
  151. .BR 10BASE-2 ,
  152. .BR 10BASE-5 ,
  153. .BR 100BASE-TX ,
  154. .BR 10BASE-TFD ,
  155. .BR 100BASE-TXFD ,
  156. .BR 100BASE-T4 ,
  157. .BR 100BASE-FX ,
  158. or
  159. .BR 100BASE-FXFD .
  160. Completely configurable.
  161. .TP
  162. .B 2114x
  163. Cards using the Digital Equipment (now Intel) 2114x PCI Fast Ethernet Adapter Controller,
  164. for example the Netgear FA310.
  165. Completely configurable, no options need be given.
  166. Media can be specified the same was as for the
  167. .BR i82557 .
  168. Some cards using the
  169. .B PNIC
  170. and
  171. .B PNIC2
  172. near-clone chips may also work.
  173. .TP
  174. .B 83815
  175. National Semiconductor DP83815-based adapters, notably
  176. the Netgear FA311, Netgear FA312, and various SiS built-in
  177. controllers such as the SiS900.
  178. On the SiS controllers, the Ethernet address is not detected properly;
  179. specify it with an
  180. .B ea=
  181. attribute.
  182. Completely configurable.
  183. .TP
  184. .B rtl8139
  185. The Realtek 8139 Fast Ethernet controller.
  186. Completely configurable.
  187. .TP
  188. .B vt6102
  189. The VIA VT6102 Fast Ethernet Controller (Rhine II).
  190. .TP
  191. .B vt6105m
  192. The VIA VT6105M Fast Ethernet Controller (Rhine III).
  193. .TP
  194. .B smc91cxx
  195. SMC 91cXX chip-based PCMCIA adapters, notably the SMC EtherEZ card.
  196. .TP
  197. .B elnk3
  198. The 3COM Etherlink III series of cards including the 5x9, 59x, and 905 and 905B.
  199. Completely configurable, no options need be given.
  200. The media may be specified by setting
  201. .B media=
  202. to the value
  203. .BR 10BaseT ,
  204. .BR 10Base2 ,
  205. .BR 100BaseTX ,
  206. .BR 100BaseFX ,
  207. .BR aui ,
  208. and
  209. .BR mii .
  210. If you need to force full duplex, because for example the Ethernet switch does not negotiate correctly,
  211. just name the word (no value)
  212. .B fullduplex
  213. or
  214. .BR 100BASE-TXFD .
  215. Similarly, to force 100Mbit operation, specify
  216. .BR force100 .
  217. Port 0x110 is used for the little ISA configuration dance.
  218. .TP
  219. .B 3c589
  220. The 3COM 3C589 series PCMCIA cards, including the
  221. 3C562 and the 589E.
  222. There is no support for the modem on the 3C562.
  223. Completely configurable, no options need be given.
  224. Defaults are
  225. .EX
  226. port=0x240 irq=10
  227. .EE
  228. The media may be specified as
  229. .B media=10BaseT
  230. or
  231. .BR media=10Base2 .
  232. .TP
  233. .B ec2t
  234. The Linksys Combo PCMCIA EthernetCard (EC2T),
  235. EtherFast 10/100 PCMCIA cards (PCMPC100) and integrated controllers (PCM100),
  236. the Netgear FA410TX 10/100 PCMCIA card
  237. and the Accton EtherPair-PCMCIA (EN2216).
  238. Completely configurable, no options need be given.
  239. Defaults are
  240. .EX
  241. port=0x300 irq=9
  242. .EE
  243. These cards are NE2000 clones.
  244. Other NE2000 compatible PCMCIA cards may be tried
  245. with the option
  246. .EX
  247. id=string
  248. .EE
  249. where
  250. .B string
  251. is a unique identifier string contained in the attribute
  252. memory of the card (see
  253. .IR pcmcia (8));
  254. unlike most options in
  255. .BR plan9.ini ,
  256. this string is case-sensitive.
  257. The option
  258. .B dummyrr=[01]
  259. can be used to turn off (0) or on (1) a dummy remote read in the driver
  260. in such cases,
  261. depending on how NE2000 compatible they are.
  262. .TP
  263. .B ne2000
  264. Not software configurable iff ISA;
  265. PCI clones or supersets are software configurable;
  266. includes the Realtek 8029 clone used by Parallels.
  267. 16-bit card.
  268. Defaults are
  269. .EX
  270. port=0x300 irq=2 mem=0x04000 size=0x4000
  271. .EE
  272. The option (no value)
  273. .B nodummyrr
  274. is needed on some (near) clones to turn off a dummy remote read in the driver.
  275. .TP
  276. .B amd79c970
  277. The AMD PCnet PCI Ethernet Adapter (AM79C970).
  278. (This is the Ethernet adapter used by VMware.)
  279. Completely configurable, no options need be given.
  280. .TP
  281. .B wd8003
  282. Includes WD8013 and SMC Elite and Elite Ultra cards. There are varying degrees
  283. of software configurability. Cards may be in either 8-bit or 16-bit slots.
  284. Defaults are
  285. .EX
  286. port=0x280 irq=3 mem=0xD0000 size=0x2000
  287. .EE
  288. BUG: On many machines only the 16 bit card works.
  289. .TP
  290. .B sink
  291. A
  292. .B /dev/null
  293. for Ethernet packets \(em the interface discards sent
  294. packets and never receives any.
  295. This is used to provide a test bed for
  296. some experimental Ethernet bridging software.
  297. .TP
  298. .B wavelan
  299. Lucent Wavelan (Orinoco) IEEE 802.11b
  300. and compatible PCMCIA cards.
  301. Compatible cards include the Dell TrueMobile 1150
  302. and the Linksys Instant Wireless Network PC Card.
  303. Port and IRQ defaults are 0x180 and 3 respectively.
  304. .IP
  305. These cards take a number of unique options to aid in
  306. identifying the card correctly on the 802.11b network.
  307. The network may be
  308. .I "ad hoc"
  309. or
  310. .I managed
  311. (i.e. use an access point):
  312. .EX
  313. mode=[adhoc, managed]
  314. .EE
  315. and defaults to
  316. .IR managed .
  317. The 802.11b network to attach to
  318. .RI ( managed
  319. mode)
  320. or identify as
  321. .RI ( "ad hoc"
  322. mode),
  323. is specified by
  324. .EX
  325. essid=string
  326. .EE
  327. and defaults to a null string.
  328. The card station name is given by
  329. .EX
  330. station=string
  331. .EE
  332. and defaults to
  333. .IR "Plan 9 STA" .
  334. The channel to use is given by
  335. .EX
  336. channel=number
  337. .EE
  338. where
  339. .I number
  340. lies in the range 1 to 16 inclusive;
  341. the channel is normally negotiated automatically.
  342. .IP
  343. If the card is capable of encryption,
  344. the following options may be used:
  345. .EX
  346. crypt=[off, on]
  347. .EE
  348. and defaults to
  349. .IR on .
  350. .EX
  351. key\fIN\fP=string
  352. .EE
  353. sets the encryption key
  354. .I N
  355. (where
  356. .I N
  357. is in the range 1 to 4 inclusive) to
  358. .IR string ;
  359. this will also set the transmit key to
  360. .I N
  361. (see below).
  362. There are two formats for
  363. .I string
  364. which depend on the length of the string.
  365. If it is exactly 5 or 13 characters long it is assumed
  366. to be an alphanumeric key; if it is exactly 10 or 26 characters
  367. long the key is assumed to be in hex format (without a leading
  368. .IR 0x ).
  369. The lengths are checked,
  370. as is the format of a hex key.
  371. .EX
  372. txkey=number
  373. .EE
  374. sets the transmit key to use to be
  375. .I number
  376. in the range 1 to 4 inclusive.
  377. If it is desired to exclude or include unencrypted packets
  378. .EX
  379. clear=[off, on]
  380. .EE
  381. configures reception and defaults to inclusion.
  382. .IP
  383. The defaults are intended to match the common case of
  384. a managed network with encryption and a typical entry would
  385. only require, for example
  386. .EX
  387. essid=left-armpit key1=afish key2=calledraawaru
  388. .EE
  389. if the port and IRQ defaults are used.
  390. These options may be set after boot by writing to the device's
  391. .I ctl
  392. file using a space as the separator between option and value, e.g.
  393. .EX
  394. echo 'key2 1d8f65c9a52d83c8e4b43f94af' >/net/ether0/0/ctl
  395. .EE
  396. .IP
  397. Card-specific power management may be enabled/disabled by
  398. .EX
  399. pm=[on, off]
  400. .EE
  401. .TP
  402. .B wavelanpci
  403. PCI Ethernet adapters that use the same Wavelan
  404. programming interface.
  405. Currently the only tested cards are those based on the
  406. Intersil Prism 2.5 chipset.
  407. .
  408. .SS DISKS, TAPES
  409. (S)ATA controllers are autodetected.
  410. .SS \fLusbX=type=uhci\fP
  411. .SS \fLusbX=type=ohci\fP
  412. .SS \fLusbX=type=ehci\fP
  413. This specifies the settings for a USB UHCI, OHCI or EHCI controller.
  414. Like the Ethernet controllers, USB controllers are autodetected
  415. after scanning for the ones listed in
  416. .IR plan9.ini .
  417. Thus, most systems will not need a
  418. .B usbX
  419. line.
  420. Also like the Ethernet controllers, USB autoprobing can be
  421. disabled by specifying the line
  422. .BR *nousbprobe= .
  423. .SS \fLscsiX=\fIvalue
  424. This defines a SCSI interface which cannot be automatically detected
  425. by the kernel.
  426. .PP
  427. Known
  428. .IR TYPE s
  429. are
  430. .TP
  431. .B aha1542
  432. Adaptec 154x series of controllers (and clones).
  433. Almost completely configurable, only the
  434. .EX
  435. port=0x300
  436. .EE
  437. option need be given.
  438. .PP
  439. NCR/Symbios/LSI-Logic 53c8xx-based adapters
  440. and Mylex MultiMaster (Buslogic BT-*) adapters are
  441. automatically detected and need no entries.
  442. .PP
  443. By default, the NCR 53c8xx driver searches for up to 32 controllers.
  444. This can be changed by setting the variable
  445. .BR *maxsd53c8xx .
  446. .PP
  447. By default the Mylex driver resets SCSI cards by using
  448. both the hard reset and SCSI bus reset flags in the driver interface.
  449. If a variable
  450. .BR *noscsireset
  451. is defined, the SCSI bus reset flag is omitted.
  452. .SS \fLaoeif=\fP\fIlist\fP
  453. This specifies a space-separated
  454. .I list
  455. of Ethernet interfaces to be bound at boot to the ATA-over-Ethernet driver,
  456. .IR aoe (3).
  457. For example,
  458. .LR "aoeif=ether0 ether1" .
  459. Only interfaces on this list will initially be accessible via AoE.
  460. .SS \fLaoedev=e!#æ/aoe/\fIshelf\fL.\fIslot\fR
  461. This specifies an ATA-over-Ethernet device accessible via the interfaces
  462. named in
  463. .IR aoeif
  464. on AoE
  465. .I shelf
  466. and
  467. .I slot
  468. to use as a root device for bootstrapping.
  469. .SS AUDIO
  470. .SS \fLaudioX=\fIvalue
  471. This defines a pre-USB sound interface.
  472. .PP
  473. Known types are
  474. .TF ess1688
  475. .PD
  476. .TP
  477. .B sb16
  478. Sound Blaster 16.
  479. .TP
  480. .B ess1688
  481. A Sound Blaster clone.
  482. .PP
  483. The DMA channel may be any of 5, 6, or 7.
  484. The defaults are
  485. .IP
  486. .EX
  487. port=0x220 irq=7 dma=5
  488. .EE
  489. .SS Uarts
  490. Plan 9 automatically configures COM1 and COM2, if found,
  491. as
  492. .B eia0
  493. (port 0x3F8, IRQ4)
  494. and
  495. .B eia1
  496. (port 0x2F8, IRQ3)
  497. respectively.
  498. These devices can be disabled by adding a line:
  499. .IP
  500. .EX
  501. eia\fIX\fP=disabled
  502. .EE
  503. .LP
  504. This is typically done in order to reuse the IRQ for
  505. another device.
  506. .PP
  507. Plan 9 used to support various serial concentrators,
  508. including the TTC 8 serial line card and various models
  509. in the Star Gate Avanstar series of intelligent serial boards.
  510. These are no longer supported; the much simpler
  511. Perle PCI-Fast4, PCI-Fast8, and PCI-Fast16 controllers
  512. have taken their places.
  513. These latter cards are automatically detected
  514. and need no configuration lines.
  515. .PP
  516. The line
  517. .B serial=type=com
  518. can be used to specify settings for a PCMCIA modem.
  519. .SS \fLmouseport=\fIvalue
  520. This specifies where the mouse is attached.
  521. .I Value
  522. can be
  523. .TP
  524. .B ps2
  525. the PS2 mouse/keyboard port. The BIOS setup procedure
  526. should be used to configure the machine appropriately.
  527. .TP
  528. .B ps2intellimouse
  529. an Intellimouse on the PS2 port.
  530. .TP
  531. .B 0
  532. for COM1
  533. .TP
  534. .B 1
  535. for COM2
  536. .SS \fLmodemport=\fIvalue
  537. Picks the UART line to call out on.
  538. This is used when connecting to a file server over
  539. an async line.
  540. .I Value
  541. is the number of the port.
  542. .SS \fLconsole=\fIvalue params
  543. This is used to specify the console device.
  544. The default
  545. value is
  546. .BR cga ;
  547. a number
  548. .B 0
  549. or
  550. .B 1
  551. specifies
  552. .I COM1
  553. or
  554. .I COM2
  555. respectively.
  556. A serial console is initially configured with the
  557. .IR uart (3)
  558. configuration string
  559. .B b9600
  560. .B l8
  561. .B pn
  562. .BR s1 ,
  563. specifying 9600 baud,
  564. 8 bit bytes, no parity, and one stop bit.
  565. If
  566. .I params
  567. is given, it will be used to further
  568. configure the uart.
  569. Notice that there is no
  570. .B =
  571. sign in the
  572. .I params
  573. syntax.
  574. For example,
  575. .IP
  576. .EX
  577. console=0 b19200 po
  578. .EE
  579. .LP
  580. would use COM1 at 19,200 baud
  581. with odd parity.
  582. .SS "PC CARD"
  583. .SS \fLpccard0=disabled\fP
  584. Disable probing for and automatic configuration of PC card controllers.
  585. .SS \fLpcmciaX=type=XXX irq=\fIirq
  586. If the default IRQ for the
  587. PCMCIA
  588. is correct, this entry can be omitted. The value of
  589. .B type
  590. is ignored.
  591. .SS \fLpcmcia0=disabled\fP
  592. Disable probing for and automatic configuration of PCMCIA controllers.
  593. .SS NVRAM
  594. .SS \fLnvram=\fIfile\fP
  595. .SS \fLnvrlen=\fIlength\fP
  596. .SS \fLnvroff=\fIoffset\fP
  597. This is used to specify an nvram device and optionally the length of the ram
  598. and read/write offset to use.
  599. These values are consulted by
  600. .I readnvram
  601. (see
  602. .IR authsrv (2)).
  603. The most common use of the nvram is to hold a
  604. .IR secstore (1)
  605. password for use by
  606. .IR factotum (4).
  607. .SS \fLnvr=\fIvalue
  608. This is used by the WORM file server kernel to locate a file holding information
  609. to configure the file system.
  610. The file cannot live on a SCSI disk.
  611. The default is
  612. .B fd!0!plan9.nvr
  613. (sic),
  614. unless
  615. .B bootfile
  616. is set, in which case it is
  617. .B plan9.nvr
  618. on the same disk as
  619. .BR bootfile .
  620. The syntax is either
  621. .BI fd! unit ! name
  622. or
  623. .BI hd! unit ! name
  624. where
  625. .I unit
  626. is the numeric unit id.
  627. This variant syntax is a vestige of the file server kernel's origins.
  628. .SS BOOTING
  629. .SS \fLbootfile=\fIvalue
  630. This is used to direct the actions of
  631. the bootstrap programs
  632. by naming the device and file from which to load the kernel.
  633. .SS \fLrootdir=\fIdir
  634. .SS \fLrootspec=\fIspec
  635. These are used by the bootstrap programs
  636. to identify the directory
  637. .I dir
  638. to make the root directory for the kernel, and the
  639. file system specifier
  640. .I spec
  641. (see
  642. .B mount
  643. in
  644. .IR bind (2))
  645. on which it can be found.
  646. These are usually used to test variant file systems for distributions, etc.
  647. .SS \fLbootargs=\fIargs
  648. The value of this variable is passed to
  649. .IR boot (8)
  650. by the kernel as the name of the root file system.
  651. It is typically used to specify additional arguments to
  652. pass to
  653. .IR kfs (4)
  654. or
  655. .IR ipconfig (8).
  656. For example, if the system is to run from a local
  657. .IR kfs (4)
  658. partition, the definition might read
  659. .BR bootargs=local!#S/sdC0/fs .
  660. See
  661. .IR boot (8)
  662. for more.
  663. .SS \fLnobootprompt=\fIroot
  664. Suppress the
  665. .L "root from"
  666. prompt and use
  667. .I root
  668. as the answer instead.
  669. .SS \fLuser=\fIuser
  670. Suppress the
  671. .L "user"
  672. prompt and use
  673. .I user
  674. as the answer instead.
  675. .SS \fLdebugfactotum=\fP
  676. Causes
  677. .IR boot (8)
  678. to start
  679. .I factotum
  680. with the
  681. .B -p
  682. option, so that it can be debugged.
  683. .SS \fLfactotumopts=\fIoptions
  684. Causes
  685. .IR boot (8)
  686. to start
  687. .I factotum
  688. with the given
  689. .IR options ,
  690. which must be a single word (i.e., contain no whitespace).
  691. .SS \fLventi=\fIvalue
  692. When booting from a local fossil server backed by a local
  693. or remote venti server,
  694. this variable specifies how to establish the connection to the
  695. venti server.
  696. See
  697. .IR boot (8)
  698. for more.
  699. .SS \fLcfs=\fIpartition
  700. This names the file holding the disk partition
  701. for the cache file system,
  702. .IR cfs (4).
  703. Extending the
  704. .B bootargs
  705. example, one would write
  706. .BR cfs=#S/sdC0/cache .
  707. .SS \fLbootdisk=\fIvalue
  708. This deprecated variable was used to specify the disk used by
  709. the cache file system and other disk-resident services.
  710. It is superseded by
  711. .B bootargs
  712. and
  713. .BR cfs .
  714. .SS \fLpartition=\fIvalue
  715. This defines the partition table
  716. .IR 9load (8)
  717. will examine to find disk partitioning information.
  718. By default, a partition table in a Plan 9 partition
  719. is consulted; if no such table is found, an old-Plan 9
  720. partition table on the next-to-last or last sector
  721. of the disk is consulted.
  722. A value of
  723. .B new
  724. consults only the first table,
  725. .B old
  726. only the second.
  727. .SS \fLreadparts=\fP
  728. Causes
  729. .IR boot (8)
  730. to look for MBR and Plan 9 partition tables on all
  731. .IR sd (3)
  732. disks, even before
  733. .I factotum
  734. is started, so NVRAM, for example, may be found.
  735. On PCs,
  736. .I 9load
  737. (but not
  738. .IR 9boot )
  739. normally does this and passes the partitions found in
  740. .BR #ec/sd\fICn\fPpart .
  741. .SS \fLfs=\fIa.b.c.d
  742. .SS \fLauth=\fIa.b.c.d
  743. These specify the IP address of the file and authentication server
  744. to use when mounting a network-provided root file system.
  745. They are used only if the addresses cannot be determined via DHCP.
  746. .SS PROCESSOR
  747. .SS \fL*norealmode=\fP
  748. The PC kernel switches the processor to 16-bit real mode
  749. to run BIOS interrupts, for example to find the memory map or to enable VESA.
  750. This variable disables such switches.
  751. .SS \fL*noe820scan=\fP
  752. When available, the PC kernel uses the BIOS E820 memory map
  753. to size memory. This variable disables the scan.
  754. .SS \fL*maxmem=\fIaddress
  755. This defines the maximum physical address that the system will scan when sizing memory.
  756. By default the PC operating system will scan up to 3.75 gigabytes
  757. (0xF0000000, the base of kernel virtual address space), but setting
  758. .B *maxmem
  759. will limit the scan.
  760. .B *maxmem
  761. must be less than 3.75 gigabytes.
  762. This variable is not consulted if using the E820 memory map.
  763. .SS \fL*kernelpercent=\fIpercent
  764. This defines the percentage of available memory reserved for the kernel allocation pool.
  765. The remainder is left for user processes. The default
  766. .I percent
  767. is
  768. .B 30
  769. on CPU servers,
  770. .B 60
  771. on terminals with less than 16MB of memory,
  772. and
  773. .B 40
  774. on terminals with memories of 16MB or more.
  775. Terminals use more kernel memory because
  776. .IR draw (3)
  777. maintains its graphic images in kernel memory.
  778. This deprecated option is rarely necessary in newer kernels.
  779. .SS \fL*nomce=\fIvalue
  780. If machine check exceptions are supported by the processor,
  781. then they are enabled by default.
  782. Setting this variable to
  783. .B 1
  784. causes them to be disabled even when available.
  785. .SS \fL*nomp=\fP
  786. A multiprocessor machine will enable all processors by default.
  787. Setting
  788. .B *nomp
  789. restricts the kernel to starting only one processor and using the
  790. traditional interrupt controller.
  791. .SS \fL*ncpu=\fIcpus\fP
  792. Setting
  793. .B *ncpu
  794. restricts the kernel to starting at most
  795. .I cpus
  796. processors.
  797. .SS \fL*pcimaxbno=\fIbno\fP
  798. Limits the maximum bus number probed
  799. on a PCI bus (default 7).
  800. For example, a
  801. .I bno
  802. of 1 should suffice on a 'standard' motherboard with an AGP slot.
  803. This, and
  804. .B *pcimaxdno
  805. below are rarely used and only on troublesome or suspect hardware.
  806. .SS \fL*pcimaxdno=\fIdno\fP
  807. Limits the maximum device number probed
  808. on a PCI bus (default 31).
  809. .SS \fL*nopcirouting=\fP
  810. Disable pci routing during boot. May solve interrupt routing
  811. problems on certain machines.
  812. .SS \fL*nodumpstack=\fP
  813. Disable printing a stack dump on panic.
  814. Useful if there is only a limited cga screen available,
  815. otherwise the textual information about the panic may scroll off.
  816. .\" .SS \fL*nobios=\fP
  817. .\" what does this do? something with pci
  818. .SS \fLioexclude=\fIrange\fP
  819. Specifies a list of ranges of I/O ports to exclude from use by drivers.
  820. Ranges are inclusive on both ends and separated by commas.
  821. For example:
  822. .EX
  823. ioexclude=0x330-0x337,0x430-0x43F
  824. .EE
  825. .SS \fLumbexclude=\fIrange\fP
  826. Specifies a list of ranges of UMB to exclude from use by drivers.
  827. Ranges are inclusive on both ends and separated by commas.
  828. For example:
  829. .EX
  830. umbexclude=0xD1800-0xD3FFF
  831. .EE
  832. .SS \fLapm0=\fP
  833. This enables the ``advanced power management'' interface
  834. as described in
  835. .IR apm (3)
  836. and
  837. .IR apm (8).
  838. The main feature of the interface is the ability to watch
  839. battery life (see
  840. .IR stats (8)).
  841. It is not on by default because it causes problems on some laptops.
  842. .SS VIDEO
  843. .SS \fLmonitor=\fImonitor
  844. .SS \fLvgasize=\fIx\fPx\fIy\fPx\fId
  845. These are used not by the kernel but by
  846. .I termrc
  847. (see
  848. .IR cpurc (8))
  849. when starting
  850. .IR vga (8).
  851. .SS \fL*dpms=\fIvalue
  852. This is used to specify the screen blanking behavior of the MGA4xx
  853. video driver.
  854. Values are
  855. .BR standby ,
  856. .BR suspend ,
  857. and
  858. .BR off .
  859. The first two specify differing levels of power saving;
  860. the third turns the monitor off completely.
  861. .SS Multiple Configurations
  862. .PP
  863. A
  864. .B plan9.ini
  865. file may contain multiple configurations,
  866. each within a block beginning with a line
  867. .EX
  868. [tag]
  869. .EE
  870. A special block with the tag
  871. .B menu
  872. gives a list of blocks from which the user may
  873. interactively select the contents of
  874. .BR plan9.ini .
  875. There may also be multiple blocks with the tag
  876. .B common
  877. which will be included in all selections;
  878. if any lines appear in
  879. .B plan9.ini
  880. before the first block,
  881. they are treated as a
  882. .B common
  883. block.
  884. .LP
  885. Within the
  886. .B menu
  887. block the following configuration lines are allowed:
  888. .SS \fLmenuitem=tag[, description]
  889. The block identified by
  890. .B tag
  891. will appear in the presented menu.
  892. The menu entry will consist of the
  893. .B tag
  894. unless the optional
  895. .B description
  896. is given.
  897. .SS \fLmenudefault=tag[, timeout]
  898. Identifies a default block to be given in the
  899. menu selection prompt.
  900. If the optional
  901. .B timeout
  902. is given (in seconds),
  903. the default block will be selected if there is no user
  904. input within the timeout period.
  905. .SS \fLmenuconsole=value[, baud]
  906. Selects a serial console upon which to present the menu
  907. as no
  908. .B console
  909. or
  910. .B baud
  911. configuration information will have been processed yet
  912. (the
  913. .B plan9.ini
  914. contents are still to be decided...).
  915. .LP
  916. In response to the menu being printed,
  917. the user is prompted to select a menu item from the list.
  918. If the numeric response is followed by a
  919. .BR p ,
  920. the selected configuration is printed and the menu presented
  921. again.
  922. .LP
  923. The line
  924. .EX
  925. menuitem=tag
  926. .EE
  927. is prefixed to the selected configuration as an aid to
  928. user-level initialization scripts.
  929. .br
  930. .ne 4
  931. .SH EXAMPLES
  932. .PP
  933. A representative
  934. .BR plan9.ini :
  935. .IP
  936. .EX
  937. % cat /n/c:/plan9.ini
  938. ether0=type=3C509
  939. mouseport=ps2
  940. modemport=1
  941. serial0=type=generic port=0x3E8 irq=5
  942. monitor=445x
  943. vgasize=1600x1200x8
  944. bootfile=/386/9pc
  945. %
  946. .EE
  947. .PP
  948. Minimum CONFIG.SYS and AUTOEXEC.BAT files to use
  949. COM2 as a console:
  950. .IP
  951. .EX
  952. % cat /n/c:/config.sys
  953. SHELL=COMMAND.COM COM2 /P
  954. % cat /n/c:/autoexec.bat
  955. @ECHO OFF
  956. PROMPT $p$g
  957. PATH C:\eDOS;C:\eBIN
  958. mode com2:96,n,8,1,p
  959. SET TEMP=C:\eTMP
  960. %
  961. .EE
  962. .PP
  963. Simple
  964. .B plan9.ini
  965. with multiple configurations:
  966. .IP
  967. .EX
  968. [menu]
  969. menuitem=vga, Plan 9 with VGA
  970. menuitem=novga, Plan 9 no automatic VGA
  971. menudefault=vga
  972. [vga]
  973. monitor=multisync135
  974. vgasize=1024x768x8
  975. [novga]
  976. [common]
  977. ether0=type=i82557
  978. audio0=type=sb16 port=0x220 irq=5 dma=1
  979. .EE
  980. .PP
  981. With this, the following menu will be presented on boot:
  982. .IP
  983. .EX
  984. Plan 9 Startup Menu:
  985. ====================
  986. 1. Plan 9 with VGA
  987. 2. Plan 9 no automatic VGA
  988. Selection[default==1]:
  989. .EE
  990. .PP
  991. Selecting item 1 generates the following
  992. .B plan9.ini
  993. to be used by the remainder of the bootstrap process:
  994. .IP
  995. .EX
  996. menuitem=vga
  997. monitor=multisync135
  998. vgasize=1024x768x8
  999. ether0=type=i82557
  1000. audio0=type=sb16 port=0x220 irq=5 dma=1
  1001. .EE
  1002. .PP
  1003. and selecting item 2:
  1004. .IP
  1005. .EX
  1006. menuitem=novga
  1007. ether0=type=i82557
  1008. audio0=type=sb16 port=0x220 irq=5 dma=1
  1009. .EE
  1010. .SH "SEE ALSO"
  1011. .IR 9boot (8),
  1012. .IR booting (8),
  1013. .IR boot (8)
  1014. .SH BUGS
  1015. Being able to set the console device to other than a
  1016. display is marginally useful on file servers; MS-DOS
  1017. and the programs which run under it are so tightly bound
  1018. to the display that it is necessary to have a display if any
  1019. setup or reconfiguration programs need to be run.
  1020. Also, the delay before any messages appear at boot time
  1021. is disconcerting, as any error messages from the BIOS
  1022. are lost.
  1023. .PP
  1024. This idea is at best an interesting experiment that needs another iteration.