1bochsrc(5)                     The Bochs Project                    bochsrc(5)
2
3
4

NAME

6       bochsrc - Configuration file for Bochs.
7

DESCRIPTION

9       Bochsrc    is   the   configuration   file  that specifies where  Bochs
10       should look for disk images,  how the  Bochs  emulation  layer   should
11       work,   etc.    The  syntax  used for bochsrc  can also be used as com‐
12       mand line  arguments for Bochs. The .bochsrc   file  should  be  placed
13       either in the current  directory  before running  Bochs or in your home
14       directory.
15
16       Starting with Bochs 1.3, you  can  use  environment  variables  in  the
17       bochsrc file, for example:
18
19         floppya: 1_44="$IMAGES/bootdisk.img", status=inserted
20
21       Starting  with  version  2.0, two environment variables have a built-in
22       default value which is set at compile time.   $BXSHARE  points  to  the
23       "share" directory which is typically /usr/share/bochs on UNIX machines.
24       See the $(sharedir) variable in  the  Makefile  for  the  exact  value.
25       $BXSHARE  is used by disk images to locate the directory where the BIOS
26       images and keymaps can be found.  If $BXSHARE  is  not  defined,  Bochs
27       will  supply  the  default value.  Also, $LTDL_LIBRARY_PATH points to a
28       list of directories (separated by colons if more than one) to search in
29       for Bochs plugins.  A compile-time default is provided if this variable
30       is not defined by the user.
31

OPTIONS

33       #include
34              This option includes another configuration file. It is  possible
35              to put installation defaults in a global config file (e.g. loca‐
36              tion of rom images).
37
38              Example:
39                #include /etc/bochsrc
40
41
42       config_interface:
43              The configuration interface is a series of menus or dialog boxes
44              that  allows you to change all the settings that control Bochs's
45              behavior.  There are two choices of configuration  interface:  a
46              text  mode  version  called "textconfig" and a graphical version
47              called "wx".  The text mode version  uses  stdin/stdout  and  is
48              always  compiled  in.   The  graphical version is only available
49              when you use "--with-wx" on the configure command.   If  you  do
50              not  write  a config_interface line, Bochs will choose a default
51              for you.
52
53              NOTE: if you use the "wx" configuration interface, you must also
54              use the "wx" display library.
55
56              Example:
57                config_interface: textconfig
58
59
60       display_library:
61              The  display  library  is  the  code that displays the Bochs VGA
62              screen.  Bochs has a selection of  about  10  different  display
63              library  implementations  for  different  platforms.  If you run
64              configure with multiple --with-*  options,  the  display_library
65              command  lets you choose which one you want to run with.  If you
66              do not write a display_library line, Bochs will choose a default
67              for you.
68
69              The choices are:
70                x           X windows interface, cross platform
71                win32       native win32 libraries
72                carbon      Carbon library (for MacOS X)
73                beos        native BeOS libraries
74                macintosh   MacOS pre-10
75                amigaos     native AmigaOS libraries
76                sdl         SDL library, cross platform
77                term         text  only,  uses  curses/ncurses  library, cross
78              platform
79                rfb         provides an interface to AT&T's VNC viewer,  cross
80              platform
81                wx          wxWidgets library, cross platform
82                nogui       no display at all
83
84              NOTE: if you use the "wx" configuration interface, you must also
85              use the "wx" display library.
86
87              Example:
88                display_library: x
89
90
91       romimage:
92              The ROM BIOS controls what the PC does when it first powers  on.
93              Normally, you can use a precompiled BIOS in the source or binary
94              distribution called BIOS-bochs-latest.  The ROM BIOS is  usually
95              loaded  starting at address 0xf0000, and it is exactly 64k long.
96              You can also use the environment variable  $BXSHARE  to  specify
97              the  location  of  the  BIOS.   The usage of external large BIOS
98              images (up to 512k) at memory top is now supported, but we still
99              recommend to use the BIOS distributed with Bochs.  Now the start
100              address can be calculated from image size.
101
102              Examples:
103                romimage: file=bios/BIOS-bochs-latest, address=0xf0000
104                romimage: file=$BXSHARE/BIOS-bochs-latest, address=0xf0000
105                romimage: file=mybios.bin, address=0xfff80000
106                romimage: file=mybios.bin
107
108
109       cpu:   This defines cpu-related parameters inside Bochs:
110
111              count:
112
113              Set the number of  processors:cores  per  processor:threads  per
114              core  when  Bochs is compiled for SMP emulation. Bochs currently
115              supports up to 8 processors. If Bochs is  compiled  without  SMP
116              support, it won't accept values different from 1.
117
118              quantum:
119
120              Maximum  amount  of instructions allowed to execute by processor
121              before returning control to another cpu. This option exists only
122              in Bochs binary compiled with SMP support.
123
124              reset_on_triple_fault:
125
126              Reset  the  CPU  when  triple  fault  occur (highly recommended)
127              rather than PANIC. Remember that if you trying to continue after
128              triple fault the simulation will be completely bogus !
129
130              ips:
131
132              Emulated  Instructions  Per  Second.   This is the number of IPS
133              that Bochs is capable of  running  on  your  machine.   You  can
134              recompile  Bochs  with --enable-show-ips option enabled, to find
135              your workstation's capability.  Measured IPS value will then  be
136              logged  into  your  log  file or status bar (if supported by the
137              gui).
138
139              IPS is used to calibrate  many  time-dependent  events    within
140              the   bochs   simulation.  For example, changing IPS affects the
141              frequency of VGA updates, the duration  of  time  before  a  key
142              starts  to  autorepeat,   and  the  measurement  of BogoMips and
143              other benchmarks.
144
145              Example Specifications[1]
146               Bochs Machine/Compiler                                Mips
147               -------------------------------------------------------------------
148               2.2.6  2.6Ghz Intel Core 2 Duo with WinXP/g++ 3.4      21 to 25
149              Mips
150               2.2.6 2.1Ghz Athlon XP with Linux 2.6/g++ 3.4         12 to  15
151              Mips
152               2.0.1  1.6Ghz Intel P4 with Win2000/g++ 3.3             5 to  7
153              Mips
154               1.4   650Mhz Athlon K-7 with  Linux  2.4.4/egcs-2.91.66   2  to
155              2.5 Mips
156               1.4    400Mhz  Pentium  II  with Linux 2.0.36/egcs-1.0.3   1 to
157              1.8 Mips
158
159               [1]  IPS measurements depend on OS and  compiler  configuration
160              in addition  to processor clock speed.
161
162              Example:
163                cpu: count=2, ips=10000000
164
165
166       megs:  Set  the number of Megabytes of physical memory you want to emu‐
167              late.  The default is 32MB, most OS's won't need more than that.
168              The maximum amount of memory supported is 2048Mb.
169
170              Example:
171                megs: 32
172
173
174       optromimage1: , optromimage2: , optromimage3: or optromimage4:
175              You  may  now load up to 4 optional ROM images. Be sure to use a
176              read-only  area,  typically  between  C8000  and  EFFFF.   These
177              optional ROM images should not overwrite the rombios (located at
178              F0000-FFFFF) and the videobios (located at C0000-C7FFF).   Those
179              ROM  images  will be initialized by the bios if they contain the
180              right signature (0x55AA).  It can also be a  convenient  way  to
181              upload  some  arbitrary code/data in the simulation, that can be
182              retrieved by the boot loader
183
184              Example:
185                optromimage1: file=optionalrom.bin, address=0xd0000
186
187
188       vgaromimage:
189              You also need to load a VGA ROM BIOS into 0xC0000.
190
191              Examples:
192                vgaromimage: file=bios/VGABIOS-elpin-2.40
193                vgaromimage: file=bios/VGABIOS-lgpl-latest
194                vgaromimage: file=$BXSHARE/VGABIOS-lgpl-latest
195
196
197       vga:   Here you can specify the display extension to be used. With  the
198              value  'none'  you can use standard VGA with no extension. Other
199              supported values are 'vbe' for Bochs VBE and 'cirrus' for Cirrus
200              SVGA support.
201
202              Examples:
203                vga: extension=cirrus
204                vga: extension=vbe
205
206
207       floppya: or floppyb:
208
209              Point   this to  the pathname of a floppy image file or  device.
210              Floppya is the  first drive, and  floppyb is the  second  drive.
211              If   you're  booting  from  a  floppy, floppya should point to a
212              bootable disk.
213
214              You can set the initial status of  the  media  to  'ejected'  or
215              'inserted'. Usually you will want to use 'inserted'.
216
217              Example:
218
219              2.88M 3.5" Floppy:
220                floppya: 2_88=path, status=ejected
221
222              1.44M 3.5" Floppy:
223                floppya: 1_44=path, status=inserted
224
225              1.2M  5.25" Floppy:
226                floppyb: 1_2=path, status=ejected
227
228              720K  3.5" Floppy:
229                floppya: 720k=path, status=inserted
230
231              360K  5.25" Floppy:
232                floppya: 360k=path, status=inserted
233
234              Autodetect Floppy type:
235                floppya: image=path, status=inserted
236
237
238       ata0: , ata1: , ata2: or ata3:
239
240              These options enables up to 4 ata channels. For each channel the
241              two base io addresses and the irq must be specified.   ata0  and
242              ata1 are enabled by default, with the values shown below.
243
244              Examples:
245                 ata0: enabled=1, ioaddr1=0x1f0, ioaddr2=0x3f0, irq=14
246                 ata1: enabled=1, ioaddr1=0x170, ioaddr2=0x370, irq=15
247                 ata2: enabled=1, ioaddr1=0x1e8, ioaddr2=0x3e0, irq=11
248                 ata3: enabled=1, ioaddr1=0x168, ioaddr2=0x360, irq=9
249
250
251       ata[0-3]-master: or ata[0-3]-slave:
252
253              This  defines  the  type and characteristics of all attached ata
254              devices:
255                 type=       type of attached device [disk|cdrom]
256                 path=       path of the image
257                 mode=             image       mode        [flat|concat|exter‐
258              nal|dll|sparse|vmware3|undoable|growing|volatile],   only  valid
259              for disks
260                 cylinders=  only valid for disks
261                 heads=      only valid for disks
262                 spt=        only valid for disks
263                 status=     only valid for cdroms [inserted|ejected]
264                 biosdetect= type of biosdetection [none|auto], only for disks
265              on ata0 [cmos]
266                 translation=type  of  translation of the bios, only for disks
267              [none|lba|large|rechs|auto]
268                 model=      string returned by identify device command
269                 journal=    optional filename of the redolog for undoable and
270              volatile disks
271
272              Point this at a hard disk image file, cdrom iso file, or a phys‐
273              ical cdrom device.  To create a hard  disk  image,  try  running
274              bximage.   It  will  help you choose the size and then suggest a
275              line that works with it.
276
277              In UNIX it is possible to use a raw device as a Bochs hard disk,
278              but WE DON'T RECOMMEND IT.
279
280              The  path is always mandatory. Disk geometry autodetection works
281              with images created by bximage if CHS is set to 0/0/0 (cylinders
282              are  calculated  using heads=16 and spt=63). For other hard disk
283              images and modes the cylinders, heads, and spt are mandatory.
284
285              The mode option defines how the disk image is handled. Disks can
286              be defined as:
287                - flat : one file flat layout
288                - concat : multiple files layout
289                - external : developer's specific, through a C++ class
290                - dll : developer's specific, through a DLL
291                - sparse : stackable, commitable, rollbackable
292                - vmware3 : vmware3 disk support
293                - undoable : flat file with commitable redolog
294                - growing : growing file
295                - volatile : flat file with volatile redolog
296
297              The  disk  translation  scheme (implemented in legacy int13 bios
298              functions, and used by older operating systems like MS-DOS), can
299              be defined as:
300                -  none  : no translation, for disks up to 528MB (1032192 sec‐
301              tors)
302                - large : a standard bitshift algorithm, for disks up to 4.2GB
303              (8257536 sectors)
304                -  rechs : a revised bitshift algorithm, using a 15 heads fake
305              physical geometry, for disks up  to  7.9GB  (15482880  sectors).
306              (don't use this unless you understand what you're doing)
307                -  lba  :  a  standard lba-assisted algorithm, for disks up to
308              8.4GB (16450560 sectors)
309                - auto : autoselection of best translation scheme. (it  should
310              be changed if system does not boot)
311
312              Default values are:
313                 mode=flat,  biosdetect=auto, translation=auto, model="Generic
314              1234"
315
316              The biosdetect option has currently no effect on the bios
317
318              Examples:
319                 ata0-master:   type=disk,   path=10M.sample,   cylinders=306,
320              heads=4, spt=17
321                 ata0-slave:    type=disk,   path=20M.sample,   cylinders=615,
322              heads=4, spt=17
323                 ata1-master:   type=disk,   path=30M.sample,   cylinders=615,
324              heads=6, spt=17
325                 ata1-slave:    type=disk,   path=46M.sample,   cylinders=940,
326              heads=6, spt=17
327                 ata2-master:   type=disk,   path=62M.sample,   cylinders=940,
328              heads=8, spt=17
329                 ata2-slave:    type=disk,   path=112M.sample,  cylinders=900,
330              heads=15, spt=17
331                 ata3-master:  type=disk,  path=483M.sample,   cylinders=1024,
332              heads=15, spt=63
333                 ata3-slave:  type=cdrom, path=iso.sample, status=inserted
334
335
336       com1: , com2: , com3: or com4:
337              This defines a serial port (UART type 16550A). In the 'term' you
338              can specify a device to use as com1. This can be a  real  serial
339              line, or a pty.  To use a pty (under X/Unix), create two windows
340              (xterms, usually).  One of them will run bochs,  and  the  other
341              will  act  as  com1.  Find out the tty the com1 window using the
342              `tty' command, and use that as the  `dev'  parameter.   Then  do
343              `sleep  1000000' in the com1 window to keep the shell from mess‐
344              ing with things, and run bochs in the other window.  Serial  I/O
345              to com1 (port 0x3f8) will all go to the other window.
346
347              Other  serial modes are 'null' (no input/output), 'file' (output
348              to a file specified as the 'dev' parameter), 'raw' (use the real
349              serial  port  - under construction for win32) and 'mouse' (stan‐
350              dard serial mouse - requires mouse option setting  'type=serial'
351              or 'type=serial_wheel')
352
353              Examples:
354                com1: enabled=term, dev=/dev/ttyp7
355                com2: enabled=1, mode=file, dev=serial.out
356                com1: enabled=1, mode=mouse
357
358
359       parport1: or parport2:
360              This  defines  a  parallel (printer) port. When turned on and an
361              output file is defined the emulated printer port  sends  charac‐
362              ters printed by the guest OS into the output file. On some plat‐
363              forms a device filename can be used to send the data to the real
364              parallel port (e.g. "/dev/lp0" on Linux).
365
366              Examples:
367                parport1: enabled=1, file=parport.out
368                parport2: enabled=1, file="/dev/lp0"
369                parport1: enabled=0
370
371
372       boot:  This defines the boot sequence. Now you can specify up to 3 boot
373              drives.  You can either boot from 'floppy',  'disk'  or  'cdrom'
374              (legacy 'a' and 'c' are also supported)
375
376              Example:
377                boot: cdrom, floppy, disk
378
379
380       floppy_bootsig_check:
381              This  disables  the  0xaa55 signature check on boot floppies The
382              check is enabled by default.
383
384              Example:
385                floppy_bootsig_check: disabled=1
386
387
388       log:   Give the path of the log file you'd like Bochs debug  and  misc.
389              verbiage  to  be written to.   If you really don't want it, make
390              it /dev/null.
391
392              Example:
393                log: bochs.out
394                log: /dev/tty               (unix only)
395                log: /dev/null              (unix only)
396
397
398       logprefix:
399              This handles the format of the string prepended to each log line
400              : You may use those special tokens :
401                %t : 11 decimal digits timer tick
402                %i : 8 hexadecimal digits of cpu0 current eip
403                %e  :  1  character  event  type  ('i'nfo,  'd'ebug,  'p'anic,
404              'e'rror)
405                %d : 5 characters string of the device, between brackets
406
407              Default : %t%e%d
408
409              Examples:
410                logprefix: %t-%e-@%i-%d
411                logprefix: %i%e%d
412
413
414       panic: If Bochs reaches  a condition   where  it  cannot  emulate  cor‐
415              rectly,  it  does a panic.  This  can be a configuration problem
416              (like a misspelled bochsrc line) or an emulation  problem  (like
417              an  unsupported  video  mode). The  "panic"  setting in  bochsrc
418              tells  Bochs  how to respond to a panic.  You  can  set this  to
419              fatal  (terminate the session),  report   (print information  to
420              the console), or ignore (do nothing).
421
422              The safest setting is action=fatal. If you are getting   panics,
423              you   can   try   action=report  instead.  If you allow Bochs to
424              continue after a panic, don't be surprised if  you  get  strange
425              behavior  or  crashes  if  a panic occurs.  Please report  panic
426              messages  unless  it is just   a  configuration   problem   like
427              "could  not find hard drive image."
428
429              Example:
430                panic: action=fatal
431
432
433
434       error: Bochs  produces an error message when it  finds a condition that
435              really shouldn't happen,  but doesn't endanger  the  simulation.
436              An  example  of  an  error  might be  if the  emulated  software
437              produces an illegal disk command.
438
439              The "error" setting tells Bochs how to respond to an error  con‐
440              dition.    You can set  this  to fatal  (terminate the session),
441              report (print information to the   console),   or   ignore   (do
442              nothing).
443
444              Example:
445                error: action=report
446
447
448       info:  This  setting  tells  Bochs  what to  do  when  an event  occurs
449              that  generates  informational messages.  You can  set this   to
450              fatal   (that  would  not  be  very smart though), report (print
451              information to the  console),  or  ignore  (do  nothing).    For
452              general  usage,  the "report" option is probably a good choice.
453
454              Example:
455                info: action=report
456
457
458       debug: This  setting  tells  Bochs what  to  do  with messages intended
459              to assist in debugging.  You can set  this  to  fatal  (but  you
460              shouldn't),  report  (print  information  to  the   console), or
461              ignore (do nothing). You should generally  set this  to  ignore,
462              unless  you are  trying  to diagnose a particular problem.
463
464              NOTE: When  action=report,   Bochs   may  spit  out thousands of
465              debug messages per second, which can impact performance and fill
466              up your disk.
467
468              Example:
469                debug: action=ignore
470
471
472       debugger_log:
473              Give  the  path of the log file you'd like Bochs to log debugger
474              output.  If you really don't want it, make  it  '/dev/null',  or
475              '-'.
476
477              Example:
478                log: debugger.out
479                log: /dev/null              (unix only)
480                log: -
481
482
483       sb16:  This   defines  the SB16 sound emulation. It can have several of
484              the  following properties. All properties are in this format:
485                sb16: property=value
486
487
488              PROPERTIES FOR sb16:
489
490              midi:
491
492              The  filename is where the midi data is  sent.  This can  be   a
493              device  or just a file if  you want to record the midi data.
494
495              midimode:
496
497               0 = No data should be output.
498               1 = output to device (system dependent - midi
499               denotes the device driver).
500               2 = SMF file output, including headers.
501               3 = Output  the midi  data stream to the file
502               (no  midi headers  and  no delta  times, just
503               command and data bytes).
504
505              wave:
506
507              This  is the device/file where wave  output is stored.
508
509              wavemode:
510
511               0 = no data
512               1 = output to device (system dependent - wave
513               denotes the device driver).
514               2 = VOC file output, including headers.
515               3 = Output the raw wave stream to the file.
516
517              log:
518
519              The file to write the sb16 emulator messages to.
520
521              loglevel:
522
523               0 = No log.
524               1 = Resource changes, midi program and bank changes.
525               2 = Severe errors.
526               3 = All errors.
527               4 = All errors plus all port accesses.
528               5 = All  errors and port  accesses plus a lot
529               of extra information.
530
531              It is possible to change the loglevel at runtime.
532
533              dmatimer:
534
535              Microseconds per second for a DMA cycle.  Make it smaller to fix
536              non-continuous sound.  750000 is  usually  a  good value.   This
537              needs   a reasonably  correct   setting  for the  IPS  parameter
538              of the CPU option.  It is possible to  adjust  the  dmatimer  at
539              runtime.
540
541              Example:
542                sb16: midimode=1, midi=/dev/midi00,
543                wavemode=1, wave=/dev/dsp, loglevel=2,
544                log=sb16.log, dmatimer=600000
545
546              NOTE:  The  example is  wrapped onto three  lines for formatting
547              reasons, but  it should all  be   on  one  line  in  the  actual
548              bochsrc file.
549
550
551       vga_update_interval:
552              Video  memory is scanned for updates and screen updated every so
553              many virtual seconds. The default value is  40000,  about  25Hz.
554              Keep  in mind that you  must tweak the 'cpu: ips=N' directive to
555              be as close  to the number of  emulated  instructions-per-second
556              your  workstation can do, for this to be accurate.
557
558              Example:
559                vga_update_interval: 250000
560
561
562
563       keyboard_serial_delay:
564              Approximate  time  in  microseconds that it takes one  character
565              to   be  transfered  from  the keyboard to controller  over  the
566              serial path.
567
568              Example:
569                keyboard_serial_delay: 200
570
571
572       keyboard_paste_delay:
573              Approximate time in microseconds between attempts to paste char‐
574              acters to the keyboard controller.  This  leaves  time  for  the
575              guest os to deal with the flow of characters.  The ideal setting
576              depends on how your operating system processes characters.   The
577              default  of 100000 usec (.1 seconds) was chosen because it works
578              consistently in Windows.
579
580              If your OS is losing characters during  a  paste,  increase  the
581              paste delay until it stops losing characters.
582
583              Example:
584                keyboard_paste_delay: 100000
585
586
587       ips:   Emulated  Instructions  Per  Second.  This option is deprecated.
588              Use the CPU paramter IPS instead (cpu: ips=N).
589
590
591       clock: This defines the parameters of the clock inside Bochs.
592
593              sync
594
595              TO  BE  COMPLETED  (see  Greg  explanation  in  feature  request
596              #536329)
597
598              time0
599
600              Specifies  the  start  (boot) time of the virtual machine. Use a
601              time value as returned by the time(2) system call. If  no  time0
602              value  is  set or if time0 equal to 1 (special case) or if time0
603              equal 'local', the simulation will be  started  at  the  current
604              local host time.  If time0 equal to 2 (special case) or if time0
605              equal 'utc', the simulation will be started at the  current  utc
606              time.
607
608              Syntax:
609                clock:                     sync=[none|slowdown|realtime|both],
610              time0=[timeValue|local|utc]
611
612              Default value are sync=none, time0=local
613
614              Example:
615                clock: sync=realtime, time0=938581955   # Wed Sep 29  07:12:35
616              1999
617
618
619       mouse: This option prevents Bochs from creating mouse "events" unless a
620              mouse is enabled. The hardware emulation itself is not  disabled
621              by  this. You can turn the mouse on by setting enabled to  1, or
622              turn it off by setting enabled to 0. Unless you have a  particu‐
623              lar reason  for enabling the mouse by default, it is recommended
624              that you leave it off. You can also toggle the  mouse  usage  at
625              runtime  (control  key  +  middle mouse button).  With the mouse
626              type option you can select the type of mouse  to  emulate.   The
627              default  value  is  'ps2'.  The other choices are 'imps2' (wheel
628              mouse on PS/2), 'serial', 'serial_wheel' (one com port  requires
629              setting 'mode=mouse') and 'usb' (3-button mouse - one of the USB
630              ports must be connected with the 'mouse' device -  requires  PCI
631              and USB support).
632
633              Examples:
634                mouse: enabled=0
635                mouse: enabled=1, type=imps2
636
637
638       private_colormap:
639              Requests  that  the GUI create and use it's  own non-shared col‐
640              ormap.  This  colormap  will  be used when in the bochs  window.
641              If  not  enabled, a shared  colormap  scheme  may be used.  Once
642              again, enabled=1  turns on this feature  and 0 turns it off.
643
644              Example:
645                private_colormap: enabled=1
646
647
648       i440fxsupport:
649              This option controls the presence of the i440FX PCI chipset. You
650              can  also  specify  the  devices connected to PCI slots. Up to 5
651              slots are available now. These devices are currently  supported:
652              ne2k, pcivga, pcidev and pcipnic. If Bochs is compiled with Cir‐
653              rus SVGA support you'll have the additional choice 'cirrus'.
654
655              Example:
656                i440fxsupport: enabled=1, slot1=pcivga, slot2=ne2k
657
658
659       pcidev:
660              Enables the mapping of a host PCI hardware device within the PCI
661              subsystem of the Bochs x86 emulator. This feature requires Linux
662              as a host OS.
663
664              Example:
665                pcidev: vendor=0x1234, device=0x5678
666
667              The vendor and device arguments should  contain  the  vendor  ID
668              respectively  the  device  ID  of the PCI device you want to map
669              within Bochs.  The PCI mapping is still very experimental.
670
671
672       ne2k:  Defines the characteristics of an attached ne2000 isa card :
673                 ioaddr=IOADDR,
674                 irq=IRQ,
675                 mac=MACADDR,
676                 ethmod=MODULE,
677                 ethdev=DEVICE,
678                 script=SCRIPT
679
680              PROPERTIES FOR ne2k:
681
682              ioaddr, irq: You probably won't need to change ioaddr  and  irq,
683              unless there are IRQ conflicts.  These parameters are ignored if
684              the NE2000 is assigned to a PCI slot.
685
686              mac: The MAC address MUST NOT match the address of  any  machine
687              on  the net.  Also, the first byte must be an even number (bit 0
688              set  means  a   multicast   address),   and   you   cannot   use
689              ff:ff:ff:ff:ff:ff because that's the broadcast address.  For the
690              ethertap module, you must use fe:fd:00:00:00:01.  There  may  be
691              other  restrictions  too.   To  be  safe,  just use the b0:c4...
692              address.
693
694              ethmod: The ethmod value defines which  low  level  OS  specific
695              module to be used to access physical ethernet interface. Current
696              implemented values include
697               - fbsd   : ethernet on freebsd and openbsd
698               - linux  : ethernet on linux
699               - win32  : ethernet on win32
700               - tap    : ethernet through a linux tap interface
701               - tuntap : ethernet through a linux tuntap interface
702
703              If you don't want to make connections to any physical  networks,
704              you  can  use the following 'ethmod's to simulate a virtual net‐
705              work.
706               - null   : All packets are discarded, but logged to a few files
707               - arpback: ARP is simulated (disabled by default)
708               - vde    : Virtual Distributed Ethernet
709               - vnet   : ARP, ICMP-echo(ping), DHCP and TFTP are simulated
710                          The virtual host uses 192.168.10.1
711                          DHCP assigns 192.168.10.2 to the guest
712                          The TFTP server use ethdev for  the  root  directory
713              and doesn't
714                          overwrite files
715
716              ethdev: The ethdev value is the name of the network interface on
717              your host platform.  On UNIX machines, you can get the  name  by
718              running  ifconfig.  On Windows machines, you must run niclist to
719              get  the  name  of  the  ethdev.   Niclist  source  code  is  in
720              misc/niclist.c and it is included in Windows binary releases.
721
722              script:  The  script  value  is  optional,  and is the name of a
723              script that is  executed  after  bochs  initialize  the  network
724              interface.  You  can  use  this script to configure this network
725              interface, or enable masquerading.  This is  mainly  useful  for
726              the  tun/tap devices that only exist during Bochs execution. The
727              network interface name is supplied to the script as first param‐
728              eter
729
730              Examples:
731                ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:00, ethmod=fbsd,
732              ethdev=xlo
733                ne2k:   ioaddr=0x240,   irq=9,   mac=b0:c4:20:00:00:00,   eth‐
734              mod=linux, ethdev=eth0
735                ne2k:   ioaddr=0x240,   irq=9,   mac=b0:c4:20:00:00:01,   eth‐
736              mod=win32, ethdev=MYCARD
737                ne2k: ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01,  ethmod=tap,
738              ethdev=tap0
739                ne2k:  ioaddr=0x240, irq=9, mac=fe:fd:00:00:00:01, ethmod=tun‐
740              tap, ethdev=/dev/net/tun0, script=./tunconfig
741                ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01,  ethmod=vde,
742              ethdev="/tmp/vde.ctl"
743                ne2k: ioaddr=0x240, irq=9, mac=b0:c4:20:00:00:01, ethmod=vnet,
744              ethdev="c:/temp"
745
746
747       keyboard_mapping:
748              This enables a remap of a physical localized keyboard to a  vir‐
749              tualized  us  keyboard,  as  the  PC  architecture  expects.  If
750              enabled, the keymap file must be specified.
751
752               Examples:
753                 keyboard_mapping: enabled=1, map=gui/keymaps/x11-pc-de.map
754
755
756       keyboard_type:
757              Type of emulated keyboard sent back  to the OS  to  a  "keyboard
758              identify"  command.  It must be one of "xt", "at" or "mf".
759
760              Example:
761                keyboard_type: mf
762
763
764       user_shortcut:
765              This defines the keyboard shortcut to be sent when you press the
766              "user" button in the headerbar. The shortcut string is a  combi‐
767              nation  of  maximum  3 key names (listed below) separated with a
768              '-' character. The old-style  syntax  (without  the  '-')  still
769              works for the key combinations supported in Bochs 2.2.1.
770
771              Valid key names:
772
773              "alt",  "bksl",  "bksp",  "ctrl", "del", "down", "end", "enter",
774              "esc", "f1", ... "f12", "home", "ins", "left", "menu",  "minus",
775              "pgdwn", "pgup", "plus", "right", "shift", "space", "tab", "up",
776              and "win".
777
778              Example:
779                user_shortcut: keys=ctrl-alt-del
780
781
782       cmosimage:
783              This defines image file that can be loaded into the CMOS RAM  at
784              startup.  The rtc_init parameter controls whether initialize the
785              RTC with values stored in the image. By default the time0  argu‐
786              ment  given  to the clock option is used.  With 'rtc_init=image'
787              the image is the source for the initial time.
788
789              Example:
790                cmosimage: file=cmos.img, rtc_init=time0
791
792
793       usb1:  This option controls the presence of the USB root hub which is a
794              part  of  the  i440FX PCI chipset. With the portX option you can
795              connect devices to the hub  (currently  supported:  'mouse'  and
796              'keypad').  If you connect the mouse to one of the ports and use
797              the mouse option 'type=usb' you'll have a 3-button USB mouse.
798
799              Example:
800                usb1: enabled=1, port1=mouse, port2=keypad
801
802

LICENSE

804       This program  is distributed  under the terms of the  GNU  Lesser  Gen‐
805       eral  Public  License as published  by  the  Free Software  Foundation.
806       See   the   COPYING  file  located   in  /usr/share/doc/bochs-2.3/  for
807       details on the license and the lack of warranty.
808

AVAILABILITY

810       The latest version of this program can be found at:
811         http://bochs.sourceforge.net/getcurrent.html
812

SEE ALSO

814       bochs(1), bochs-dlx(1), bximage(1), bxcommit(1)
815
816       The Bochs IA-32 Emulator site on the World Wide Web:
817               http://bochs.sourceforge.net
818
819       Online Bochs Documentation
820            http://bochs.sourceforge.net/doc/docbook
821

AUTHORS

823       The    Bochs   emulator  was   created   by  Kevin   Lawton (kevin@man‐
824       drakesoft.com),  and  is  currently  maintained by the  members of  the
825       Bochs  x86  Emulator  Project.  You can see a current roster of members
826       at:
827         http://bochs.sourceforge.net/getinvolved.html
828

BUGS

830       Please  report all  bugs to the bug tracker  on  our  web site. Just go
831       to http://bochs.sourceforge.net, and click "Bug Reports" on the sidebar
832       under "Feedback".
833
834       Provide a detailed description of the bug, the version of  the  program
835       you  are  running,  the operating system you are running the program on
836       and  the  operating   system  you are running in the emulator.
837
838
839
840
841
842bochsrc                           22 Jun 2006                       bochsrc(5)
Impressum