- step #1 of documentation updates: bochsrc options
This commit is contained in:
Volker Ruppert
parent
21d14583b8
commit
c21467a6cf
@ -6,17 +6,20 @@
|
||||
#
|
||||
# The configuration interface is a series of menus or dialog boxes that
|
||||
# allows you to change all the settings that control Bochs's behavior.
|
||||
# There are two choices of configuration interface: a text mode version
|
||||
# called "textconfig" and a graphical version called "wx". The text
|
||||
# mode version uses stdin/stdout and is always compiled in. The graphical
|
||||
# version is only available when you use "--with-wx" on the configure
|
||||
# command. If you do not write a config_interface line, Bochs will
|
||||
# Depending on the platform there are up to 3 choices of configuration
|
||||
# interface: a text mode version called "textconfig" and two graphical versions
|
||||
# called "win32config" and "wx". The text mode version uses stdin/stdout and
|
||||
# is always compiled in, unless Bochs is compiled for wx only. The choice
|
||||
# "win32config" is only available on win32 and it is the default there.
|
||||
# The choice "wx" is only available when you use "--with-wx" on the configure
|
||||
# command. If you do not write a config_interface line, Bochs will
|
||||
# choose a default for you.
|
||||
#
|
||||
# NOTE: if you use the "wx" configuration interface, you must also use
|
||||
# the "wx" display library.
|
||||
#=======================================================================
|
||||
#config_interface: textconfig
|
||||
#config_interface: win32config
|
||||
#config_interface: wx
|
||||
|
||||
#=======================================================================
|
||||
@ -62,7 +65,7 @@
|
||||
#display_library: win32, options="gui_debug" # use Win32 debugger gui
|
||||
#display_library: wx
|
||||
#display_library: x, options="hideIPS" # disable IPS output in status bar
|
||||
#display_library: x, options="gui_debug" # use X debugger gui
|
||||
#display_library: x, options="gui_debug" # use GTK debugger gui
|
||||
|
||||
#=======================================================================
|
||||
# ROMIMAGE:
|
||||
@ -673,8 +676,9 @@ private_colormap: enabled=0
|
||||
# Example:
|
||||
# pnic: enabled=1, mac=MACADDR, ethmod=MODULE, ethdev=DEVICE, script=SCRIPT
|
||||
#
|
||||
# The pseudo-NIC accepts the same syntax and supports the same networking
|
||||
# modules as the NE2000 adapter. It must be assigned to a PCI slot.
|
||||
# The pseudo-NIC accepts the same syntax (for mac, ethmod, ethdev, script) and
|
||||
# supports the same networking modules as the NE2000 adapter. In addition to
|
||||
# this, it must be assigned to a PCI slot.
|
||||
#=======================================================================
|
||||
#pnic: enabled=1, mac=b0:c4:20:00:00:00, ethmod=vnet
|
||||
|
||||
@ -828,6 +832,7 @@ i440fxsupport: enabled=1
|
||||
# USER_PLUGIN:
|
||||
# Load user-defined plugin. This option is available only if Bochs is
|
||||
# compiled with plugin support. Maximum 8 different plugins are supported.
|
||||
# See the example in the Bochs sources how to write a plugin device.
|
||||
#=======================================================================
|
||||
#user_plugin: name=testdev
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!--
|
||||
================================================================
|
||||
doc/docbook/user/user.dbk
|
||||
$Id: user.dbk,v 1.252 2009-04-19 05:18:18 sshwarts Exp $
|
||||
$Id: user.dbk,v 1.253 2009-04-19 13:10:50 vruppert Exp $
|
||||
|
||||
This is the top level file for the Bochs Users Manual.
|
||||
================================================================
|
||||
@ -3212,16 +3212,18 @@ and 'cirrus' for Cirrus SVGA support (needs
|
||||
<para>
|
||||
Examples:
|
||||
<screen>
|
||||
2.88M 3.5" Floppy:
|
||||
2.88M 3.5" media:
|
||||
floppya: 2_88=a:, status=inserted
|
||||
1.44M 3.5" Floppy:
|
||||
1.44M 3.5" media:
|
||||
floppya: 1_44=floppya.img, status=inserted
|
||||
1.2M 5.25" Floppy:
|
||||
1.2M 5.25" media:
|
||||
floppyb: 1_2=/dev/fd0, status=inserted
|
||||
720K 3.5" Floppy:
|
||||
720K 3.5" media:
|
||||
floppya: 720k=/usr/local/bochs/images/win95.img, status=inserted
|
||||
auto-detect:
|
||||
auto-detect floppy media type:
|
||||
floppya: image=floppy.img, status=inserted
|
||||
1.44M 3.5" floppy drive, no media:
|
||||
floppya: type=1_44
|
||||
</screen>
|
||||
Floppya is the first drive, and floppyb is the second drive. If you're booting
|
||||
from a floppy, floppya should point to a bootable disk. To read from a disk
|
||||
@ -3230,15 +3232,19 @@ read directly from a raw floppy drive. For raw disk access, use the device
|
||||
name (Unix systems) or the drive letter and a colon (Windows systems).
|
||||
</para>
|
||||
<para>
|
||||
Following floppy disk types are supported: 2_88, 1_44, 1_2, 720k, 360k, 320k, 180k,
|
||||
160k, as well as "image" to let Bochs auto-detect the type of floppy disk (does only
|
||||
work with images, not with raw floppy drives).
|
||||
Following floppy media types are supported: 2_88, 1_44, 1_2, 720k, 360k, 320k, 180k,
|
||||
160k, as well as "image" to let Bochs auto-detect the type of floppy media (does only
|
||||
work with images, not with raw floppy drives). In that case the size must match
|
||||
one of the supported types.
|
||||
</para>
|
||||
<para>
|
||||
You can set the initial status of the media to <constant>ejected</constant>
|
||||
or <constant>inserted</constant>. Usually you will want to use
|
||||
<constant>inserted</constant>. In fact Bryce can't think of any reason
|
||||
to ever write <constant>ejected</constant> in your <filename>bochsrc</filename>.
|
||||
or <constant>inserted</constant>. Usually you will want to use
|
||||
<constant>inserted</constant>.
|
||||
</para>
|
||||
<para>
|
||||
The parameter 'type' can be used to enable the floppy drive without media
|
||||
and status specified. Usually the drive type is set up based on the media type.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@ -3436,12 +3442,14 @@ The check is enabled by default.
|
||||
<para>
|
||||
The configuration interface is a series of menus or dialog boxes that
|
||||
allows you to edit all the settings that control Bochs' behavior.
|
||||
There are two choices of configuration interface: a text mode version
|
||||
called "textconfig" and a graphical version called "wx". The text
|
||||
mode version uses stdin/stdout and is always available while the graphical
|
||||
version is only available when Bochs is compiled with wxWidgets support, see
|
||||
<xref linkend="compile-wx">. If you do not use a config_interface line, Bochs
|
||||
will choose a default for you (usually textconfig).
|
||||
Depending on the platform there are up to 3 choices of configuration
|
||||
interface: a text mode version called "textconfig" and two graphical versions
|
||||
called "win32config" and "wx". The text mode version uses stdin/stdout and
|
||||
is always compiled in, unless Bochs is compiled for wx only. The choice
|
||||
"win32config" is only available on win32 and it is the default there.
|
||||
The choice "wx" is only available when Bochs is compiled with wxWidgets support,
|
||||
see <xref linkend="compile-wx">. If you do not write a config_interface line,
|
||||
Bochs will choose a default for you (usually textconfig).
|
||||
</para>
|
||||
|
||||
<note><para>
|
||||
@ -3455,6 +3463,7 @@ the "wx" display library, see
|
||||
Examples:
|
||||
<screen>
|
||||
config_interface: textconfig
|
||||
config_interface: win32config
|
||||
config_interface: wx
|
||||
</screen>
|
||||
</para>
|
||||
@ -3489,9 +3498,9 @@ behaviour. See the examples below for currently supported options.
|
||||
display_library: rfb, options="timeout=60" # time to wait for client
|
||||
display_library: sdl, options="fullscreen" # startup in fullscreen mode
|
||||
display_library: win32, options="legacyF12" # use F12 to toggle mouse
|
||||
display_library: win32, options="gui_debug" # use debugger gui frontend
|
||||
display_library: x, options="hideIPS" # disable IPS output in status bar
|
||||
display_library: x, options="gui_debug" # use debugger gui frontend
|
||||
display_library: win32, options="gui_debug" # use win32 debugger gui frontend
|
||||
display_library: x, options="hideIPS" # disable IPS output in status bar
|
||||
display_library: x, options="gui_debug" # use GTK debugger gui frontend
|
||||
</screen>
|
||||
</para>
|
||||
|
||||
@ -3979,25 +3988,51 @@ Examples:
|
||||
<screen>
|
||||
usb_uhci: enabled=1, port1=mouse, port2=keypad
|
||||
usb_uhci: enabled=1, port1=tablet, port2=disk:usbdisk.img
|
||||
usb_uhci: enabled=1, port1=hub:7, port2=cdrom:image.iso
|
||||
</screen>
|
||||
This option controls the presence of the USB root hub which is a part of the
|
||||
i440FX PCI chipset.
|
||||
</para>
|
||||
<para>
|
||||
With the port<replaceable>X</replaceable> option you can connect devices
|
||||
to the hub (currently supported: 'mouse', 'tablet', 'keypad' and 'disk').
|
||||
to the hub (currently supported: 'mouse', 'tablet', 'keypad', 'disk', 'cdrom'
|
||||
and 'hub').
|
||||
</para>
|
||||
<para>
|
||||
If you connect the mouse or tablet to one of the ports, Bochs forwards the
|
||||
mouse movement data to the USB device instead of the selected mouse type.
|
||||
When connecting the keypad to one of the ports, Bochs forwards the input of
|
||||
the numeric keypad to the USB device instead of the PS/2 keyboard.
|
||||
</para>
|
||||
<para>
|
||||
To connect a flat image as an USB hardisk you can use the 'disk' device with
|
||||
the path to the image separated with a colon (see above).
|
||||
the path to the image separated with a colon (see above). To emulate an USB
|
||||
cdrom you can use the 'cdrom' device name and the path to an ISO image or raw
|
||||
device name also separated with a colon.
|
||||
</para>
|
||||
<para>
|
||||
The device name 'hub' connects an external hub with max. 8 ports (default: 4)
|
||||
to the root hub. To specify the number of ports you have to add the value
|
||||
separated with a colon. Connecting devices to the external hub ports is only
|
||||
available in the runtime configuration.
|
||||
</para>
|
||||
<note><para>
|
||||
PCI support must be enabled.
|
||||
</para></note>
|
||||
</section>
|
||||
|
||||
<section id="bochsopt-usb_ohci"><title>usb_ohci</title>
|
||||
<para>
|
||||
Example:
|
||||
<screen>
|
||||
usb_ohci: enabled=1
|
||||
</screen>
|
||||
This option controls the presence of the USB OHCI host controller with a
|
||||
2-port hub. The portX option accepts the same device types with the same
|
||||
syntax as the UHCI controller (see the <link linkend="bochsopt-usb_uhci">usb_uhci option</link>).
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="bochsopt-gdbstub">
|
||||
<title>gdbstub</title>
|
||||
<para>
|
||||
@ -4160,6 +4195,19 @@ version where this module was added.
|
||||
</table>
|
||||
</section>
|
||||
|
||||
<section><title>pnic</title>
|
||||
<para>
|
||||
Example:
|
||||
<screen>
|
||||
pnic: enabled=1, mac=b0:c4:20:00:00:00, ethmod=vnet
|
||||
</screen>
|
||||
To support the Bochs/Etherboot pseudo-NIC, Bochs must be compiled with the
|
||||
--enable-pnic configure option. It accepts the same syntax (for mac, ethmod,
|
||||
ethdev, script) and supports the same networking modules as the NE2000 adapter.
|
||||
In addition to this, it must be assigned to a PCI slot.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section><title>keyboard_mapping</title>
|
||||
<para>
|
||||
Examples:
|
||||
@ -4239,6 +4287,18 @@ supported: 'acpi', 'biosdev', 'extfpuirq', 'gameport', 'iodebug',
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section><title>user_plugin</title>
|
||||
<para>
|
||||
Example:
|
||||
<screen>
|
||||
user_plugin: name=testdev
|
||||
</screen>
|
||||
Load user-defined plugin. This option is available only if Bochs is
|
||||
compiled with plugin support. Maximum 8 different plugins are supported.
|
||||
See the example in the Bochs sources how to write a plugin device.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section><title>magic_break</title>
|
||||
<para>
|
||||
Example:
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
.\"Document Author: Timothy R. Butler - tbutler@uninetsolutions.com"
|
||||
.TH bochsrc 5 "22 Febrary 2009" "bochsrc" "The Bochs Project"
|
||||
.TH bochsrc 5 "19 April 2009" "bochsrc" "The Bochs Project"
|
||||
.\"SKIP_SECTION"
|
||||
.SH NAME
|
||||
bochsrc \- Configuration file for Bochs.
|
||||
@ -45,10 +45,12 @@ Example:
|
||||
.I "config_interface:"
|
||||
The configuration interface is a series of menus or dialog boxes that
|
||||
allows you to change all the settings that control Bochs's behavior.
|
||||
There are two choices of configuration interface: a text mode version
|
||||
called "textconfig" and a graphical version called "wx". The text
|
||||
mode version uses stdin/stdout and is always compiled in. The graphical
|
||||
version is only available when you use "--with-wx" on the configure
|
||||
Depending on the platform there are up to 3 choices of configuration
|
||||
interface: a text mode version called "textconfig" and two graphical versions
|
||||
called "win32config" and "wx". The text mode version uses stdin/stdout and
|
||||
is always compiled in, unless Bochs is compiled for wx only. The choice
|
||||
"win32config" is only available on win32 and it is the default there.
|
||||
The choice "wx" is only available when you use "--with-wx" on the configure
|
||||
command. If you do not write a config_interface line, Bochs will
|
||||
choose a default for you.
|
||||
|
||||
@ -93,6 +95,7 @@ Examples:
|
||||
display_library: rfb, options="timeout=60" # time to wait for client
|
||||
display_library: sdl, options="fullscreen" # startup in fullscreen mode
|
||||
display_library: x, options="hideIPS" # disable IPS output in status bar
|
||||
display_library: x, options="gui_debug" # use GTK debugger gui
|
||||
|
||||
|
||||
.TP
|
||||
@ -245,26 +248,32 @@ You can set the initial status of the media to
|
||||
\&'ejected' or 'inserted'. Usually you will want
|
||||
to use 'inserted'.
|
||||
|
||||
The parameter 'type' can be used to enable the floppy drive without media
|
||||
and status specified. Usually the drive type is set up based on the media type.
|
||||
|
||||
Example:
|
||||
|
||||
2.88M 3.5" Floppy:
|
||||
2.88M 3.5" media:
|
||||
floppya: 2_88=path, status=ejected
|
||||
|
||||
1.44M 3.5" Floppy:
|
||||
1.44M 3.5" media:
|
||||
floppya: 1_44=path, status=inserted
|
||||
|
||||
1.2M 5.25" Floppy:
|
||||
1.2M 5.25" media:
|
||||
floppyb: 1_2=path, status=ejected
|
||||
|
||||
720K 3.5" Floppy:
|
||||
720K 3.5" media:
|
||||
floppya: 720k=path, status=inserted
|
||||
|
||||
360K 5.25" Floppy:
|
||||
360K 5.25" media:
|
||||
floppya: 360k=path, status=inserted
|
||||
|
||||
Autodetect Floppy type:
|
||||
Autodetect floppy media type:
|
||||
floppya: image=path, status=inserted
|
||||
|
||||
1.44M 3.5" floppy drive, no media:
|
||||
floppya: type=1_44
|
||||
|
||||
.TP
|
||||
.I "ata0: \fP, \fIata1: \fP, \fIata2: \fPor \fIata3:"
|
||||
|
||||
@ -652,7 +661,7 @@ With the mouse type option you can select the type of mouse to emulate.
|
||||
The default value is 'ps2'. The other choices are 'imps2' (wheel mouse
|
||||
on PS/2), 'serial', 'serial_wheel' and 'serial_msys' (one com port requires
|
||||
setting 'mode=mouse'). To connect a mouse to an USB port, see the 'usb_uhci'
|
||||
option (requires PCI and USB support).
|
||||
or 'usb_ohci' option (requires PCI and USB support).
|
||||
|
||||
Examples:
|
||||
mouse: enabled=0
|
||||
@ -760,6 +769,16 @@ Examples:
|
||||
ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=vde, ethdev="/tmp/vde.ctl"
|
||||
ne2k: ioaddr=0x300, irq=9, mac=b0:c4:20:00:00:01, ethmod=vnet, ethdev="c:/temp"
|
||||
|
||||
.TP
|
||||
.I "pnic:"
|
||||
To support the Bochs/Etherboot pseudo-NIC, Bochs must be compiled with the
|
||||
--enable-pnic configure option. It accepts the same syntax (for mac, ethmod,
|
||||
ethdev, script) and supports the same networking modules as the NE2000 adapter.
|
||||
In addition to this, it must be assigned to a PCI slot.
|
||||
|
||||
Example:
|
||||
pnic: enabled=1, mac=b0:c4:20:00:00:00, ethmod=vnet
|
||||
|
||||
.TP
|
||||
.I "keyboard_mapping:"
|
||||
This enables a remap of a physical localized keyboard to a
|
||||
@ -807,16 +826,36 @@ Example:
|
||||
.I "usb_uhci:"
|
||||
This option controls the presence of the USB root hub which is a part
|
||||
of the i440FX PCI chipset. With the portX option you can connect devices
|
||||
to the hub (currently supported: 'mouse', 'tablet', 'keypad' and 'disk').
|
||||
to the hub (currently supported: 'mouse', 'tablet', 'keypad', 'disk', 'cdrom'
|
||||
and 'hub').
|
||||
|
||||
If you connect the mouse or tablet to one of the ports, Bochs forwards the
|
||||
mouse movement data to the USB device instead of the selected mouse type.
|
||||
When connecting the keypad to one of the ports, Bochs forwards the input of
|
||||
the numeric keypad to the USB device instead of the PS/2 keyboard.
|
||||
|
||||
To connect a flat image as an USB hardisk you can use the 'disk' device with
|
||||
the path to the image separated with a colon (see below).
|
||||
the path to the image separated with a colon (see below). To emulate an USB
|
||||
cdrom you can use the 'cdrom' device name and the path to an ISO image or raw
|
||||
device name also separated with a colon.
|
||||
|
||||
The device name 'hub' connects an external hub with max. 8 ports (default: 4)
|
||||
to the root hub. To specify the number of ports you have to add the value
|
||||
separated with a colon. Connecting devices to the external hub ports is only
|
||||
available in the runtime configuration.
|
||||
|
||||
Example:
|
||||
usb_uhci: enabled=1, port1=mouse, port2=disk:usbdisk.img
|
||||
usb_uhci: enabled=1, port1=hub:7, port2=cdrom:image.iso
|
||||
|
||||
.TP
|
||||
.I "usb_ohci:"
|
||||
This option controls the presence of the USB OHCI host controller with a
|
||||
2-port hub. The portX option accepts the same device types with the same
|
||||
syntax as the UHCI controller (see above).
|
||||
|
||||
Example:
|
||||
usb_ohci: enabled=1
|
||||
|
||||
.TP
|
||||
.I "plugin_ctrl:"
|
||||
@ -827,12 +866,21 @@ supported: 'acpi', 'biosdev', 'extfpuirq', 'gameport', 'iodebug', 'pci_ide', 'sp
|
||||
Example:
|
||||
plugin_ctrl: biosdev=0, speaker=0
|
||||
|
||||
.TP
|
||||
.I "user_plugin:"
|
||||
Load user-defined plugin. This option is available only if Bochs is
|
||||
compiled with plugin support. Maximum 8 different plugins are supported.
|
||||
See the example in the Bochs sources how to write a plugin device.
|
||||
|
||||
Example:
|
||||
user_plugin: name=testdev
|
||||
|
||||
.\"SKIP_SECTION"
|
||||
.SH LICENSE
|
||||
This program is distributed under the terms of the GNU
|
||||
Lesser General Public License as published by the Free
|
||||
Software Foundation. See the COPYING file located in
|
||||
/usr/local/share/doc/bochs/ for details on the license and
|
||||
/usr/share/doc/bochs/ for details on the license and
|
||||
the lack of warranty.
|
||||
.\"SKIP_SECTION"
|
||||
.SH AVAILABILITY
|
||||
|
||||
Loading…
Reference in New Issue
Block a user