plan9.ini 23 KB

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