plan9.ini 24 KB

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