mirror of
https://github.com/qemu/qemu.git
synced 2024-11-24 19:33:39 +08:00
doc help: Collect block device stuff under its own heading
Collect them from "Standard options", "File system options", "Virtual File system pass-through options", "Debug/Expert options". Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Message-id: 1360781383-28635-8-git-send-email-armbru@redhat.com Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
This commit is contained in:
parent
84644c451c
commit
10adb8be87
670
qemu-options.hx
670
qemu-options.hx
@ -103,6 +103,261 @@ Simulate a multi node NUMA system. If mem and cpus are omitted, resources
|
||||
are split equally.
|
||||
ETEXI
|
||||
|
||||
DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
|
||||
"-add-fd fd=fd,set=set[,opaque=opaque]\n"
|
||||
" Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
|
||||
@findex -add-fd
|
||||
|
||||
Add a file descriptor to an fd set. Valid options are:
|
||||
|
||||
@table @option
|
||||
@item fd=@var{fd}
|
||||
This option defines the file descriptor of which a duplicate is added to fd set.
|
||||
The file descriptor cannot be stdin, stdout, or stderr.
|
||||
@item set=@var{set}
|
||||
This option defines the ID of the fd set to add the file descriptor to.
|
||||
@item opaque=@var{opaque}
|
||||
This option defines a free-form string that can be used to describe @var{fd}.
|
||||
@end table
|
||||
|
||||
You can open an image using pre-opened file descriptors from an fd set:
|
||||
@example
|
||||
qemu-system-i386
|
||||
-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
|
||||
-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
|
||||
-drive file=/dev/fdset/2,index=0,media=disk
|
||||
@end example
|
||||
ETEXI
|
||||
|
||||
DEF("set", HAS_ARG, QEMU_OPTION_set,
|
||||
"-set group.id.arg=value\n"
|
||||
" set <arg> parameter for item <id> of type <group>\n"
|
||||
" i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -set @var{group}.@var{id}.@var{arg}=@var{value}
|
||||
@findex -set
|
||||
Set parameter @var{arg} for item @var{id} of type @var{group}\n"
|
||||
ETEXI
|
||||
|
||||
DEF("global", HAS_ARG, QEMU_OPTION_global,
|
||||
"-global driver.prop=value\n"
|
||||
" set a global default for a driver property\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -global @var{driver}.@var{prop}=@var{value}
|
||||
@findex -global
|
||||
Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
|
||||
|
||||
@example
|
||||
qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
|
||||
@end example
|
||||
|
||||
In particular, you can use this to set driver properties for devices which are
|
||||
created automatically by the machine model. To create a device which is not
|
||||
created automatically and set properties on it, use -@option{device}.
|
||||
ETEXI
|
||||
|
||||
DEF("boot", HAS_ARG, QEMU_OPTION_boot,
|
||||
"-boot [order=drives][,once=drives][,menu=on|off]\n"
|
||||
" [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time]\n"
|
||||
" 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
|
||||
" 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
|
||||
" 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
|
||||
" 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}]
|
||||
@findex -boot
|
||||
Specify boot order @var{drives} as a string of drive letters. Valid
|
||||
drive letters depend on the target achitecture. The x86 PC uses: a, b
|
||||
(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
|
||||
from network adapter 1-4), hard disk boot is the default. To apply a
|
||||
particular boot order only on the first startup, specify it via
|
||||
@option{once}.
|
||||
|
||||
Interactive boot menus/prompts can be enabled via @option{menu=on} as far
|
||||
as firmware/BIOS supports them. The default is non-interactive boot.
|
||||
|
||||
A splash picture could be passed to bios, enabling user to show it as logo,
|
||||
when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
|
||||
supports them. Currently Seabios for X86 system support it.
|
||||
limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
|
||||
format(true color). The resolution should be supported by the SVGA mode, so
|
||||
the recommended is 320x240, 640x480, 800x640.
|
||||
|
||||
A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
|
||||
when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
|
||||
reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
|
||||
system support it.
|
||||
|
||||
@example
|
||||
# try to boot from network first, then from hard disk
|
||||
qemu-system-i386 -boot order=nc
|
||||
# boot from CD-ROM first, switch back to default order after reboot
|
||||
qemu-system-i386 -boot once=d
|
||||
# boot with a splash picture for 5 seconds.
|
||||
qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
|
||||
@end example
|
||||
|
||||
Note: The legacy format '-boot @var{drives}' is still supported but its
|
||||
use is discouraged as it may be removed from future versions.
|
||||
ETEXI
|
||||
|
||||
DEF("m", HAS_ARG, QEMU_OPTION_m,
|
||||
"-m megs set virtual RAM size to megs MB [default="
|
||||
stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -m @var{megs}
|
||||
@findex -m
|
||||
Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
|
||||
a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
|
||||
gigabytes respectively.
|
||||
ETEXI
|
||||
|
||||
DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
|
||||
"-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -mem-path @var{path}
|
||||
@findex -mem-path
|
||||
Allocate guest RAM from a temporarily created file in @var{path}.
|
||||
ETEXI
|
||||
|
||||
#ifdef MAP_POPULATE
|
||||
DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
|
||||
"-mem-prealloc preallocate guest memory (use with -mem-path)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -mem-prealloc
|
||||
@findex -mem-prealloc
|
||||
Preallocate memory when using -mem-path.
|
||||
ETEXI
|
||||
#endif
|
||||
|
||||
DEF("k", HAS_ARG, QEMU_OPTION_k,
|
||||
"-k language use keyboard layout (for example 'fr' for French)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -k @var{language}
|
||||
@findex -k
|
||||
Use keyboard layout @var{language} (for example @code{fr} for
|
||||
French). This option is only needed where it is not easy to get raw PC
|
||||
keycodes (e.g. on Macs, with some X11 servers or with a VNC
|
||||
display). You don't normally need to use it on PC/Linux or PC/Windows
|
||||
hosts.
|
||||
|
||||
The available layouts are:
|
||||
@example
|
||||
ar de-ch es fo fr-ca hu ja mk no pt-br sv
|
||||
da en-gb et fr fr-ch is lt nl pl ru th
|
||||
de en-us fi fr-be hr it lv nl-be pt sl tr
|
||||
@end example
|
||||
|
||||
The default is @code{en-us}.
|
||||
ETEXI
|
||||
|
||||
|
||||
DEF("audio-help", 0, QEMU_OPTION_audio_help,
|
||||
"-audio-help print list of audio drivers and their options\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -audio-help
|
||||
@findex -audio-help
|
||||
Will show the audio subsystem help: list of drivers, tunable
|
||||
parameters.
|
||||
ETEXI
|
||||
|
||||
DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
|
||||
"-soundhw c1,... enable audio support\n"
|
||||
" and only specified sound cards (comma separated list)\n"
|
||||
" use '-soundhw help' to get the list of supported cards\n"
|
||||
" use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
|
||||
@findex -soundhw
|
||||
Enable audio and selected sound hardware. Use 'help' to print all
|
||||
available sound hardware.
|
||||
|
||||
@example
|
||||
qemu-system-i386 -soundhw sb16,adlib disk.img
|
||||
qemu-system-i386 -soundhw es1370 disk.img
|
||||
qemu-system-i386 -soundhw ac97 disk.img
|
||||
qemu-system-i386 -soundhw hda disk.img
|
||||
qemu-system-i386 -soundhw all disk.img
|
||||
qemu-system-i386 -soundhw help
|
||||
@end example
|
||||
|
||||
Note that Linux's i810_audio OSS kernel (for AC97) module might
|
||||
require manually specifying clocking.
|
||||
|
||||
@example
|
||||
modprobe i810_audio clocking=48000
|
||||
@end example
|
||||
ETEXI
|
||||
|
||||
DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
|
||||
"-balloon none disable balloon device\n"
|
||||
"-balloon virtio[,addr=str]\n"
|
||||
" enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -balloon none
|
||||
@findex -balloon
|
||||
Disable balloon device.
|
||||
@item -balloon virtio[,addr=@var{addr}]
|
||||
Enable virtio balloon device (default), optionally with PCI address
|
||||
@var{addr}.
|
||||
ETEXI
|
||||
|
||||
DEF("device", HAS_ARG, QEMU_OPTION_device,
|
||||
"-device driver[,prop[=value][,...]]\n"
|
||||
" add device (based on driver)\n"
|
||||
" prop=value,... sets driver properties\n"
|
||||
" use '-device help' to print all possible drivers\n"
|
||||
" use '-device driver,help' to print all possible properties\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
|
||||
@findex -device
|
||||
Add device @var{driver}. @var{prop}=@var{value} sets driver
|
||||
properties. Valid properties depend on the driver. To get help on
|
||||
possible drivers and properties, use @code{-device help} and
|
||||
@code{-device @var{driver},help}.
|
||||
ETEXI
|
||||
|
||||
DEF("name", HAS_ARG, QEMU_OPTION_name,
|
||||
"-name string1[,process=string2]\n"
|
||||
" set the name of the guest\n"
|
||||
" string1 sets the window title and string2 the process name (on Linux)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -name @var{name}
|
||||
@findex -name
|
||||
Sets the @var{name} of the guest.
|
||||
This name will be displayed in the SDL window caption.
|
||||
The @var{name} will also be used for the VNC server.
|
||||
Also optionally set the top visible process name in Linux.
|
||||
ETEXI
|
||||
|
||||
DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
|
||||
"-uuid %08x-%04x-%04x-%04x-%012x\n"
|
||||
" specify machine UUID\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -uuid @var{uuid}
|
||||
@findex -uuid
|
||||
Set system UUID.
|
||||
ETEXI
|
||||
|
||||
STEXI
|
||||
@end table
|
||||
ETEXI
|
||||
DEFHEADING()
|
||||
|
||||
DEFHEADING(Block device options:)
|
||||
STEXI
|
||||
@table @option
|
||||
ETEXI
|
||||
|
||||
DEF("fda", HAS_ARG, QEMU_OPTION_fda,
|
||||
"-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
|
||||
DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
|
||||
@ -293,62 +548,6 @@ qemu-system-i386 -hda a -hdb b
|
||||
@end example
|
||||
ETEXI
|
||||
|
||||
DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
|
||||
"-add-fd fd=fd,set=set[,opaque=opaque]\n"
|
||||
" Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
|
||||
@findex -add-fd
|
||||
|
||||
Add a file descriptor to an fd set. Valid options are:
|
||||
|
||||
@table @option
|
||||
@item fd=@var{fd}
|
||||
This option defines the file descriptor of which a duplicate is added to fd set.
|
||||
The file descriptor cannot be stdin, stdout, or stderr.
|
||||
@item set=@var{set}
|
||||
This option defines the ID of the fd set to add the file descriptor to.
|
||||
@item opaque=@var{opaque}
|
||||
This option defines a free-form string that can be used to describe @var{fd}.
|
||||
@end table
|
||||
|
||||
You can open an image using pre-opened file descriptors from an fd set:
|
||||
@example
|
||||
qemu-system-i386
|
||||
-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
|
||||
-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
|
||||
-drive file=/dev/fdset/2,index=0,media=disk
|
||||
@end example
|
||||
ETEXI
|
||||
|
||||
DEF("set", HAS_ARG, QEMU_OPTION_set,
|
||||
"-set group.id.arg=value\n"
|
||||
" set <arg> parameter for item <id> of type <group>\n"
|
||||
" i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -set @var{group}.@var{id}.@var{arg}=@var{value}
|
||||
@findex -set
|
||||
Set parameter @var{arg} for item @var{id} of type @var{group}\n"
|
||||
ETEXI
|
||||
|
||||
DEF("global", HAS_ARG, QEMU_OPTION_global,
|
||||
"-global driver.prop=value\n"
|
||||
" set a global default for a driver property\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -global @var{driver}.@var{prop}=@var{value}
|
||||
@findex -global
|
||||
Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
|
||||
|
||||
@example
|
||||
qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
|
||||
@end example
|
||||
|
||||
In particular, you can use this to set driver properties for devices which are
|
||||
created automatically by the machine model. To create a device which is not
|
||||
created automatically and set properties on it, use -@option{device}.
|
||||
ETEXI
|
||||
|
||||
DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
|
||||
"-mtdblock file use 'file' as on-board Flash memory image\n",
|
||||
QEMU_ARCH_ALL)
|
||||
@ -374,52 +573,6 @@ STEXI
|
||||
Use @var{file} as a parallel flash image.
|
||||
ETEXI
|
||||
|
||||
DEF("boot", HAS_ARG, QEMU_OPTION_boot,
|
||||
"-boot [order=drives][,once=drives][,menu=on|off]\n"
|
||||
" [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time]\n"
|
||||
" 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
|
||||
" 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
|
||||
" 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
|
||||
" 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}]
|
||||
@findex -boot
|
||||
Specify boot order @var{drives} as a string of drive letters. Valid
|
||||
drive letters depend on the target achitecture. The x86 PC uses: a, b
|
||||
(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
|
||||
from network adapter 1-4), hard disk boot is the default. To apply a
|
||||
particular boot order only on the first startup, specify it via
|
||||
@option{once}.
|
||||
|
||||
Interactive boot menus/prompts can be enabled via @option{menu=on} as far
|
||||
as firmware/BIOS supports them. The default is non-interactive boot.
|
||||
|
||||
A splash picture could be passed to bios, enabling user to show it as logo,
|
||||
when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
|
||||
supports them. Currently Seabios for X86 system support it.
|
||||
limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
|
||||
format(true color). The resolution should be supported by the SVGA mode, so
|
||||
the recommended is 320x240, 640x480, 800x640.
|
||||
|
||||
A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
|
||||
when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
|
||||
reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
|
||||
system support it.
|
||||
|
||||
@example
|
||||
# try to boot from network first, then from hard disk
|
||||
qemu-system-i386 -boot order=nc
|
||||
# boot from CD-ROM first, switch back to default order after reboot
|
||||
qemu-system-i386 -boot once=d
|
||||
# boot with a splash picture for 5 seconds.
|
||||
qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
|
||||
@end example
|
||||
|
||||
Note: The legacy format '-boot @var{drives}' is still supported but its
|
||||
use is discouraged as it may be removed from future versions.
|
||||
ETEXI
|
||||
|
||||
DEF("snapshot", 0, QEMU_OPTION_snapshot,
|
||||
"-snapshot write to temporary files instead of disk image files\n",
|
||||
QEMU_ARCH_ALL)
|
||||
@ -431,221 +584,19 @@ the raw disk image you use is not written back. You can however force
|
||||
the write back by pressing @key{C-a s} (@pxref{disk_images}).
|
||||
ETEXI
|
||||
|
||||
DEF("m", HAS_ARG, QEMU_OPTION_m,
|
||||
"-m megs set virtual RAM size to megs MB [default="
|
||||
stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -m @var{megs}
|
||||
@findex -m
|
||||
Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
|
||||
a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
|
||||
gigabytes respectively.
|
||||
ETEXI
|
||||
|
||||
DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
|
||||
"-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -mem-path @var{path}
|
||||
@findex -mem-path
|
||||
Allocate guest RAM from a temporarily created file in @var{path}.
|
||||
ETEXI
|
||||
|
||||
#ifdef MAP_POPULATE
|
||||
DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
|
||||
"-mem-prealloc preallocate guest memory (use with -mem-path)\n",
|
||||
DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
|
||||
"-hdachs c,h,s[,t]\n" \
|
||||
" force hard disk 0 physical geometry and the optional BIOS\n" \
|
||||
" translation (t=none or lba) (usually QEMU can guess them)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -mem-prealloc
|
||||
@findex -mem-prealloc
|
||||
Preallocate memory when using -mem-path.
|
||||
ETEXI
|
||||
#endif
|
||||
|
||||
DEF("k", HAS_ARG, QEMU_OPTION_k,
|
||||
"-k language use keyboard layout (for example 'fr' for French)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -k @var{language}
|
||||
@findex -k
|
||||
Use keyboard layout @var{language} (for example @code{fr} for
|
||||
French). This option is only needed where it is not easy to get raw PC
|
||||
keycodes (e.g. on Macs, with some X11 servers or with a VNC
|
||||
display). You don't normally need to use it on PC/Linux or PC/Windows
|
||||
hosts.
|
||||
|
||||
The available layouts are:
|
||||
@example
|
||||
ar de-ch es fo fr-ca hu ja mk no pt-br sv
|
||||
da en-gb et fr fr-ch is lt nl pl ru th
|
||||
de en-us fi fr-be hr it lv nl-be pt sl tr
|
||||
@end example
|
||||
|
||||
The default is @code{en-us}.
|
||||
ETEXI
|
||||
|
||||
|
||||
DEF("audio-help", 0, QEMU_OPTION_audio_help,
|
||||
"-audio-help print list of audio drivers and their options\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -audio-help
|
||||
@findex -audio-help
|
||||
Will show the audio subsystem help: list of drivers, tunable
|
||||
parameters.
|
||||
ETEXI
|
||||
|
||||
DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
|
||||
"-soundhw c1,... enable audio support\n"
|
||||
" and only specified sound cards (comma separated list)\n"
|
||||
" use '-soundhw help' to get the list of supported cards\n"
|
||||
" use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
|
||||
@findex -soundhw
|
||||
Enable audio and selected sound hardware. Use 'help' to print all
|
||||
available sound hardware.
|
||||
|
||||
@example
|
||||
qemu-system-i386 -soundhw sb16,adlib disk.img
|
||||
qemu-system-i386 -soundhw es1370 disk.img
|
||||
qemu-system-i386 -soundhw ac97 disk.img
|
||||
qemu-system-i386 -soundhw hda disk.img
|
||||
qemu-system-i386 -soundhw all disk.img
|
||||
qemu-system-i386 -soundhw help
|
||||
@end example
|
||||
|
||||
Note that Linux's i810_audio OSS kernel (for AC97) module might
|
||||
require manually specifying clocking.
|
||||
|
||||
@example
|
||||
modprobe i810_audio clocking=48000
|
||||
@end example
|
||||
ETEXI
|
||||
|
||||
DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
|
||||
"-balloon none disable balloon device\n"
|
||||
"-balloon virtio[,addr=str]\n"
|
||||
" enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -balloon none
|
||||
@findex -balloon
|
||||
Disable balloon device.
|
||||
@item -balloon virtio[,addr=@var{addr}]
|
||||
Enable virtio balloon device (default), optionally with PCI address
|
||||
@var{addr}.
|
||||
ETEXI
|
||||
|
||||
DEF("device", HAS_ARG, QEMU_OPTION_device,
|
||||
"-device driver[,prop[=value][,...]]\n"
|
||||
" add device (based on driver)\n"
|
||||
" prop=value,... sets driver properties\n"
|
||||
" use '-device help' to print all possible drivers\n"
|
||||
" use '-device driver,help' to print all possible properties\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
|
||||
@findex -device
|
||||
Add device @var{driver}. @var{prop}=@var{value} sets driver
|
||||
properties. Valid properties depend on the driver. To get help on
|
||||
possible drivers and properties, use @code{-device help} and
|
||||
@code{-device @var{driver},help}.
|
||||
ETEXI
|
||||
|
||||
DEF("name", HAS_ARG, QEMU_OPTION_name,
|
||||
"-name string1[,process=string2]\n"
|
||||
" set the name of the guest\n"
|
||||
" string1 sets the window title and string2 the process name (on Linux)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -name @var{name}
|
||||
@findex -name
|
||||
Sets the @var{name} of the guest.
|
||||
This name will be displayed in the SDL window caption.
|
||||
The @var{name} will also be used for the VNC server.
|
||||
Also optionally set the top visible process name in Linux.
|
||||
ETEXI
|
||||
|
||||
DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
|
||||
"-uuid %08x-%04x-%04x-%04x-%012x\n"
|
||||
" specify machine UUID\n", QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -uuid @var{uuid}
|
||||
@findex -uuid
|
||||
Set system UUID.
|
||||
ETEXI
|
||||
|
||||
STEXI
|
||||
@end table
|
||||
ETEXI
|
||||
DEFHEADING()
|
||||
|
||||
DEFHEADING(USB options:)
|
||||
STEXI
|
||||
@table @option
|
||||
ETEXI
|
||||
|
||||
DEF("usb", 0, QEMU_OPTION_usb,
|
||||
"-usb enable the USB driver (will be the default soon)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -usb
|
||||
@findex -usb
|
||||
Enable the USB driver (will be the default soon)
|
||||
ETEXI
|
||||
|
||||
DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
|
||||
"-usbdevice name add the host or guest USB device 'name'\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
|
||||
@item -usbdevice @var{devname}
|
||||
@findex -usbdevice
|
||||
Add the USB device @var{devname}. @xref{usb_devices}.
|
||||
|
||||
@table @option
|
||||
|
||||
@item mouse
|
||||
Virtual Mouse. This will override the PS/2 mouse emulation when activated.
|
||||
|
||||
@item tablet
|
||||
Pointer device that uses absolute coordinates (like a touchscreen). This
|
||||
means QEMU is able to report the mouse position without having to grab the
|
||||
mouse. Also overrides the PS/2 mouse emulation when activated.
|
||||
|
||||
@item disk:[format=@var{format}]:@var{file}
|
||||
Mass storage device based on file. The optional @var{format} argument
|
||||
will be used rather than detecting the format. Can be used to specifiy
|
||||
@code{format=raw} to avoid interpreting an untrusted format header.
|
||||
|
||||
@item host:@var{bus}.@var{addr}
|
||||
Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
|
||||
|
||||
@item host:@var{vendor_id}:@var{product_id}
|
||||
Pass through the host device identified by @var{vendor_id}:@var{product_id}
|
||||
(Linux only).
|
||||
|
||||
@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
|
||||
Serial converter to host character device @var{dev}, see @code{-serial} for the
|
||||
available devices.
|
||||
|
||||
@item braille
|
||||
Braille device. This will use BrlAPI to display the braille output on a real
|
||||
or fake device.
|
||||
|
||||
@item net:@var{options}
|
||||
Network adapter that supports CDC ethernet and RNDIS protocols.
|
||||
|
||||
@end table
|
||||
ETEXI
|
||||
|
||||
STEXI
|
||||
@end table
|
||||
ETEXI
|
||||
DEFHEADING()
|
||||
|
||||
DEFHEADING(File system options:)
|
||||
STEXI
|
||||
@table @option
|
||||
@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
|
||||
@findex -hdachs
|
||||
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
|
||||
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
|
||||
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
|
||||
all those parameters. This option is useful for old MS-DOS disk
|
||||
images.
|
||||
ETEXI
|
||||
|
||||
DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
|
||||
@ -710,16 +661,6 @@ Specifies the tag name to be used by the guest to mount this export point
|
||||
|
||||
ETEXI
|
||||
|
||||
STEXI
|
||||
@end table
|
||||
ETEXI
|
||||
DEFHEADING()
|
||||
|
||||
DEFHEADING(Virtual File system pass-through options:)
|
||||
STEXI
|
||||
@table @option
|
||||
ETEXI
|
||||
|
||||
DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
|
||||
"-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
|
||||
" [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
|
||||
@ -786,6 +727,70 @@ STEXI
|
||||
ETEXI
|
||||
DEFHEADING()
|
||||
|
||||
DEFHEADING(USB options:)
|
||||
STEXI
|
||||
@table @option
|
||||
ETEXI
|
||||
|
||||
DEF("usb", 0, QEMU_OPTION_usb,
|
||||
"-usb enable the USB driver (will be the default soon)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -usb
|
||||
@findex -usb
|
||||
Enable the USB driver (will be the default soon)
|
||||
ETEXI
|
||||
|
||||
DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
|
||||
"-usbdevice name add the host or guest USB device 'name'\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
|
||||
@item -usbdevice @var{devname}
|
||||
@findex -usbdevice
|
||||
Add the USB device @var{devname}. @xref{usb_devices}.
|
||||
|
||||
@table @option
|
||||
|
||||
@item mouse
|
||||
Virtual Mouse. This will override the PS/2 mouse emulation when activated.
|
||||
|
||||
@item tablet
|
||||
Pointer device that uses absolute coordinates (like a touchscreen). This
|
||||
means QEMU is able to report the mouse position without having to grab the
|
||||
mouse. Also overrides the PS/2 mouse emulation when activated.
|
||||
|
||||
@item disk:[format=@var{format}]:@var{file}
|
||||
Mass storage device based on file. The optional @var{format} argument
|
||||
will be used rather than detecting the format. Can be used to specifiy
|
||||
@code{format=raw} to avoid interpreting an untrusted format header.
|
||||
|
||||
@item host:@var{bus}.@var{addr}
|
||||
Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
|
||||
|
||||
@item host:@var{vendor_id}:@var{product_id}
|
||||
Pass through the host device identified by @var{vendor_id}:@var{product_id}
|
||||
(Linux only).
|
||||
|
||||
@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
|
||||
Serial converter to host character device @var{dev}, see @code{-serial} for the
|
||||
available devices.
|
||||
|
||||
@item braille
|
||||
Braille device. This will use BrlAPI to display the braille output on a real
|
||||
or fake device.
|
||||
|
||||
@item net:@var{options}
|
||||
Network adapter that supports CDC ethernet and RNDIS protocols.
|
||||
|
||||
@end table
|
||||
ETEXI
|
||||
|
||||
STEXI
|
||||
@end table
|
||||
ETEXI
|
||||
DEFHEADING()
|
||||
|
||||
DEFHEADING(Display options:)
|
||||
STEXI
|
||||
@table @option
|
||||
@ -2525,21 +2530,6 @@ STEXI
|
||||
Output log in @var{logfile} instead of /tmp/qemu.log
|
||||
ETEXI
|
||||
|
||||
DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
|
||||
"-hdachs c,h,s[,t]\n" \
|
||||
" force hard disk 0 physical geometry and the optional BIOS\n" \
|
||||
" translation (t=none or lba) (usually QEMU can guess them)\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
|
||||
@findex -hdachs
|
||||
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
|
||||
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
|
||||
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
|
||||
all those parameters. This option is useful for old MS-DOS disk
|
||||
images.
|
||||
ETEXI
|
||||
|
||||
DEF("L", HAS_ARG, QEMU_OPTION_L, \
|
||||
"-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
|
||||
QEMU_ARCH_ALL)
|
||||
|
Loading…
Reference in New Issue
Block a user