File:  [Qemu by Fabrice Bellard] / qemu / qemu-options.hx
Revision 1.1.1.11 (vendor branch): download - view: text, annotated - select for diffs
Tue Apr 24 19:34:52 2018 UTC (3 years, 5 months ago) by root
Branches: qemu, MAIN
CVS tags: qemu1101, HEAD
qemu 1.1.1

    1: HXCOMM Use DEFHEADING() to define headings in both help text and texi
    2: HXCOMM Text between STEXI and ETEXI are copied to texi version and
    3: HXCOMM discarded from C version
    4: HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
    5: HXCOMM construct option structures, enums and help message for specified
    6: HXCOMM architectures.
    7: HXCOMM HXCOMM can be used for comments, discarded from both texi and C
    8: 
    9: DEFHEADING(Standard options:)
   10: STEXI
   11: @table @option
   12: ETEXI
   13: 
   14: DEF("help", 0, QEMU_OPTION_h,
   15:     "-h or -help     display this help and exit\n", QEMU_ARCH_ALL)
   16: STEXI
   17: @item -h
   18: @findex -h
   19: Display help and exit
   20: ETEXI
   21: 
   22: DEF("version", 0, QEMU_OPTION_version,
   23:     "-version        display version information and exit\n", QEMU_ARCH_ALL)
   24: STEXI
   25: @item -version
   26: @findex -version
   27: Display version information and exit
   28: ETEXI
   29: 
   30: DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
   31:     "-machine [type=]name[,prop[=value][,...]]\n"
   32:     "                selects emulated machine (-machine ? for list)\n"
   33:     "                property accel=accel1[:accel2[:...]] selects accelerator\n"
   34:     "                supported accelerators are kvm, xen, tcg (default: tcg)\n"
   35:     "                kernel_irqchip=on|off controls accelerated irqchip support\n"
   36:     "                kvm_shadow_mem=size of KVM shadow MMU\n",
   37:     QEMU_ARCH_ALL)
   38: STEXI
   39: @item -machine [type=]@var{name}[,prop=@var{value}[,...]]
   40: @findex -machine
   41: Select the emulated machine by @var{name}. Use @code{-machine ?} to list
   42: available machines. Supported machine properties are:
   43: @table @option
   44: @item accel=@var{accels1}[:@var{accels2}[:...]]
   45: This is used to enable an accelerator. Depending on the target architecture,
   46: kvm, xen, or tcg can be available. By default, tcg is used. If there is more
   47: than one accelerator specified, the next one is used if the previous one fails
   48: to initialize.
   49: @item kernel_irqchip=on|off
   50: Enables in-kernel irqchip support for the chosen accelerator when available.
   51: @item kvm_shadow_mem=size
   52: Defines the size of the KVM shadow MMU.
   53: @end table
   54: ETEXI
   55: 
   56: HXCOMM Deprecated by -machine
   57: DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
   58: 
   59: DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
   60:     "-cpu cpu        select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
   61: STEXI
   62: @item -cpu @var{model}
   63: @findex -cpu
   64: Select CPU model (-cpu ? for list and additional feature selection)
   65: ETEXI
   66: 
   67: DEF("smp", HAS_ARG, QEMU_OPTION_smp,
   68:     "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
   69:     "                set the number of CPUs to 'n' [default=1]\n"
   70:     "                maxcpus= maximum number of total cpus, including\n"
   71:     "                offline CPUs for hotplug, etc\n"
   72:     "                cores= number of CPU cores on one socket\n"
   73:     "                threads= number of threads on one CPU core\n"
   74:     "                sockets= number of discrete sockets in the system\n",
   75:         QEMU_ARCH_ALL)
   76: STEXI
   77: @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
   78: @findex -smp
   79: Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
   80: CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
   81: to 4.
   82: For the PC target, the number of @var{cores} per socket, the number
   83: of @var{threads} per cores and the total number of @var{sockets} can be
   84: specified. Missing values will be computed. If any on the three values is
   85: given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
   86: specifies the maximum number of hotpluggable CPUs.
   87: ETEXI
   88: 
   89: DEF("numa", HAS_ARG, QEMU_OPTION_numa,
   90:     "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
   91: STEXI
   92: @item -numa @var{opts}
   93: @findex -numa
   94: Simulate a multi node NUMA system. If mem and cpus are omitted, resources
   95: are split equally.
   96: ETEXI
   97: 
   98: DEF("fda", HAS_ARG, QEMU_OPTION_fda,
   99:     "-fda/-fdb file  use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
  100: DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
  101: STEXI
  102: @item -fda @var{file}
  103: @item -fdb @var{file}
  104: @findex -fda
  105: @findex -fdb
  106: Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
  107: use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
  108: ETEXI
  109: 
  110: DEF("hda", HAS_ARG, QEMU_OPTION_hda,
  111:     "-hda/-hdb file  use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
  112: DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
  113: DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
  114:     "-hdc/-hdd file  use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
  115: DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
  116: STEXI
  117: @item -hda @var{file}
  118: @item -hdb @var{file}
  119: @item -hdc @var{file}
  120: @item -hdd @var{file}
  121: @findex -hda
  122: @findex -hdb
  123: @findex -hdc
  124: @findex -hdd
  125: Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
  126: ETEXI
  127: 
  128: DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
  129:     "-cdrom file     use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
  130:     QEMU_ARCH_ALL)
  131: STEXI
  132: @item -cdrom @var{file}
  133: @findex -cdrom
  134: Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
  135: @option{-cdrom} at the same time). You can use the host CD-ROM by
  136: using @file{/dev/cdrom} as filename (@pxref{host_drives}).
  137: ETEXI
  138: 
  139: DEF("drive", HAS_ARG, QEMU_OPTION_drive,
  140:     "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
  141:     "       [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
  142:     "       [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
  143:     "       [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
  144:     "       [,readonly=on|off][,copy-on-read=on|off]\n"
  145:     "       [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n"
  146:     "                use 'file' as a drive image\n", QEMU_ARCH_ALL)
  147: STEXI
  148: @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
  149: @findex -drive
  150: 
  151: Define a new drive. Valid options are:
  152: 
  153: @table @option
  154: @item file=@var{file}
  155: This option defines which disk image (@pxref{disk_images}) to use with
  156: this drive. If the filename contains comma, you must double it
  157: (for instance, "file=my,,file" to use file "my,file").
  158: 
  159: Special files such as iSCSI devices can be specified using protocol
  160: specific URLs. See the section for "Device URL Syntax" for more information.
  161: @item if=@var{interface}
  162: This option defines on which type on interface the drive is connected.
  163: Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
  164: @item bus=@var{bus},unit=@var{unit}
  165: These options define where is connected the drive by defining the bus number and
  166: the unit id.
  167: @item index=@var{index}
  168: This option defines where is connected the drive by using an index in the list
  169: of available connectors of a given interface type.
  170: @item media=@var{media}
  171: This option defines the type of the media: disk or cdrom.
  172: @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
  173: These options have the same definition as they have in @option{-hdachs}.
  174: @item snapshot=@var{snapshot}
  175: @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
  176: @item cache=@var{cache}
  177: @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
  178: @item aio=@var{aio}
  179: @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
  180: @item format=@var{format}
  181: Specify which disk @var{format} will be used rather than detecting
  182: the format.  Can be used to specifiy format=raw to avoid interpreting
  183: an untrusted format header.
  184: @item serial=@var{serial}
  185: This option specifies the serial number to assign to the device.
  186: @item addr=@var{addr}
  187: Specify the controller's PCI address (if=virtio only).
  188: @item werror=@var{action},rerror=@var{action}
  189: Specify which @var{action} to take on write and read errors. Valid actions are:
  190: "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
  191: "report" (report the error to the guest), "enospc" (pause QEMU only if the
  192: host disk is full; report the error to the guest otherwise).
  193: The default setting is @option{werror=enospc} and @option{rerror=report}.
  194: @item readonly
  195: Open drive @option{file} as read-only. Guest write attempts will fail.
  196: @item copy-on-read=@var{copy-on-read}
  197: @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
  198: file sectors into the image file.
  199: @end table
  200: 
  201: By default, writethrough caching is used for all block device.  This means that
  202: the host page cache will be used to read and write data but write notification
  203: will be sent to the guest only when the data has been reported as written by
  204: the storage subsystem.
  205: 
  206: Writeback caching will report data writes as completed as soon as the data is
  207: present in the host page cache.  This is safe as long as you trust your host.
  208: If your host crashes or loses power, then the guest may experience data
  209: corruption.
  210: 
  211: The host page cache can be avoided entirely with @option{cache=none}.  This will
  212: attempt to do disk IO directly to the guests memory.  QEMU may still perform
  213: an internal copy of the data.
  214: 
  215: The host page cache can be avoided while only sending write notifications to
  216: the guest when the data has been reported as written by the storage subsystem
  217: using @option{cache=directsync}.
  218: 
  219: Some block drivers perform badly with @option{cache=writethrough}, most notably,
  220: qcow2.  If performance is more important than correctness,
  221: @option{cache=writeback} should be used with qcow2.
  222: 
  223: In case you don't care about data integrity over host failures, use
  224: cache=unsafe. This option tells QEMU that it never needs to write any data
  225: to the disk but can instead keeps things in cache. If anything goes wrong,
  226: like your host losing power, the disk storage getting disconnected accidentally,
  227: etc. you're image will most probably be rendered unusable.   When using
  228: the @option{-snapshot} option, unsafe caching is always used.
  229: 
  230: Copy-on-read avoids accessing the same backing file sectors repeatedly and is
  231: useful when the backing file is over a slow network.  By default copy-on-read
  232: is off.
  233: 
  234: Instead of @option{-cdrom} you can use:
  235: @example
  236: qemu-system-i386 -drive file=file,index=2,media=cdrom
  237: @end example
  238: 
  239: Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
  240: use:
  241: @example
  242: qemu-system-i386 -drive file=file,index=0,media=disk
  243: qemu-system-i386 -drive file=file,index=1,media=disk
  244: qemu-system-i386 -drive file=file,index=2,media=disk
  245: qemu-system-i386 -drive file=file,index=3,media=disk
  246: @end example
  247: 
  248: You can connect a CDROM to the slave of ide0:
  249: @example
  250: qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
  251: @end example
  252: 
  253: If you don't specify the "file=" argument, you define an empty drive:
  254: @example
  255: qemu-system-i386 -drive if=ide,index=1,media=cdrom
  256: @end example
  257: 
  258: You can connect a SCSI disk with unit ID 6 on the bus #0:
  259: @example
  260: qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6
  261: @end example
  262: 
  263: Instead of @option{-fda}, @option{-fdb}, you can use:
  264: @example
  265: qemu-system-i386 -drive file=file,index=0,if=floppy
  266: qemu-system-i386 -drive file=file,index=1,if=floppy
  267: @end example
  268: 
  269: By default, @var{interface} is "ide" and @var{index} is automatically
  270: incremented:
  271: @example
  272: qemu-system-i386 -drive file=a -drive file=b"
  273: @end example
  274: is interpreted like:
  275: @example
  276: qemu-system-i386 -hda a -hdb b
  277: @end example
  278: ETEXI
  279: 
  280: DEF("set", HAS_ARG, QEMU_OPTION_set,
  281:     "-set group.id.arg=value\n"
  282:     "                set <arg> parameter for item <id> of type <group>\n"
  283:     "                i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
  284: STEXI
  285: @item -set
  286: @findex -set
  287: TODO
  288: ETEXI
  289: 
  290: DEF("global", HAS_ARG, QEMU_OPTION_global,
  291:     "-global driver.prop=value\n"
  292:     "                set a global default for a driver property\n",
  293:     QEMU_ARCH_ALL)
  294: STEXI
  295: @item -global @var{driver}.@var{prop}=@var{value}
  296: @findex -global
  297: Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
  298: 
  299: @example
  300: qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
  301: @end example
  302: 
  303: In particular, you can use this to set driver properties for devices which are 
  304: created automatically by the machine model. To create a device which is not 
  305: created automatically and set properties on it, use -@option{device}.
  306: ETEXI
  307: 
  308: DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
  309:     "-mtdblock file  use 'file' as on-board Flash memory image\n",
  310:     QEMU_ARCH_ALL)
  311: STEXI
  312: @item -mtdblock @var{file}
  313: @findex -mtdblock
  314: Use @var{file} as on-board Flash memory image.
  315: ETEXI
  316: 
  317: DEF("sd", HAS_ARG, QEMU_OPTION_sd,
  318:     "-sd file        use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
  319: STEXI
  320: @item -sd @var{file}
  321: @findex -sd
  322: Use @var{file} as SecureDigital card image.
  323: ETEXI
  324: 
  325: DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
  326:     "-pflash file    use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
  327: STEXI
  328: @item -pflash @var{file}
  329: @findex -pflash
  330: Use @var{file} as a parallel flash image.
  331: ETEXI
  332: 
  333: DEF("boot", HAS_ARG, QEMU_OPTION_boot,
  334:     "-boot [order=drives][,once=drives][,menu=on|off]\n"
  335:     "      [,splash=sp_name][,splash-time=sp_time]\n"
  336:     "                'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
  337:     "                'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
  338:     "                'sp_time': the period that splash picture last if menu=on, unit is ms\n",
  339:     QEMU_ARCH_ALL)
  340: STEXI
  341: @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}]
  342: @findex -boot
  343: Specify boot order @var{drives} as a string of drive letters. Valid
  344: drive letters depend on the target achitecture. The x86 PC uses: a, b
  345: (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
  346: from network adapter 1-4), hard disk boot is the default. To apply a
  347: particular boot order only on the first startup, specify it via
  348: @option{once}.
  349: 
  350: Interactive boot menus/prompts can be enabled via @option{menu=on} as far
  351: as firmware/BIOS supports them. The default is non-interactive boot.
  352: 
  353: A splash picture could be passed to bios, enabling user to show it as logo,
  354: when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
  355: supports them. Currently Seabios for X86 system support it.
  356: limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
  357: format(true color). The resolution should be supported by the SVGA mode, so
  358: the recommended is 320x240, 640x480, 800x640.
  359: 
  360: @example
  361: # try to boot from network first, then from hard disk
  362: qemu-system-i386 -boot order=nc
  363: # boot from CD-ROM first, switch back to default order after reboot
  364: qemu-system-i386 -boot once=d
  365: # boot with a splash picture for 5 seconds.
  366: qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
  367: @end example
  368: 
  369: Note: The legacy format '-boot @var{drives}' is still supported but its
  370: use is discouraged as it may be removed from future versions.
  371: ETEXI
  372: 
  373: DEF("snapshot", 0, QEMU_OPTION_snapshot,
  374:     "-snapshot       write to temporary files instead of disk image files\n",
  375:     QEMU_ARCH_ALL)
  376: STEXI
  377: @item -snapshot
  378: @findex -snapshot
  379: Write to temporary files instead of disk image files. In this case,
  380: the raw disk image you use is not written back. You can however force
  381: the write back by pressing @key{C-a s} (@pxref{disk_images}).
  382: ETEXI
  383: 
  384: DEF("m", HAS_ARG, QEMU_OPTION_m,
  385:     "-m megs         set virtual RAM size to megs MB [default="
  386:     stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
  387: STEXI
  388: @item -m @var{megs}
  389: @findex -m
  390: Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
  391: a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
  392: gigabytes respectively.
  393: ETEXI
  394: 
  395: DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
  396:     "-mem-path FILE  provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
  397: STEXI
  398: @item -mem-path @var{path}
  399: Allocate guest RAM from a temporarily created file in @var{path}.
  400: ETEXI
  401: 
  402: #ifdef MAP_POPULATE
  403: DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
  404:     "-mem-prealloc   preallocate guest memory (use with -mem-path)\n",
  405:     QEMU_ARCH_ALL)
  406: STEXI
  407: @item -mem-prealloc
  408: Preallocate memory when using -mem-path.
  409: ETEXI
  410: #endif
  411: 
  412: DEF("k", HAS_ARG, QEMU_OPTION_k,
  413:     "-k language     use keyboard layout (for example 'fr' for French)\n",
  414:     QEMU_ARCH_ALL)
  415: STEXI
  416: @item -k @var{language}
  417: @findex -k
  418: Use keyboard layout @var{language} (for example @code{fr} for
  419: French). This option is only needed where it is not easy to get raw PC
  420: keycodes (e.g. on Macs, with some X11 servers or with a VNC
  421: display). You don't normally need to use it on PC/Linux or PC/Windows
  422: hosts.
  423: 
  424: The available layouts are:
  425: @example
  426: ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
  427: da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
  428: de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
  429: @end example
  430: 
  431: The default is @code{en-us}.
  432: ETEXI
  433: 
  434: 
  435: DEF("audio-help", 0, QEMU_OPTION_audio_help,
  436:     "-audio-help     print list of audio drivers and their options\n",
  437:     QEMU_ARCH_ALL)
  438: STEXI
  439: @item -audio-help
  440: @findex -audio-help
  441: Will show the audio subsystem help: list of drivers, tunable
  442: parameters.
  443: ETEXI
  444: 
  445: DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
  446:     "-soundhw c1,... enable audio support\n"
  447:     "                and only specified sound cards (comma separated list)\n"
  448:     "                use -soundhw ? to get the list of supported cards\n"
  449:     "                use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
  450: STEXI
  451: @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
  452: @findex -soundhw
  453: Enable audio and selected sound hardware. Use ? to print all
  454: available sound hardware.
  455: 
  456: @example
  457: qemu-system-i386 -soundhw sb16,adlib disk.img
  458: qemu-system-i386 -soundhw es1370 disk.img
  459: qemu-system-i386 -soundhw ac97 disk.img
  460: qemu-system-i386 -soundhw hda disk.img
  461: qemu-system-i386 -soundhw all disk.img
  462: qemu-system-i386 -soundhw ?
  463: @end example
  464: 
  465: Note that Linux's i810_audio OSS kernel (for AC97) module might
  466: require manually specifying clocking.
  467: 
  468: @example
  469: modprobe i810_audio clocking=48000
  470: @end example
  471: ETEXI
  472: 
  473: DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
  474:     "-balloon none   disable balloon device\n"
  475:     "-balloon virtio[,addr=str]\n"
  476:     "                enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
  477: STEXI
  478: @item -balloon none
  479: @findex -balloon
  480: Disable balloon device.
  481: @item -balloon virtio[,addr=@var{addr}]
  482: Enable virtio balloon device (default), optionally with PCI address
  483: @var{addr}.
  484: ETEXI
  485: 
  486: STEXI
  487: @end table
  488: ETEXI
  489: 
  490: DEF("usb", 0, QEMU_OPTION_usb,
  491:     "-usb            enable the USB driver (will be the default soon)\n",
  492:     QEMU_ARCH_ALL)
  493: STEXI
  494: USB options:
  495: @table @option
  496: 
  497: @item -usb
  498: @findex -usb
  499: Enable the USB driver (will be the default soon)
  500: ETEXI
  501: 
  502: DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
  503:     "-usbdevice name add the host or guest USB device 'name'\n",
  504:     QEMU_ARCH_ALL)
  505: STEXI
  506: 
  507: @item -usbdevice @var{devname}
  508: @findex -usbdevice
  509: Add the USB device @var{devname}. @xref{usb_devices}.
  510: 
  511: @table @option
  512: 
  513: @item mouse
  514: Virtual Mouse. This will override the PS/2 mouse emulation when activated.
  515: 
  516: @item tablet
  517: Pointer device that uses absolute coordinates (like a touchscreen). This
  518: means QEMU is able to report the mouse position without having to grab the
  519: mouse. Also overrides the PS/2 mouse emulation when activated.
  520: 
  521: @item disk:[format=@var{format}]:@var{file}
  522: Mass storage device based on file. The optional @var{format} argument
  523: will be used rather than detecting the format. Can be used to specifiy
  524: @code{format=raw} to avoid interpreting an untrusted format header.
  525: 
  526: @item host:@var{bus}.@var{addr}
  527: Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
  528: 
  529: @item host:@var{vendor_id}:@var{product_id}
  530: Pass through the host device identified by @var{vendor_id}:@var{product_id}
  531: (Linux only).
  532: 
  533: @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
  534: Serial converter to host character device @var{dev}, see @code{-serial} for the
  535: available devices.
  536: 
  537: @item braille
  538: Braille device.  This will use BrlAPI to display the braille output on a real
  539: or fake device.
  540: 
  541: @item net:@var{options}
  542: Network adapter that supports CDC ethernet and RNDIS protocols.
  543: 
  544: @end table
  545: ETEXI
  546: 
  547: DEF("device", HAS_ARG, QEMU_OPTION_device,
  548:     "-device driver[,prop[=value][,...]]\n"
  549:     "                add device (based on driver)\n"
  550:     "                prop=value,... sets driver properties\n"
  551:     "                use -device ? to print all possible drivers\n"
  552:     "                use -device driver,? to print all possible properties\n",
  553:     QEMU_ARCH_ALL)
  554: STEXI
  555: @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
  556: @findex -device
  557: Add device @var{driver}.  @var{prop}=@var{value} sets driver
  558: properties.  Valid properties depend on the driver.  To get help on
  559: possible drivers and properties, use @code{-device ?} and
  560: @code{-device @var{driver},?}.
  561: ETEXI
  562: 
  563: DEFHEADING()
  564: 
  565: DEFHEADING(File system options:)
  566: 
  567: DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
  568:     "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
  569:     " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
  570:     QEMU_ARCH_ALL)
  571: 
  572: STEXI
  573: 
  574: @item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
  575: @findex -fsdev
  576: Define a new file system device. Valid options are:
  577: @table @option
  578: @item @var{fsdriver}
  579: This option specifies the fs driver backend to use.
  580: Currently "local", "handle" and "proxy" file system drivers are supported.
  581: @item id=@var{id}
  582: Specifies identifier for this device
  583: @item path=@var{path}
  584: Specifies the export path for the file system device. Files under
  585: this path will be available to the 9p client on the guest.
  586: @item security_model=@var{security_model}
  587: Specifies the security model to be used for this export path.
  588: Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
  589: In "passthrough" security model, files are stored using the same
  590: credentials as they are created on the guest. This requires QEMU
  591: to run as root. In "mapped-xattr" security model, some of the file
  592: attributes like uid, gid, mode bits and link target are stored as
  593: file attributes. For "mapped-file" these attributes are stored in the
  594: hidden .virtfs_metadata directory. Directories exported by this security model cannot
  595: interact with other unix tools. "none" security model is same as
  596: passthrough except the sever won't report failures if it fails to
  597: set file attributes like ownership. Security model is mandatory
  598: only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
  599: security model as a parameter.
  600: @item writeout=@var{writeout}
  601: This is an optional argument. The only supported value is "immediate".
  602: This means that host page cache will be used to read and write data but
  603: write notification will be sent to the guest only when the data has been
  604: reported as written by the storage subsystem.
  605: @item readonly
  606: Enables exporting 9p share as a readonly mount for guests. By default
  607: read-write access is given.
  608: @item socket=@var{socket}
  609: Enables proxy filesystem driver to use passed socket file for communicating
  610: with virtfs-proxy-helper
  611: @item sock_fd=@var{sock_fd}
  612: Enables proxy filesystem driver to use passed socket descriptor for
  613: communicating with virtfs-proxy-helper. Usually a helper like libvirt
  614: will create socketpair and pass one of the fds as sock_fd
  615: @end table
  616: 
  617: -fsdev option is used along with -device driver "virtio-9p-pci".
  618: @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
  619: Options for virtio-9p-pci driver are:
  620: @table @option
  621: @item fsdev=@var{id}
  622: Specifies the id value specified along with -fsdev option
  623: @item mount_tag=@var{mount_tag}
  624: Specifies the tag name to be used by the guest to mount this export point
  625: @end table
  626: 
  627: ETEXI
  628: 
  629: DEFHEADING()
  630: 
  631: DEFHEADING(Virtual File system pass-through options:)
  632: 
  633: DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
  634:     "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
  635:     "        [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
  636:     QEMU_ARCH_ALL)
  637: 
  638: STEXI
  639: 
  640: @item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
  641: @findex -virtfs
  642: 
  643: The general form of a Virtual File system pass-through options are:
  644: @table @option
  645: @item @var{fsdriver}
  646: This option specifies the fs driver backend to use.
  647: Currently "local", "handle" and "proxy" file system drivers are supported.
  648: @item id=@var{id}
  649: Specifies identifier for this device
  650: @item path=@var{path}
  651: Specifies the export path for the file system device. Files under
  652: this path will be available to the 9p client on the guest.
  653: @item security_model=@var{security_model}
  654: Specifies the security model to be used for this export path.
  655: Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
  656: In "passthrough" security model, files are stored using the same
  657: credentials as they are created on the guest. This requires QEMU
  658: to run as root. In "mapped-xattr" security model, some of the file
  659: attributes like uid, gid, mode bits and link target are stored as
  660: file attributes. For "mapped-file" these attributes are stored in the
  661: hidden .virtfs_metadata directory. Directories exported by this security model cannot
  662: interact with other unix tools. "none" security model is same as
  663: passthrough except the sever won't report failures if it fails to
  664: set file attributes like ownership. Security model is mandatory only
  665: for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
  666: model as a parameter.
  667: @item writeout=@var{writeout}
  668: This is an optional argument. The only supported value is "immediate".
  669: This means that host page cache will be used to read and write data but
  670: write notification will be sent to the guest only when the data has been
  671: reported as written by the storage subsystem.
  672: @item readonly
  673: Enables exporting 9p share as a readonly mount for guests. By default
  674: read-write access is given.
  675: @item socket=@var{socket}
  676: Enables proxy filesystem driver to use passed socket file for
  677: communicating with virtfs-proxy-helper. Usually a helper like libvirt
  678: will create socketpair and pass one of the fds as sock_fd
  679: @item sock_fd
  680: Enables proxy filesystem driver to use passed 'sock_fd' as the socket
  681: descriptor for interfacing with virtfs-proxy-helper
  682: @end table
  683: ETEXI
  684: 
  685: DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
  686:     "-virtfs_synth Create synthetic file system image\n",
  687:     QEMU_ARCH_ALL)
  688: STEXI
  689: @item -virtfs_synth
  690: @findex -virtfs_synth
  691: Create synthetic file system image
  692: ETEXI
  693: 
  694: DEFHEADING()
  695: 
  696: DEF("name", HAS_ARG, QEMU_OPTION_name,
  697:     "-name string1[,process=string2]\n"
  698:     "                set the name of the guest\n"
  699:     "                string1 sets the window title and string2 the process name (on Linux)\n",
  700:     QEMU_ARCH_ALL)
  701: STEXI
  702: @item -name @var{name}
  703: @findex -name
  704: Sets the @var{name} of the guest.
  705: This name will be displayed in the SDL window caption.
  706: The @var{name} will also be used for the VNC server.
  707: Also optionally set the top visible process name in Linux.
  708: ETEXI
  709: 
  710: DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
  711:     "-uuid %08x-%04x-%04x-%04x-%012x\n"
  712:     "                specify machine UUID\n", QEMU_ARCH_ALL)
  713: STEXI
  714: @item -uuid @var{uuid}
  715: @findex -uuid
  716: Set system UUID.
  717: ETEXI
  718: 
  719: STEXI
  720: @end table
  721: ETEXI
  722: 
  723: DEFHEADING()
  724: 
  725: DEFHEADING(Display options:)
  726: 
  727: STEXI
  728: @table @option
  729: ETEXI
  730: 
  731: DEF("display", HAS_ARG, QEMU_OPTION_display,
  732:     "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
  733:     "            [,window_close=on|off]|curses|none|\n"
  734:     "            vnc=<display>[,<optargs>]\n"
  735:     "                select display type\n", QEMU_ARCH_ALL)
  736: STEXI
  737: @item -display @var{type}
  738: @findex -display
  739: Select type of display to use. This option is a replacement for the
  740: old style -sdl/-curses/... options. Valid values for @var{type} are
  741: @table @option
  742: @item sdl
  743: Display video output via SDL (usually in a separate graphics
  744: window; see the SDL documentation for other possibilities).
  745: @item curses
  746: Display video output via curses. For graphics device models which
  747: support a text mode, QEMU can display this output using a
  748: curses/ncurses interface. Nothing is displayed when the graphics
  749: device is in graphical mode or if the graphics device does not support
  750: a text mode. Generally only the VGA device models support text mode.
  751: @item none
  752: Do not display video output. The guest will still see an emulated
  753: graphics card, but its output will not be displayed to the QEMU
  754: user. This option differs from the -nographic option in that it
  755: only affects what is done with video output; -nographic also changes
  756: the destination of the serial and parallel port data.
  757: @item vnc
  758: Start a VNC server on display <arg>
  759: @end table
  760: ETEXI
  761: 
  762: DEF("nographic", 0, QEMU_OPTION_nographic,
  763:     "-nographic      disable graphical output and redirect serial I/Os to console\n",
  764:     QEMU_ARCH_ALL)
  765: STEXI
  766: @item -nographic
  767: @findex -nographic
  768: Normally, QEMU uses SDL to display the VGA output. With this option,
  769: you can totally disable graphical output so that QEMU is a simple
  770: command line application. The emulated serial port is redirected on
  771: the console. Therefore, you can still use QEMU to debug a Linux kernel
  772: with a serial console.
  773: ETEXI
  774: 
  775: DEF("curses", 0, QEMU_OPTION_curses,
  776:     "-curses         use a curses/ncurses interface instead of SDL\n",
  777:     QEMU_ARCH_ALL)
  778: STEXI
  779: @item -curses
  780: @findex curses
  781: Normally, QEMU uses SDL to display the VGA output.  With this option,
  782: QEMU can display the VGA output when in text mode using a
  783: curses/ncurses interface.  Nothing is displayed in graphical mode.
  784: ETEXI
  785: 
  786: DEF("no-frame", 0, QEMU_OPTION_no_frame,
  787:     "-no-frame       open SDL window without a frame and window decorations\n",
  788:     QEMU_ARCH_ALL)
  789: STEXI
  790: @item -no-frame
  791: @findex -no-frame
  792: Do not use decorations for SDL windows and start them using the whole
  793: available screen space. This makes the using QEMU in a dedicated desktop
  794: workspace more convenient.
  795: ETEXI
  796: 
  797: DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
  798:     "-alt-grab       use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
  799:     QEMU_ARCH_ALL)
  800: STEXI
  801: @item -alt-grab
  802: @findex -alt-grab
  803: Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
  804: affects the special keys (for fullscreen, monitor-mode switching, etc).
  805: ETEXI
  806: 
  807: DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
  808:     "-ctrl-grab      use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
  809:     QEMU_ARCH_ALL)
  810: STEXI
  811: @item -ctrl-grab
  812: @findex -ctrl-grab
  813: Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
  814: affects the special keys (for fullscreen, monitor-mode switching, etc).
  815: ETEXI
  816: 
  817: DEF("no-quit", 0, QEMU_OPTION_no_quit,
  818:     "-no-quit        disable SDL window close capability\n", QEMU_ARCH_ALL)
  819: STEXI
  820: @item -no-quit
  821: @findex -no-quit
  822: Disable SDL window close capability.
  823: ETEXI
  824: 
  825: DEF("sdl", 0, QEMU_OPTION_sdl,
  826:     "-sdl            enable SDL\n", QEMU_ARCH_ALL)
  827: STEXI
  828: @item -sdl
  829: @findex -sdl
  830: Enable SDL.
  831: ETEXI
  832: 
  833: DEF("spice", HAS_ARG, QEMU_OPTION_spice,
  834:     "-spice <args>   enable spice\n", QEMU_ARCH_ALL)
  835: STEXI
  836: @item -spice @var{option}[,@var{option}[,...]]
  837: @findex -spice
  838: Enable the spice remote desktop protocol. Valid options are
  839: 
  840: @table @option
  841: 
  842: @item port=<nr>
  843: Set the TCP port spice is listening on for plaintext channels.
  844: 
  845: @item addr=<addr>
  846: Set the IP address spice is listening on.  Default is any address.
  847: 
  848: @item ipv4
  849: @item ipv6
  850: Force using the specified IP version.
  851: 
  852: @item password=<secret>
  853: Set the password you need to authenticate.
  854: 
  855: @item sasl
  856: Require that the client use SASL to authenticate with the spice.
  857: The exact choice of authentication method used is controlled from the
  858: system / user's SASL configuration file for the 'qemu' service. This
  859: is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
  860: unprivileged user, an environment variable SASL_CONF_PATH can be used
  861: to make it search alternate locations for the service config.
  862: While some SASL auth methods can also provide data encryption (eg GSSAPI),
  863: it is recommended that SASL always be combined with the 'tls' and
  864: 'x509' settings to enable use of SSL and server certificates. This
  865: ensures a data encryption preventing compromise of authentication
  866: credentials.
  867: 
  868: @item disable-ticketing
  869: Allow client connects without authentication.
  870: 
  871: @item disable-copy-paste
  872: Disable copy paste between the client and the guest.
  873: 
  874: @item tls-port=<nr>
  875: Set the TCP port spice is listening on for encrypted channels.
  876: 
  877: @item x509-dir=<dir>
  878: Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
  879: 
  880: @item x509-key-file=<file>
  881: @item x509-key-password=<file>
  882: @item x509-cert-file=<file>
  883: @item x509-cacert-file=<file>
  884: @item x509-dh-key-file=<file>
  885: The x509 file names can also be configured individually.
  886: 
  887: @item tls-ciphers=<list>
  888: Specify which ciphers to use.
  889: 
  890: @item tls-channel=[main|display|cursor|inputs|record|playback]
  891: @item plaintext-channel=[main|display|cursor|inputs|record|playback]
  892: Force specific channel to be used with or without TLS encryption.  The
  893: options can be specified multiple times to configure multiple
  894: channels.  The special name "default" can be used to set the default
  895: mode.  For channels which are not explicitly forced into one mode the
  896: spice client is allowed to pick tls/plaintext as he pleases.
  897: 
  898: @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
  899: Configure image compression (lossless).
  900: Default is auto_glz.
  901: 
  902: @item jpeg-wan-compression=[auto|never|always]
  903: @item zlib-glz-wan-compression=[auto|never|always]
  904: Configure wan image compression (lossy for slow links).
  905: Default is auto.
  906: 
  907: @item streaming-video=[off|all|filter]
  908: Configure video stream detection.  Default is filter.
  909: 
  910: @item agent-mouse=[on|off]
  911: Enable/disable passing mouse events via vdagent.  Default is on.
  912: 
  913: @item playback-compression=[on|off]
  914: Enable/disable audio stream compression (using celt 0.5.1).  Default is on.
  915: 
  916: @end table
  917: ETEXI
  918: 
  919: DEF("portrait", 0, QEMU_OPTION_portrait,
  920:     "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n",
  921:     QEMU_ARCH_ALL)
  922: STEXI
  923: @item -portrait
  924: @findex -portrait
  925: Rotate graphical output 90 deg left (only PXA LCD).
  926: ETEXI
  927: 
  928: DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
  929:     "-rotate <deg>   rotate graphical output some deg left (only PXA LCD)\n",
  930:     QEMU_ARCH_ALL)
  931: STEXI
  932: @item -rotate
  933: @findex -rotate
  934: Rotate graphical output some deg left (only PXA LCD).
  935: ETEXI
  936: 
  937: DEF("vga", HAS_ARG, QEMU_OPTION_vga,
  938:     "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
  939:     "                select video card type\n", QEMU_ARCH_ALL)
  940: STEXI
  941: @item -vga @var{type}
  942: @findex -vga
  943: Select type of VGA card to emulate. Valid values for @var{type} are
  944: @table @option
  945: @item cirrus
  946: Cirrus Logic GD5446 Video card. All Windows versions starting from
  947: Windows 95 should recognize and use this graphic card. For optimal
  948: performances, use 16 bit color depth in the guest and the host OS.
  949: (This one is the default)
  950: @item std
  951: Standard VGA card with Bochs VBE extensions.  If your guest OS
  952: supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
  953: to use high resolution modes (>= 1280x1024x16) then you should use
  954: this option.
  955: @item vmware
  956: VMWare SVGA-II compatible adapter. Use it if you have sufficiently
  957: recent XFree86/XOrg server or Windows guest with a driver for this
  958: card.
  959: @item qxl
  960: QXL paravirtual graphic card.  It is VGA compatible (including VESA
  961: 2.0 VBE support).  Works best with qxl guest drivers installed though.
  962: Recommended choice when using the spice protocol.
  963: @item none
  964: Disable VGA card.
  965: @end table
  966: ETEXI
  967: 
  968: DEF("full-screen", 0, QEMU_OPTION_full_screen,
  969:     "-full-screen    start in full screen\n", QEMU_ARCH_ALL)
  970: STEXI
  971: @item -full-screen
  972: @findex -full-screen
  973: Start in full screen.
  974: ETEXI
  975: 
  976: DEF("g", 1, QEMU_OPTION_g ,
  977:     "-g WxH[xDEPTH]  Set the initial graphical resolution and depth\n",
  978:     QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
  979: STEXI
  980: @item -g @var{width}x@var{height}[x@var{depth}]
  981: @findex -g
  982: Set the initial graphical resolution and depth (PPC, SPARC only).
  983: ETEXI
  984: 
  985: DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
  986:     "-vnc display    start a VNC server on display\n", QEMU_ARCH_ALL)
  987: STEXI
  988: @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
  989: @findex -vnc
  990: Normally, QEMU uses SDL to display the VGA output.  With this option,
  991: you can have QEMU listen on VNC display @var{display} and redirect the VGA
  992: display over the VNC session.  It is very useful to enable the usb
  993: tablet device when using this option (option @option{-usbdevice
  994: tablet}). When using the VNC display, you must use the @option{-k}
  995: parameter to set the keyboard layout if you are not using en-us. Valid
  996: syntax for the @var{display} is
  997: 
  998: @table @option
  999: 
 1000: @item @var{host}:@var{d}
 1001: 
 1002: TCP connections will only be allowed from @var{host} on display @var{d}.
 1003: By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
 1004: be omitted in which case the server will accept connections from any host.
 1005: 
 1006: @item unix:@var{path}
 1007: 
 1008: Connections will be allowed over UNIX domain sockets where @var{path} is the
 1009: location of a unix socket to listen for connections on.
 1010: 
 1011: @item none
 1012: 
 1013: VNC is initialized but not started. The monitor @code{change} command
 1014: can be used to later start the VNC server.
 1015: 
 1016: @end table
 1017: 
 1018: Following the @var{display} value there may be one or more @var{option} flags
 1019: separated by commas. Valid options are
 1020: 
 1021: @table @option
 1022: 
 1023: @item reverse
 1024: 
 1025: Connect to a listening VNC client via a ``reverse'' connection. The
 1026: client is specified by the @var{display}. For reverse network
 1027: connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
 1028: is a TCP port number, not a display number.
 1029: 
 1030: @item password
 1031: 
 1032: Require that password based authentication is used for client connections.
 1033: The password must be set separately using the @code{change} command in the
 1034: @ref{pcsys_monitor}
 1035: 
 1036: @item tls
 1037: 
 1038: Require that client use TLS when communicating with the VNC server. This
 1039: uses anonymous TLS credentials so is susceptible to a man-in-the-middle
 1040: attack. It is recommended that this option be combined with either the
 1041: @option{x509} or @option{x509verify} options.
 1042: 
 1043: @item x509=@var{/path/to/certificate/dir}
 1044: 
 1045: Valid if @option{tls} is specified. Require that x509 credentials are used
 1046: for negotiating the TLS session. The server will send its x509 certificate
 1047: to the client. It is recommended that a password be set on the VNC server
 1048: to provide authentication of the client when this is used. The path following
 1049: this option specifies where the x509 certificates are to be loaded from.
 1050: See the @ref{vnc_security} section for details on generating certificates.
 1051: 
 1052: @item x509verify=@var{/path/to/certificate/dir}
 1053: 
 1054: Valid if @option{tls} is specified. Require that x509 credentials are used
 1055: for negotiating the TLS session. The server will send its x509 certificate
 1056: to the client, and request that the client send its own x509 certificate.
 1057: The server will validate the client's certificate against the CA certificate,
 1058: and reject clients when validation fails. If the certificate authority is
 1059: trusted, this is a sufficient authentication mechanism. You may still wish
 1060: to set a password on the VNC server as a second authentication layer. The
 1061: path following this option specifies where the x509 certificates are to
 1062: be loaded from. See the @ref{vnc_security} section for details on generating
 1063: certificates.
 1064: 
 1065: @item sasl
 1066: 
 1067: Require that the client use SASL to authenticate with the VNC server.
 1068: The exact choice of authentication method used is controlled from the
 1069: system / user's SASL configuration file for the 'qemu' service. This
 1070: is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
 1071: unprivileged user, an environment variable SASL_CONF_PATH can be used
 1072: to make it search alternate locations for the service config.
 1073: While some SASL auth methods can also provide data encryption (eg GSSAPI),
 1074: it is recommended that SASL always be combined with the 'tls' and
 1075: 'x509' settings to enable use of SSL and server certificates. This
 1076: ensures a data encryption preventing compromise of authentication
 1077: credentials. See the @ref{vnc_security} section for details on using
 1078: SASL authentication.
 1079: 
 1080: @item acl
 1081: 
 1082: Turn on access control lists for checking of the x509 client certificate
 1083: and SASL party. For x509 certs, the ACL check is made against the
 1084: certificate's distinguished name. This is something that looks like
 1085: @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
 1086: made against the username, which depending on the SASL plugin, may
 1087: include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
 1088: When the @option{acl} flag is set, the initial access list will be
 1089: empty, with a @code{deny} policy. Thus no one will be allowed to
 1090: use the VNC server until the ACLs have been loaded. This can be
 1091: achieved using the @code{acl} monitor command.
 1092: 
 1093: @item lossy
 1094: 
 1095: Enable lossy compression methods (gradient, JPEG, ...). If this
 1096: option is set, VNC client may receive lossy framebuffer updates
 1097: depending on its encoding settings. Enabling this option can save
 1098: a lot of bandwidth at the expense of quality.
 1099: 
 1100: @item non-adaptive
 1101: 
 1102: Disable adaptive encodings. Adaptive encodings are enabled by default.
 1103: An adaptive encoding will try to detect frequently updated screen regions,
 1104: and send updates in these regions using a lossy encoding (like JPEG).
 1105: This can be really helpful to save bandwidth when playing videos. Disabling
 1106: adaptive encodings allows to restore the original static behavior of encodings
 1107: like Tight.
 1108: 
 1109: @item share=[allow-exclusive|force-shared|ignore]
 1110: 
 1111: Set display sharing policy.  'allow-exclusive' allows clients to ask
 1112: for exclusive access.  As suggested by the rfb spec this is
 1113: implemented by dropping other connections.  Connecting multiple
 1114: clients in parallel requires all clients asking for a shared session
 1115: (vncviewer: -shared switch).  This is the default.  'force-shared'
 1116: disables exclusive client access.  Useful for shared desktop sessions,
 1117: where you don't want someone forgetting specify -shared disconnect
 1118: everybody else.  'ignore' completely ignores the shared flag and
 1119: allows everybody connect unconditionally.  Doesn't conform to the rfb
 1120: spec but is traditional QEMU behavior.
 1121: 
 1122: @end table
 1123: ETEXI
 1124: 
 1125: STEXI
 1126: @end table
 1127: ETEXI
 1128: 
 1129: ARCHHEADING(, QEMU_ARCH_I386)
 1130: 
 1131: ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
 1132: STEXI
 1133: @table @option
 1134: ETEXI
 1135: 
 1136: DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
 1137:     "-win2k-hack     use it when installing Windows 2000 to avoid a disk full bug\n",
 1138:     QEMU_ARCH_I386)
 1139: STEXI
 1140: @item -win2k-hack
 1141: @findex -win2k-hack
 1142: Use it when installing Windows 2000 to avoid a disk full bug. After
 1143: Windows 2000 is installed, you no longer need this option (this option
 1144: slows down the IDE transfers).
 1145: ETEXI
 1146: 
 1147: HXCOMM Deprecated by -rtc
 1148: DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
 1149: 
 1150: DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
 1151:     "-no-fd-bootchk  disable boot signature checking for floppy disks\n",
 1152:     QEMU_ARCH_I386)
 1153: STEXI
 1154: @item -no-fd-bootchk
 1155: @findex -no-fd-bootchk
 1156: Disable boot signature checking for floppy disks in Bochs BIOS. It may
 1157: be needed to boot from old floppy disks.
 1158: TODO: check reference to Bochs BIOS.
 1159: ETEXI
 1160: 
 1161: DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
 1162:            "-no-acpi        disable ACPI\n", QEMU_ARCH_I386)
 1163: STEXI
 1164: @item -no-acpi
 1165: @findex -no-acpi
 1166: Disable ACPI (Advanced Configuration and Power Interface) support. Use
 1167: it if your guest OS complains about ACPI problems (PC target machine
 1168: only).
 1169: ETEXI
 1170: 
 1171: DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
 1172:     "-no-hpet        disable HPET\n", QEMU_ARCH_I386)
 1173: STEXI
 1174: @item -no-hpet
 1175: @findex -no-hpet
 1176: Disable HPET support.
 1177: ETEXI
 1178: 
 1179: DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
 1180:     "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
 1181:     "                ACPI table description\n", QEMU_ARCH_I386)
 1182: STEXI
 1183: @item -acpitable [sig=@var{str}][,rev=@var{n}][,oem_id=@var{str}][,oem_table_id=@var{str}][,oem_rev=@var{n}] [,asl_compiler_id=@var{str}][,asl_compiler_rev=@var{n}][,data=@var{file1}[:@var{file2}]...]
 1184: @findex -acpitable
 1185: Add ACPI table with specified header fields and context from specified files.
 1186: For file=, take whole ACPI table from the specified files, including all
 1187: ACPI headers (possible overridden by other options).
 1188: For data=, only data
 1189: portion of the table is used, all header information is specified in the
 1190: command line.
 1191: ETEXI
 1192: 
 1193: DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
 1194:     "-smbios file=binary\n"
 1195:     "                load SMBIOS entry from binary file\n"
 1196:     "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
 1197:     "                specify SMBIOS type 0 fields\n"
 1198:     "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
 1199:     "              [,uuid=uuid][,sku=str][,family=str]\n"
 1200:     "                specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
 1201: STEXI
 1202: @item -smbios file=@var{binary}
 1203: @findex -smbios
 1204: Load SMBIOS entry from binary file.
 1205: 
 1206: @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
 1207: @findex -smbios
 1208: Specify SMBIOS type 0 fields
 1209: 
 1210: @item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}] [,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}] [,family=@var{str}]
 1211: Specify SMBIOS type 1 fields
 1212: ETEXI
 1213: 
 1214: DEFHEADING()
 1215: STEXI
 1216: @end table
 1217: ETEXI
 1218: 
 1219: DEFHEADING(Network options:)
 1220: STEXI
 1221: @table @option
 1222: ETEXI
 1223: 
 1224: HXCOMM Legacy slirp options (now moved to -net user):
 1225: #ifdef CONFIG_SLIRP
 1226: DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
 1227: DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
 1228: DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
 1229: #ifndef _WIN32
 1230: DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
 1231: #endif
 1232: #endif
 1233: 
 1234: DEF("net", HAS_ARG, QEMU_OPTION_net,
 1235:     "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
 1236:     "                create a new Network Interface Card and connect it to VLAN 'n'\n"
 1237: #ifdef CONFIG_SLIRP
 1238:     "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
 1239:     "         [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
 1240:     "         [,hostfwd=rule][,guestfwd=rule]"
 1241: #ifndef _WIN32
 1242:                                              "[,smb=dir[,smbserver=addr]]\n"
 1243: #endif
 1244:     "                connect the user mode network stack to VLAN 'n', configure its\n"
 1245:     "                DHCP server and enabled optional services\n"
 1246: #endif
 1247: #ifdef _WIN32
 1248:     "-net tap[,vlan=n][,name=str],ifname=name\n"
 1249:     "                connect the host TAP network interface to VLAN 'n'\n"
 1250: #else
 1251:     "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n"
 1252:     "                connect the host TAP network interface to VLAN 'n' \n"
 1253:     "                use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
 1254:     "                to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
 1255:     "                to deconfigure it\n"
 1256:     "                use '[down]script=no' to disable script execution\n"
 1257:     "                use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
 1258:     "                configure it\n"
 1259:     "                use 'fd=h' to connect to an already opened TAP interface\n"
 1260:     "                use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
 1261:     "                default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
 1262:     "                use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
 1263:     "                use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
 1264:     "                use vhost=on to enable experimental in kernel accelerator\n"
 1265:     "                    (only has effect for virtio guests which use MSIX)\n"
 1266:     "                use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
 1267:     "                use 'vhostfd=h' to connect to an already opened vhost net device\n"
 1268:     "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n"
 1269:     "                connects a host TAP network interface to a host bridge device 'br'\n"
 1270:     "                (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n"
 1271:     "                (default=" DEFAULT_BRIDGE_HELPER ")\n"
 1272: #endif
 1273:     "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
 1274:     "                connect the vlan 'n' to another VLAN using a socket connection\n"
 1275:     "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
 1276:     "                connect the vlan 'n' to multicast maddr and port\n"
 1277:     "                use 'localaddr=addr' to specify the host address to send packets from\n"
 1278:     "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n"
 1279:     "                connect the vlan 'n' to another VLAN using an UDP tunnel\n"
 1280: #ifdef CONFIG_VDE
 1281:     "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
 1282:     "                connect the vlan 'n' to port 'n' of a vde switch running\n"
 1283:     "                on host and listening for incoming connections on 'socketpath'.\n"
 1284:     "                Use group 'groupname' and mode 'octalmode' to change default\n"
 1285:     "                ownership and permissions for communication port.\n"
 1286: #endif
 1287:     "-net dump[,vlan=n][,file=f][,len=n]\n"
 1288:     "                dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
 1289:     "-net none       use it alone to have zero network devices. If no -net option\n"
 1290:     "                is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
 1291: DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
 1292:     "-netdev ["
 1293: #ifdef CONFIG_SLIRP
 1294:     "user|"
 1295: #endif
 1296:     "tap|"
 1297:     "bridge|"
 1298: #ifdef CONFIG_VDE
 1299:     "vde|"
 1300: #endif
 1301:     "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
 1302: STEXI
 1303: @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
 1304: @findex -net
 1305: Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
 1306: = 0 is the default). The NIC is an e1000 by default on the PC
 1307: target. Optionally, the MAC address can be changed to @var{mac}, the
 1308: device address set to @var{addr} (PCI cards only),
 1309: and a @var{name} can be assigned for use in monitor commands.
 1310: Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
 1311: that the card should have; this option currently only affects virtio cards; set
 1312: @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
 1313: NIC is created.  QEMU can emulate several different models of network card.
 1314: Valid values for @var{type} are
 1315: @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
 1316: @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
 1317: @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
 1318: Not all devices are supported on all targets.  Use -net nic,model=?
 1319: for a list of available devices for your target.
 1320: 
 1321: @item -net user[,@var{option}][,@var{option}][,...]
 1322: Use the user mode network stack which requires no administrator
 1323: privilege to run. Valid options are:
 1324: 
 1325: @table @option
 1326: @item vlan=@var{n}
 1327: Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
 1328: 
 1329: @item name=@var{name}
 1330: Assign symbolic name for use in monitor commands.
 1331: 
 1332: @item net=@var{addr}[/@var{mask}]
 1333: Set IP network address the guest will see. Optionally specify the netmask,
 1334: either in the form a.b.c.d or as number of valid top-most bits. Default is
 1335: 10.0.2.0/24.
 1336: 
 1337: @item host=@var{addr}
 1338: Specify the guest-visible address of the host. Default is the 2nd IP in the
 1339: guest network, i.e. x.x.x.2.
 1340: 
 1341: @item restrict=on|off
 1342: If this option is enabled, the guest will be isolated, i.e. it will not be
 1343: able to contact the host and no guest IP packets will be routed over the host
 1344: to the outside. This option does not affect any explicitly set forwarding rules.
 1345: 
 1346: @item hostname=@var{name}
 1347: Specifies the client hostname reported by the builtin DHCP server.
 1348: 
 1349: @item dhcpstart=@var{addr}
 1350: Specify the first of the 16 IPs the built-in DHCP server can assign. Default
 1351: is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
 1352: 
 1353: @item dns=@var{addr}
 1354: Specify the guest-visible address of the virtual nameserver. The address must
 1355: be different from the host address. Default is the 3rd IP in the guest network,
 1356: i.e. x.x.x.3.
 1357: 
 1358: @item tftp=@var{dir}
 1359: When using the user mode network stack, activate a built-in TFTP
 1360: server. The files in @var{dir} will be exposed as the root of a TFTP server.
 1361: The TFTP client on the guest must be configured in binary mode (use the command
 1362: @code{bin} of the Unix TFTP client).
 1363: 
 1364: @item bootfile=@var{file}
 1365: When using the user mode network stack, broadcast @var{file} as the BOOTP
 1366: filename. In conjunction with @option{tftp}, this can be used to network boot
 1367: a guest from a local directory.
 1368: 
 1369: Example (using pxelinux):
 1370: @example
 1371: qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
 1372: @end example
 1373: 
 1374: @item smb=@var{dir}[,smbserver=@var{addr}]
 1375: When using the user mode network stack, activate a built-in SMB
 1376: server so that Windows OSes can access to the host files in @file{@var{dir}}
 1377: transparently. The IP address of the SMB server can be set to @var{addr}. By
 1378: default the 4th IP in the guest network is used, i.e. x.x.x.4.
 1379: 
 1380: In the guest Windows OS, the line:
 1381: @example
 1382: 10.0.2.4 smbserver
 1383: @end example
 1384: must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
 1385: or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
 1386: 
 1387: Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
 1388: 
 1389: Note that a SAMBA server must be installed on the host OS.
 1390: QEMU was tested successfully with smbd versions from Red Hat 9,
 1391: Fedora Core 3 and OpenSUSE 11.x.
 1392: 
 1393: @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
 1394: Redirect incoming TCP or UDP connections to the host port @var{hostport} to
 1395: the guest IP address @var{guestaddr} on guest port @var{guestport}. If
 1396: @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
 1397: given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
 1398: be bound to a specific host interface. If no connection type is set, TCP is
 1399: used. This option can be given multiple times.
 1400: 
 1401: For example, to redirect host X11 connection from screen 1 to guest
 1402: screen 0, use the following:
 1403: 
 1404: @example
 1405: # on the host
 1406: qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
 1407: # this host xterm should open in the guest X11 server
 1408: xterm -display :1
 1409: @end example
 1410: 
 1411: To redirect telnet connections from host port 5555 to telnet port on
 1412: the guest, use the following:
 1413: 
 1414: @example
 1415: # on the host
 1416: qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
 1417: telnet localhost 5555
 1418: @end example
 1419: 
 1420: Then when you use on the host @code{telnet localhost 5555}, you
 1421: connect to the guest telnet server.
 1422: 
 1423: @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
 1424: Forward guest TCP connections to the IP address @var{server} on port @var{port}
 1425: to the character device @var{dev}. This option can be given multiple times.
 1426: 
 1427: @end table
 1428: 
 1429: Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
 1430: processed and applied to -net user. Mixing them with the new configuration
 1431: syntax gives undefined results. Their use for new applications is discouraged
 1432: as they will be removed from future versions.
 1433: 
 1434: @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
 1435: Connect the host TAP network interface @var{name} to VLAN @var{n}.
 1436: 
 1437: Use the network script @var{file} to configure it and the network script
 1438: @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
 1439: automatically provides one. The default network configure script is
 1440: @file{/etc/qemu-ifup} and the default network deconfigure script is
 1441: @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
 1442: to disable script execution.
 1443: 
 1444: If running QEMU as an unprivileged user, use the network helper
 1445: @var{helper} to configure the TAP interface. The default network
 1446: helper executable is @file{/usr/local/libexec/qemu-bridge-helper}.
 1447: 
 1448: @option{fd}=@var{h} can be used to specify the handle of an already
 1449: opened host TAP interface.
 1450: 
 1451: Examples:
 1452: 
 1453: @example
 1454: #launch a QEMU instance with the default network script
 1455: qemu-system-i386 linux.img -net nic -net tap
 1456: @end example
 1457: 
 1458: @example
 1459: #launch a QEMU instance with two NICs, each one connected
 1460: #to a TAP device
 1461: qemu-system-i386 linux.img \
 1462:                  -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
 1463:                  -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
 1464: @end example
 1465: 
 1466: @example
 1467: #launch a QEMU instance with the default network helper to
 1468: #connect a TAP device to bridge br0
 1469: qemu-system-i386 linux.img \
 1470:                  -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper"
 1471: @end example
 1472: 
 1473: @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
 1474: Connect a host TAP network interface to a host bridge device.
 1475: 
 1476: Use the network helper @var{helper} to configure the TAP interface and
 1477: attach it to the bridge. The default network helper executable is
 1478: @file{/usr/local/libexec/qemu-bridge-helper} and the default bridge
 1479: device is @file{br0}.
 1480: 
 1481: Examples:
 1482: 
 1483: @example
 1484: #launch a QEMU instance with the default network helper to
 1485: #connect a TAP device to bridge br0
 1486: qemu-system-i386 linux.img -net bridge -net nic,model=virtio
 1487: @end example
 1488: 
 1489: @example
 1490: #launch a QEMU instance with the default network helper to
 1491: #connect a TAP device to bridge qemubr0
 1492: qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
 1493: @end example
 1494: 
 1495: @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
 1496: 
 1497: Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
 1498: machine using a TCP socket connection. If @option{listen} is
 1499: specified, QEMU waits for incoming connections on @var{port}
 1500: (@var{host} is optional). @option{connect} is used to connect to
 1501: another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
 1502: specifies an already opened TCP socket.
 1503: 
 1504: Example:
 1505: @example
 1506: # launch a first QEMU instance
 1507: qemu-system-i386 linux.img \
 1508:                  -net nic,macaddr=52:54:00:12:34:56 \
 1509:                  -net socket,listen=:1234
 1510: # connect the VLAN 0 of this instance to the VLAN 0
 1511: # of the first instance
 1512: qemu-system-i386 linux.img \
 1513:                  -net nic,macaddr=52:54:00:12:34:57 \
 1514:                  -net socket,connect=127.0.0.1:1234
 1515: @end example
 1516: 
 1517: @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
 1518: 
 1519: Create a VLAN @var{n} shared with another QEMU virtual
 1520: machines using a UDP multicast socket, effectively making a bus for
 1521: every QEMU with same multicast address @var{maddr} and @var{port}.
 1522: NOTES:
 1523: @enumerate
 1524: @item
 1525: Several QEMU can be running on different hosts and share same bus (assuming
 1526: correct multicast setup for these hosts).
 1527: @item
 1528: mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
 1529: @url{http://user-mode-linux.sf.net}.
 1530: @item
 1531: Use @option{fd=h} to specify an already opened UDP multicast socket.
 1532: @end enumerate
 1533: 
 1534: Example:
 1535: @example
 1536: # launch one QEMU instance
 1537: qemu-system-i386 linux.img \
 1538:                  -net nic,macaddr=52:54:00:12:34:56 \
 1539:                  -net socket,mcast=230.0.0.1:1234
 1540: # launch another QEMU instance on same "bus"
 1541: qemu-system-i386 linux.img \
 1542:                  -net nic,macaddr=52:54:00:12:34:57 \
 1543:                  -net socket,mcast=230.0.0.1:1234
 1544: # launch yet another QEMU instance on same "bus"
 1545: qemu-system-i386 linux.img \
 1546:                  -net nic,macaddr=52:54:00:12:34:58 \
 1547:                  -net socket,mcast=230.0.0.1:1234
 1548: @end example
 1549: 
 1550: Example (User Mode Linux compat.):
 1551: @example
 1552: # launch QEMU instance (note mcast address selected
 1553: # is UML's default)
 1554: qemu-system-i386 linux.img \
 1555:                  -net nic,macaddr=52:54:00:12:34:56 \
 1556:                  -net socket,mcast=239.192.168.1:1102
 1557: # launch UML
 1558: /path/to/linux ubd0=/path/to/root_fs eth0=mcast
 1559: @end example
 1560: 
 1561: Example (send packets from host's 1.2.3.4):
 1562: @example
 1563: qemu-system-i386 linux.img \
 1564:                  -net nic,macaddr=52:54:00:12:34:56 \
 1565:                  -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
 1566: @end example
 1567: 
 1568: @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
 1569: Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
 1570: listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
 1571: and MODE @var{octalmode} to change default ownership and permissions for
 1572: communication port. This option is only available if QEMU has been compiled
 1573: with vde support enabled.
 1574: 
 1575: Example:
 1576: @example
 1577: # launch vde switch
 1578: vde_switch -F -sock /tmp/myswitch
 1579: # launch QEMU instance
 1580: qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
 1581: @end example
 1582: 
 1583: @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
 1584: Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
 1585: At most @var{len} bytes (64k by default) per packet are stored. The file format is
 1586: libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
 1587: 
 1588: @item -net none
 1589: Indicate that no network devices should be configured. It is used to
 1590: override the default configuration (@option{-net nic -net user}) which
 1591: is activated if no @option{-net} options are provided.
 1592: 
 1593: @end table
 1594: ETEXI
 1595: 
 1596: DEFHEADING()
 1597: 
 1598: DEFHEADING(Character device options:)
 1599: 
 1600: DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
 1601:     "-chardev null,id=id[,mux=on|off]\n"
 1602:     "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
 1603:     "         [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
 1604:     "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
 1605:     "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
 1606:     "         [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
 1607:     "-chardev msmouse,id=id[,mux=on|off]\n"
 1608:     "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
 1609:     "         [,mux=on|off]\n"
 1610:     "-chardev file,id=id,path=path[,mux=on|off]\n"
 1611:     "-chardev pipe,id=id,path=path[,mux=on|off]\n"
 1612: #ifdef _WIN32
 1613:     "-chardev console,id=id[,mux=on|off]\n"
 1614:     "-chardev serial,id=id,path=path[,mux=on|off]\n"
 1615: #else
 1616:     "-chardev pty,id=id[,mux=on|off]\n"
 1617:     "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
 1618: #endif
 1619: #ifdef CONFIG_BRLAPI
 1620:     "-chardev braille,id=id[,mux=on|off]\n"
 1621: #endif
 1622: #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
 1623:         || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
 1624:     "-chardev tty,id=id,path=path[,mux=on|off]\n"
 1625: #endif
 1626: #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
 1627:     "-chardev parport,id=id,path=path[,mux=on|off]\n"
 1628: #endif
 1629: #if defined(CONFIG_SPICE)
 1630:     "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
 1631: #endif
 1632:     , QEMU_ARCH_ALL
 1633: )
 1634: 
 1635: STEXI
 1636: 
 1637: The general form of a character device option is:
 1638: @table @option
 1639: 
 1640: @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
 1641: @findex -chardev
 1642: Backend is one of:
 1643: @option{null},
 1644: @option{socket},
 1645: @option{udp},
 1646: @option{msmouse},
 1647: @option{vc},
 1648: @option{file},
 1649: @option{pipe},
 1650: @option{console},
 1651: @option{serial},
 1652: @option{pty},
 1653: @option{stdio},
 1654: @option{braille},
 1655: @option{tty},
 1656: @option{parport},
 1657: @option{spicevmc}.
 1658: The specific backend will determine the applicable options.
 1659: 
 1660: All devices must have an id, which can be any string up to 127 characters long.
 1661: It is used to uniquely identify this device in other command line directives.
 1662: 
 1663: A character device may be used in multiplexing mode by multiple front-ends.
 1664: The key sequence of @key{Control-a} and @key{c} will rotate the input focus
 1665: between attached front-ends. Specify @option{mux=on} to enable this mode.
 1666: 
 1667: Options to each backend are described below.
 1668: 
 1669: @item -chardev null ,id=@var{id}
 1670: A void device. This device will not emit any data, and will drop any data it
 1671: receives. The null backend does not take any options.
 1672: 
 1673: @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
 1674: 
 1675: Create a two-way stream socket, which can be either a TCP or a unix socket. A
 1676: unix socket will be created if @option{path} is specified. Behaviour is
 1677: undefined if TCP options are specified for a unix socket.
 1678: 
 1679: @option{server} specifies that the socket shall be a listening socket.
 1680: 
 1681: @option{nowait} specifies that QEMU should not block waiting for a client to
 1682: connect to a listening socket.
 1683: 
 1684: @option{telnet} specifies that traffic on the socket should interpret telnet
 1685: escape sequences.
 1686: 
 1687: TCP and unix socket options are given below:
 1688: 
 1689: @table @option
 1690: 
 1691: @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
 1692: 
 1693: @option{host} for a listening socket specifies the local address to be bound.
 1694: For a connecting socket species the remote host to connect to. @option{host} is
 1695: optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
 1696: 
 1697: @option{port} for a listening socket specifies the local port to be bound. For a
 1698: connecting socket specifies the port on the remote host to connect to.
 1699: @option{port} can be given as either a port number or a service name.
 1700: @option{port} is required.
 1701: 
 1702: @option{to} is only relevant to listening sockets. If it is specified, and
 1703: @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
 1704: to and including @option{to} until it succeeds. @option{to} must be specified
 1705: as a port number.
 1706: 
 1707: @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
 1708: If neither is specified the socket may use either protocol.
 1709: 
 1710: @option{nodelay} disables the Nagle algorithm.
 1711: 
 1712: @item unix options: path=@var{path}
 1713: 
 1714: @option{path} specifies the local path of the unix socket. @option{path} is
 1715: required.
 1716: 
 1717: @end table
 1718: 
 1719: @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
 1720: 
 1721: Sends all traffic from the guest to a remote host over UDP.
 1722: 
 1723: @option{host} specifies the remote host to connect to. If not specified it
 1724: defaults to @code{localhost}.
 1725: 
 1726: @option{port} specifies the port on the remote host to connect to. @option{port}
 1727: is required.
 1728: 
 1729: @option{localaddr} specifies the local address to bind to. If not specified it
 1730: defaults to @code{0.0.0.0}.
 1731: 
 1732: @option{localport} specifies the local port to bind to. If not specified any
 1733: available local port will be used.
 1734: 
 1735: @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
 1736: If neither is specified the device may use either protocol.
 1737: 
 1738: @item -chardev msmouse ,id=@var{id}
 1739: 
 1740: Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
 1741: take any options.
 1742: 
 1743: @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
 1744: 
 1745: Connect to a QEMU text console. @option{vc} may optionally be given a specific
 1746: size.
 1747: 
 1748: @option{width} and @option{height} specify the width and height respectively of
 1749: the console, in pixels.
 1750: 
 1751: @option{cols} and @option{rows} specify that the console be sized to fit a text
 1752: console with the given dimensions.
 1753: 
 1754: @item -chardev file ,id=@var{id} ,path=@var{path}
 1755: 
 1756: Log all traffic received from the guest to a file.
 1757: 
 1758: @option{path} specifies the path of the file to be opened. This file will be
 1759: created if it does not already exist, and overwritten if it does. @option{path}
 1760: is required.
 1761: 
 1762: @item -chardev pipe ,id=@var{id} ,path=@var{path}
 1763: 
 1764: Create a two-way connection to the guest. The behaviour differs slightly between
 1765: Windows hosts and other hosts:
 1766: 
 1767: On Windows, a single duplex pipe will be created at
 1768: @file{\\.pipe\@option{path}}.
 1769: 
 1770: On other hosts, 2 pipes will be created called @file{@option{path}.in} and
 1771: @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
 1772: received by the guest. Data written by the guest can be read from
 1773: @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
 1774: be present.
 1775: 
 1776: @option{path} forms part of the pipe path as described above. @option{path} is
 1777: required.
 1778: 
 1779: @item -chardev console ,id=@var{id}
 1780: 
 1781: Send traffic from the guest to QEMU's standard output. @option{console} does not
 1782: take any options.
 1783: 
 1784: @option{console} is only available on Windows hosts.
 1785: 
 1786: @item -chardev serial ,id=@var{id} ,path=@option{path}
 1787: 
 1788: Send traffic from the guest to a serial device on the host.
 1789: 
 1790: @option{serial} is
 1791: only available on Windows hosts.
 1792: 
 1793: @option{path} specifies the name of the serial device to open.
 1794: 
 1795: @item -chardev pty ,id=@var{id}
 1796: 
 1797: Create a new pseudo-terminal on the host and connect to it. @option{pty} does
 1798: not take any options.
 1799: 
 1800: @option{pty} is not available on Windows hosts.
 1801: 
 1802: @item -chardev stdio ,id=@var{id} [,signal=on|off]
 1803: Connect to standard input and standard output of the QEMU process.
 1804: 
 1805: @option{signal} controls if signals are enabled on the terminal, that includes
 1806: exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
 1807: default, use @option{signal=off} to disable it.
 1808: 
 1809: @option{stdio} is not available on Windows hosts.
 1810: 
 1811: @item -chardev braille ,id=@var{id}
 1812: 
 1813: Connect to a local BrlAPI server. @option{braille} does not take any options.
 1814: 
 1815: @item -chardev tty ,id=@var{id} ,path=@var{path}
 1816: 
 1817: Connect to a local tty device.
 1818: 
 1819: @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
 1820: DragonFlyBSD hosts.
 1821: 
 1822: @option{path} specifies the path to the tty. @option{path} is required.
 1823: 
 1824: @item -chardev parport ,id=@var{id} ,path=@var{path}
 1825: 
 1826: @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
 1827: 
 1828: Connect to a local parallel port.
 1829: 
 1830: @option{path} specifies the path to the parallel port device. @option{path} is
 1831: required.
 1832: 
 1833: @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
 1834: 
 1835: @option{spicevmc} is only available when spice support is built in.
 1836: 
 1837: @option{debug} debug level for spicevmc
 1838: 
 1839: @option{name} name of spice channel to connect to
 1840: 
 1841: Connect to a spice virtual machine channel, such as vdiport.
 1842: 
 1843: @end table
 1844: ETEXI
 1845: 
 1846: DEFHEADING()
 1847: 
 1848: STEXI
 1849: DEFHEADING(Device URL Syntax:)
 1850: 
 1851: In addition to using normal file images for the emulated storage devices,
 1852: QEMU can also use networked resources such as iSCSI devices. These are
 1853: specified using a special URL syntax.
 1854: 
 1855: @table @option
 1856: @item iSCSI
 1857: iSCSI support allows QEMU to access iSCSI resources directly and use as
 1858: images for the guest storage. Both disk and cdrom images are supported.
 1859: 
 1860: Syntax for specifying iSCSI LUNs is
 1861: ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
 1862: 
 1863: Example (without authentication):
 1864: @example
 1865: qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
 1866:                  -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
 1867:                  -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
 1868: @end example
 1869: 
 1870: Example (CHAP username/password via URL):
 1871: @example
 1872: qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
 1873: @end example
 1874: 
 1875: Example (CHAP username/password via environment variables):
 1876: @example
 1877: LIBISCSI_CHAP_USERNAME="user" \
 1878: LIBISCSI_CHAP_PASSWORD="password" \
 1879: qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
 1880: @end example
 1881: 
 1882: iSCSI support is an optional feature of QEMU and only available when
 1883: compiled and linked against libiscsi.
 1884: ETEXI
 1885: DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
 1886:     "-iscsi [user=user][,password=password]\n"
 1887:     "       [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
 1888:     "       [,initiator-name=iqn]\n"
 1889:     "                iSCSI session parameters\n", QEMU_ARCH_ALL)
 1890: STEXI
 1891: 
 1892: @item NBD
 1893: QEMU supports NBD (Network Block Devices) both using TCP protocol as well
 1894: as Unix Domain Sockets.
 1895: 
 1896: Syntax for specifying a NBD device using TCP
 1897: ``nbd:<server-ip>:<port>[:exportname=<export>]''
 1898: 
 1899: Syntax for specifying a NBD device using Unix Domain Sockets
 1900: ``nbd:unix:<domain-socket>[:exportname=<export>]''
 1901: 
 1902: 
 1903: Example for TCP
 1904: @example
 1905: qemu-system-i386 --drive file=nbd:192.0.2.1:30000
 1906: @end example
 1907: 
 1908: Example for Unix Domain Sockets
 1909: @example
 1910: qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
 1911: @end example
 1912: 
 1913: @item Sheepdog
 1914: Sheepdog is a distributed storage system for QEMU.
 1915: QEMU supports using either local sheepdog devices or remote networked
 1916: devices.
 1917: 
 1918: Syntax for specifying a sheepdog device
 1919: @table @list
 1920: ``sheepdog:<vdiname>''
 1921: 
 1922: ``sheepdog:<vdiname>:<snapid>''
 1923: 
 1924: ``sheepdog:<vdiname>:<tag>''
 1925: 
 1926: ``sheepdog:<host>:<port>:<vdiname>''
 1927: 
 1928: ``sheepdog:<host>:<port>:<vdiname>:<snapid>''
 1929: 
 1930: ``sheepdog:<host>:<port>:<vdiname>:<tag>''
 1931: @end table
 1932: 
 1933: Example
 1934: @example
 1935: qemu-system-i386 --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine
 1936: @end example
 1937: 
 1938: See also @url{http://http://www.osrg.net/sheepdog/}.
 1939: 
 1940: @end table
 1941: ETEXI
 1942: 
 1943: DEFHEADING(Bluetooth(R) options:)
 1944: 
 1945: DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
 1946:     "-bt hci,null    dumb bluetooth HCI - doesn't respond to commands\n" \
 1947:     "-bt hci,host[:id]\n" \
 1948:     "                use host's HCI with the given name\n" \
 1949:     "-bt hci[,vlan=n]\n" \
 1950:     "                emulate a standard HCI in virtual scatternet 'n'\n" \
 1951:     "-bt vhci[,vlan=n]\n" \
 1952:     "                add host computer to virtual scatternet 'n' using VHCI\n" \
 1953:     "-bt device:dev[,vlan=n]\n" \
 1954:     "                emulate a bluetooth device 'dev' in scatternet 'n'\n",
 1955:     QEMU_ARCH_ALL)
 1956: STEXI
 1957: @table @option
 1958: 
 1959: @item -bt hci[...]
 1960: @findex -bt
 1961: Defines the function of the corresponding Bluetooth HCI.  -bt options
 1962: are matched with the HCIs present in the chosen machine type.  For
 1963: example when emulating a machine with only one HCI built into it, only
 1964: the first @code{-bt hci[...]} option is valid and defines the HCI's
 1965: logic.  The Transport Layer is decided by the machine type.  Currently
 1966: the machines @code{n800} and @code{n810} have one HCI and all other
 1967: machines have none.
 1968: 
 1969: @anchor{bt-hcis}
 1970: The following three types are recognized:
 1971: 
 1972: @table @option
 1973: @item -bt hci,null
 1974: (default) The corresponding Bluetooth HCI assumes no internal logic
 1975: and will not respond to any HCI commands or emit events.
 1976: 
 1977: @item -bt hci,host[:@var{id}]
 1978: (@code{bluez} only) The corresponding HCI passes commands / events
 1979: to / from the physical HCI identified by the name @var{id} (default:
 1980: @code{hci0}) on the computer running QEMU.  Only available on @code{bluez}
 1981: capable systems like Linux.
 1982: 
 1983: @item -bt hci[,vlan=@var{n}]
 1984: Add a virtual, standard HCI that will participate in the Bluetooth
 1985: scatternet @var{n} (default @code{0}).  Similarly to @option{-net}
 1986: VLANs, devices inside a bluetooth network @var{n} can only communicate
 1987: with other devices in the same network (scatternet).
 1988: @end table
 1989: 
 1990: @item -bt vhci[,vlan=@var{n}]
 1991: (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
 1992: to the host bluetooth stack instead of to the emulated target.  This
 1993: allows the host and target machines to participate in a common scatternet
 1994: and communicate.  Requires the Linux @code{vhci} driver installed.  Can
 1995: be used as following:
 1996: 
 1997: @example
 1998: qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
 1999: @end example
 2000: 
 2001: @item -bt device:@var{dev}[,vlan=@var{n}]
 2002: Emulate a bluetooth device @var{dev} and place it in network @var{n}
 2003: (default @code{0}).  QEMU can only emulate one type of bluetooth devices
 2004: currently:
 2005: 
 2006: @table @option
 2007: @item keyboard
 2008: Virtual wireless keyboard implementing the HIDP bluetooth profile.
 2009: @end table
 2010: @end table
 2011: ETEXI
 2012: 
 2013: DEFHEADING()
 2014: 
 2015: DEFHEADING(Linux/Multiboot boot specific:)
 2016: STEXI
 2017: 
 2018: When using these options, you can use a given Linux or Multiboot
 2019: kernel without installing it in the disk image. It can be useful
 2020: for easier testing of various kernels.
 2021: 
 2022: @table @option
 2023: ETEXI
 2024: 
 2025: DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
 2026:     "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
 2027: STEXI
 2028: @item -kernel @var{bzImage}
 2029: @findex -kernel
 2030: Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
 2031: or in multiboot format.
 2032: ETEXI
 2033: 
 2034: DEF("append", HAS_ARG, QEMU_OPTION_append, \
 2035:     "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
 2036: STEXI
 2037: @item -append @var{cmdline}
 2038: @findex -append
 2039: Use @var{cmdline} as kernel command line
 2040: ETEXI
 2041: 
 2042: DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
 2043:            "-initrd file    use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
 2044: STEXI
 2045: @item -initrd @var{file}
 2046: @findex -initrd
 2047: Use @var{file} as initial ram disk.
 2048: 
 2049: @item -initrd "@var{file1} arg=foo,@var{file2}"
 2050: 
 2051: This syntax is only available with multiboot.
 2052: 
 2053: Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
 2054: first module.
 2055: ETEXI
 2056: 
 2057: DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
 2058:     "-dtb    file    use 'file' as device tree image\n", QEMU_ARCH_ALL)
 2059: STEXI
 2060: @item -dtb @var{file}
 2061: @findex -dtb
 2062: Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
 2063: on boot.
 2064: ETEXI
 2065: 
 2066: STEXI
 2067: @end table
 2068: ETEXI
 2069: 
 2070: DEFHEADING()
 2071: 
 2072: DEFHEADING(Debug/Expert options:)
 2073: 
 2074: STEXI
 2075: @table @option
 2076: ETEXI
 2077: 
 2078: DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
 2079:     "-serial dev     redirect the serial port to char device 'dev'\n",
 2080:     QEMU_ARCH_ALL)
 2081: STEXI
 2082: @item -serial @var{dev}
 2083: @findex -serial
 2084: Redirect the virtual serial port to host character device
 2085: @var{dev}. The default device is @code{vc} in graphical mode and
 2086: @code{stdio} in non graphical mode.
 2087: 
 2088: This option can be used several times to simulate up to 4 serial
 2089: ports.
 2090: 
 2091: Use @code{-serial none} to disable all serial ports.
 2092: 
 2093: Available character devices are:
 2094: @table @option
 2095: @item vc[:@var{W}x@var{H}]
 2096: Virtual console. Optionally, a width and height can be given in pixel with
 2097: @example
 2098: vc:800x600
 2099: @end example
 2100: It is also possible to specify width or height in characters:
 2101: @example
 2102: vc:80Cx24C
 2103: @end example
 2104: @item pty
 2105: [Linux only] Pseudo TTY (a new PTY is automatically allocated)
 2106: @item none
 2107: No device is allocated.
 2108: @item null
 2109: void device
 2110: @item /dev/XXX
 2111: [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
 2112: parameters are set according to the emulated ones.
 2113: @item /dev/parport@var{N}
 2114: [Linux only, parallel port only] Use host parallel port
 2115: @var{N}. Currently SPP and EPP parallel port features can be used.
 2116: @item file:@var{filename}
 2117: Write output to @var{filename}. No character can be read.
 2118: @item stdio
 2119: [Unix only] standard input/output
 2120: @item pipe:@var{filename}
 2121: name pipe @var{filename}
 2122: @item COM@var{n}
 2123: [Windows only] Use host serial port @var{n}
 2124: @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
 2125: This implements UDP Net Console.
 2126: When @var{remote_host} or @var{src_ip} are not specified
 2127: they default to @code{0.0.0.0}.
 2128: When not using a specified @var{src_port} a random port is automatically chosen.
 2129: 
 2130: If you just want a simple readonly console you can use @code{netcat} or
 2131: @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
 2132: @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
 2133: will appear in the netconsole session.
 2134: 
 2135: If you plan to send characters back via netconsole or you want to stop
 2136: and start QEMU a lot of times, you should have QEMU use the same
 2137: source port each time by using something like @code{-serial
 2138: udp::4555@@:4556} to QEMU. Another approach is to use a patched
 2139: version of netcat which can listen to a TCP port and send and receive
 2140: characters via udp.  If you have a patched version of netcat which
 2141: activates telnet remote echo and single char transfer, then you can
 2142: use the following options to step up a netcat redirector to allow
 2143: telnet on port 5555 to access the QEMU port.
 2144: @table @code
 2145: @item QEMU Options:
 2146: -serial udp::4555@@:4556
 2147: @item netcat options:
 2148: -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
 2149: @item telnet options:
 2150: localhost 5555
 2151: @end table
 2152: 
 2153: @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
 2154: The TCP Net Console has two modes of operation.  It can send the serial
 2155: I/O to a location or wait for a connection from a location.  By default
 2156: the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
 2157: the @var{server} option QEMU will wait for a client socket application
 2158: to connect to the port before continuing, unless the @code{nowait}
 2159: option was specified.  The @code{nodelay} option disables the Nagle buffering
 2160: algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
 2161: one TCP connection at a time is accepted. You can use @code{telnet} to
 2162: connect to the corresponding character device.
 2163: @table @code
 2164: @item Example to send tcp console to 192.168.0.2 port 4444
 2165: -serial tcp:192.168.0.2:4444
 2166: @item Example to listen and wait on port 4444 for connection
 2167: -serial tcp::4444,server
 2168: @item Example to not wait and listen on ip 192.168.0.100 port 4444
 2169: -serial tcp:192.168.0.100:4444,server,nowait
 2170: @end table
 2171: 
 2172: @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
 2173: The telnet protocol is used instead of raw tcp sockets.  The options
 2174: work the same as if you had specified @code{-serial tcp}.  The
 2175: difference is that the port acts like a telnet server or client using
 2176: telnet option negotiation.  This will also allow you to send the
 2177: MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
 2178: sequence.  Typically in unix telnet you do it with Control-] and then
 2179: type "send break" followed by pressing the enter key.
 2180: 
 2181: @item unix:@var{path}[,server][,nowait]
 2182: A unix domain socket is used instead of a tcp socket.  The option works the
 2183: same as if you had specified @code{-serial tcp} except the unix domain socket
 2184: @var{path} is used for connections.
 2185: 
 2186: @item mon:@var{dev_string}
 2187: This is a special option to allow the monitor to be multiplexed onto
 2188: another serial port.  The monitor is accessed with key sequence of
 2189: @key{Control-a} and then pressing @key{c}. See monitor access
 2190: @ref{pcsys_keys} in the -nographic section for more keys.
 2191: @var{dev_string} should be any one of the serial devices specified
 2192: above.  An example to multiplex the monitor onto a telnet server
 2193: listening on port 4444 would be:
 2194: @table @code
 2195: @item -serial mon:telnet::4444,server,nowait
 2196: @end table
 2197: 
 2198: @item braille
 2199: Braille device.  This will use BrlAPI to display the braille output on a real
 2200: or fake device.
 2201: 
 2202: @item msmouse
 2203: Three button serial mouse. Configure the guest to use Microsoft protocol.
 2204: @end table
 2205: ETEXI
 2206: 
 2207: DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
 2208:     "-parallel dev   redirect the parallel port to char device 'dev'\n",
 2209:     QEMU_ARCH_ALL)
 2210: STEXI
 2211: @item -parallel @var{dev}
 2212: @findex -parallel
 2213: Redirect the virtual parallel port to host device @var{dev} (same
 2214: devices as the serial port). On Linux hosts, @file{/dev/parportN} can
 2215: be used to use hardware devices connected on the corresponding host
 2216: parallel port.
 2217: 
 2218: This option can be used several times to simulate up to 3 parallel
 2219: ports.
 2220: 
 2221: Use @code{-parallel none} to disable all parallel ports.
 2222: ETEXI
 2223: 
 2224: DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
 2225:     "-monitor dev    redirect the monitor to char device 'dev'\n",
 2226:     QEMU_ARCH_ALL)
 2227: STEXI
 2228: @item -monitor @var{dev}
 2229: @findex -monitor
 2230: Redirect the monitor to host device @var{dev} (same devices as the
 2231: serial port).
 2232: The default device is @code{vc} in graphical mode and @code{stdio} in
 2233: non graphical mode.
 2234: ETEXI
 2235: DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
 2236:     "-qmp dev        like -monitor but opens in 'control' mode\n",
 2237:     QEMU_ARCH_ALL)
 2238: STEXI
 2239: @item -qmp @var{dev}
 2240: @findex -qmp
 2241: Like -monitor but opens in 'control' mode.
 2242: ETEXI
 2243: 
 2244: DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
 2245:     "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
 2246: STEXI
 2247: @item -mon chardev=[name][,mode=readline|control][,default]
 2248: @findex -mon
 2249: Setup monitor on chardev @var{name}.
 2250: ETEXI
 2251: 
 2252: DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
 2253:     "-debugcon dev   redirect the debug console to char device 'dev'\n",
 2254:     QEMU_ARCH_ALL)
 2255: STEXI
 2256: @item -debugcon @var{dev}
 2257: @findex -debugcon
 2258: Redirect the debug console to host device @var{dev} (same devices as the
 2259: serial port).  The debug console is an I/O port which is typically port
 2260: 0xe9; writing to that I/O port sends output to this device.
 2261: The default device is @code{vc} in graphical mode and @code{stdio} in
 2262: non graphical mode.
 2263: ETEXI
 2264: 
 2265: DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
 2266:     "-pidfile file   write PID to 'file'\n", QEMU_ARCH_ALL)
 2267: STEXI
 2268: @item -pidfile @var{file}
 2269: @findex -pidfile
 2270: Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
 2271: from a script.
 2272: ETEXI
 2273: 
 2274: DEF("singlestep", 0, QEMU_OPTION_singlestep, \
 2275:     "-singlestep     always run in singlestep mode\n", QEMU_ARCH_ALL)
 2276: STEXI
 2277: @item -singlestep
 2278: @findex -singlestep
 2279: Run the emulation in single step mode.
 2280: ETEXI
 2281: 
 2282: DEF("S", 0, QEMU_OPTION_S, \
 2283:     "-S              freeze CPU at startup (use 'c' to start execution)\n",
 2284:     QEMU_ARCH_ALL)
 2285: STEXI
 2286: @item -S
 2287: @findex -S
 2288: Do not start CPU at startup (you must type 'c' in the monitor).
 2289: ETEXI
 2290: 
 2291: DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
 2292:     "-gdb dev        wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
 2293: STEXI
 2294: @item -gdb @var{dev}
 2295: @findex -gdb
 2296: Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
 2297: connections will likely be TCP-based, but also UDP, pseudo TTY, or even
 2298: stdio are reasonable use case. The latter is allowing to start QEMU from
 2299: within gdb and establish the connection via a pipe:
 2300: @example
 2301: (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
 2302: @end example
 2303: ETEXI
 2304: 
 2305: DEF("s", 0, QEMU_OPTION_s, \
 2306:     "-s              shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
 2307:     QEMU_ARCH_ALL)
 2308: STEXI
 2309: @item -s
 2310: @findex -s
 2311: Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
 2312: (@pxref{gdb_usage}).
 2313: ETEXI
 2314: 
 2315: DEF("d", HAS_ARG, QEMU_OPTION_d, \
 2316:     "-d item1,...    output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
 2317:     QEMU_ARCH_ALL)
 2318: STEXI
 2319: @item -d
 2320: @findex -d
 2321: Output log in /tmp/qemu.log
 2322: ETEXI
 2323: 
 2324: DEF("D", HAS_ARG, QEMU_OPTION_D, \
 2325:     "-D logfile      output log to logfile (instead of the default /tmp/qemu.log)\n",
 2326:     QEMU_ARCH_ALL)
 2327: STEXI
 2328: @item -D @var{logfile}
 2329: @findex -D
 2330: Output log in @var{logfile} instead of /tmp/qemu.log
 2331: ETEXI
 2332: 
 2333: DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
 2334:     "-hdachs c,h,s[,t]\n" \
 2335:     "                force hard disk 0 physical geometry and the optional BIOS\n" \
 2336:     "                translation (t=none or lba) (usually QEMU can guess them)\n",
 2337:     QEMU_ARCH_ALL)
 2338: STEXI
 2339: @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
 2340: @findex -hdachs
 2341: Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
 2342: @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
 2343: translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
 2344: all those parameters. This option is useful for old MS-DOS disk
 2345: images.
 2346: ETEXI
 2347: 
 2348: DEF("L", HAS_ARG, QEMU_OPTION_L, \
 2349:     "-L path         set the directory for the BIOS, VGA BIOS and keymaps\n",
 2350:     QEMU_ARCH_ALL)
 2351: STEXI
 2352: @item -L  @var{path}
 2353: @findex -L
 2354: Set the directory for the BIOS, VGA BIOS and keymaps.
 2355: ETEXI
 2356: 
 2357: DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
 2358:     "-bios file      set the filename for the BIOS\n", QEMU_ARCH_ALL)
 2359: STEXI
 2360: @item -bios @var{file}
 2361: @findex -bios
 2362: Set the filename for the BIOS.
 2363: ETEXI
 2364: 
 2365: DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
 2366:     "-enable-kvm     enable KVM full virtualization support\n", QEMU_ARCH_ALL)
 2367: STEXI
 2368: @item -enable-kvm
 2369: @findex -enable-kvm
 2370: Enable KVM full virtualization support. This option is only available
 2371: if KVM support is enabled when compiling.
 2372: ETEXI
 2373: 
 2374: DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
 2375:     "-xen-domid id   specify xen guest domain id\n", QEMU_ARCH_ALL)
 2376: DEF("xen-create", 0, QEMU_OPTION_xen_create,
 2377:     "-xen-create     create domain using xen hypercalls, bypassing xend\n"
 2378:     "                warning: should not be used when xend is in use\n",
 2379:     QEMU_ARCH_ALL)
 2380: DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
 2381:     "-xen-attach     attach to existing xen domain\n"
 2382:     "                xend will use this when starting QEMU\n",
 2383:     QEMU_ARCH_ALL)
 2384: STEXI
 2385: @item -xen-domid @var{id}
 2386: @findex -xen-domid
 2387: Specify xen guest domain @var{id} (XEN only).
 2388: @item -xen-create
 2389: @findex -xen-create
 2390: Create domain using xen hypercalls, bypassing xend.
 2391: Warning: should not be used when xend is in use (XEN only).
 2392: @item -xen-attach
 2393: @findex -xen-attach
 2394: Attach to existing xen domain.
 2395: xend will use this when starting QEMU (XEN only).
 2396: ETEXI
 2397: 
 2398: DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
 2399:     "-no-reboot      exit instead of rebooting\n", QEMU_ARCH_ALL)
 2400: STEXI
 2401: @item -no-reboot
 2402: @findex -no-reboot
 2403: Exit instead of rebooting.
 2404: ETEXI
 2405: 
 2406: DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
 2407:     "-no-shutdown    stop before shutdown\n", QEMU_ARCH_ALL)
 2408: STEXI
 2409: @item -no-shutdown
 2410: @findex -no-shutdown
 2411: Don't exit QEMU on guest shutdown, but instead only stop the emulation.
 2412: This allows for instance switching to monitor to commit changes to the
 2413: disk image.
 2414: ETEXI
 2415: 
 2416: DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
 2417:     "-loadvm [tag|id]\n" \
 2418:     "                start right away with a saved state (loadvm in monitor)\n",
 2419:     QEMU_ARCH_ALL)
 2420: STEXI
 2421: @item -loadvm @var{file}
 2422: @findex -loadvm
 2423: Start right away with a saved state (@code{loadvm} in monitor)
 2424: ETEXI
 2425: 
 2426: #ifndef _WIN32
 2427: DEF("daemonize", 0, QEMU_OPTION_daemonize, \
 2428:     "-daemonize      daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
 2429: #endif
 2430: STEXI
 2431: @item -daemonize
 2432: @findex -daemonize
 2433: Daemonize the QEMU process after initialization.  QEMU will not detach from
 2434: standard IO until it is ready to receive connections on any of its devices.
 2435: This option is a useful way for external programs to launch QEMU without having
 2436: to cope with initialization race conditions.
 2437: ETEXI
 2438: 
 2439: DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
 2440:     "-option-rom rom load a file, rom, into the option ROM space\n",
 2441:     QEMU_ARCH_ALL)
 2442: STEXI
 2443: @item -option-rom @var{file}
 2444: @findex -option-rom
 2445: Load the contents of @var{file} as an option ROM.
 2446: This option is useful to load things like EtherBoot.
 2447: ETEXI
 2448: 
 2449: DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
 2450:     "-clock          force the use of the given methods for timer alarm.\n" \
 2451:     "                To see what timers are available use -clock ?\n",
 2452:     QEMU_ARCH_ALL)
 2453: STEXI
 2454: @item -clock @var{method}
 2455: @findex -clock
 2456: Force the use of the given methods for timer alarm. To see what timers
 2457: are available use -clock ?.
 2458: ETEXI
 2459: 
 2460: HXCOMM Options deprecated by -rtc
 2461: DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
 2462: DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
 2463: 
 2464: DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
 2465:     "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
 2466:     "                set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
 2467:     QEMU_ARCH_ALL)
 2468: 
 2469: STEXI
 2470: 
 2471: @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
 2472: @findex -rtc
 2473: Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
 2474: UTC or local time, respectively. @code{localtime} is required for correct date in
 2475: MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
 2476: format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
 2477: 
 2478: By default the RTC is driven by the host system time. This allows to use the
 2479: RTC as accurate reference clock inside the guest, specifically if the host
 2480: time is smoothly following an accurate external reference clock, e.g. via NTP.
 2481: If you want to isolate the guest time from the host, you can set @option{clock}
 2482: to @code{rt} instead.  To even prevent it from progressing during suspension,
 2483: you can set it to @code{vm}.
 2484: 
 2485: Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
 2486: specifically with Windows' ACPI HAL. This option will try to figure out how
 2487: many timer interrupts were not processed by the Windows guest and will
 2488: re-inject them.
 2489: ETEXI
 2490: 
 2491: DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
 2492:     "-icount [N|auto]\n" \
 2493:     "                enable virtual instruction counter with 2^N clock ticks per\n" \
 2494:     "                instruction\n", QEMU_ARCH_ALL)
 2495: STEXI
 2496: @item -icount [@var{N}|auto]
 2497: @findex -icount
 2498: Enable virtual instruction counter.  The virtual cpu will execute one
 2499: instruction every 2^@var{N} ns of virtual time.  If @code{auto} is specified
 2500: then the virtual cpu speed will be automatically adjusted to keep virtual
 2501: time within a few seconds of real time.
 2502: 
 2503: Note that while this option can give deterministic behavior, it does not
 2504: provide cycle accurate emulation.  Modern CPUs contain superscalar out of
 2505: order cores with complex cache hierarchies.  The number of instructions
 2506: executed often has little or no correlation with actual performance.
 2507: ETEXI
 2508: 
 2509: DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
 2510:     "-watchdog i6300esb|ib700\n" \
 2511:     "                enable virtual hardware watchdog [default=none]\n",
 2512:     QEMU_ARCH_ALL)
 2513: STEXI
 2514: @item -watchdog @var{model}
 2515: @findex -watchdog
 2516: Create a virtual hardware watchdog device.  Once enabled (by a guest
 2517: action), the watchdog must be periodically polled by an agent inside
 2518: the guest or else the guest will be restarted.
 2519: 
 2520: The @var{model} is the model of hardware watchdog to emulate.  Choices
 2521: for model are: @code{ib700} (iBASE 700) which is a very simple ISA
 2522: watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
 2523: controller hub) which is a much more featureful PCI-based dual-timer
 2524: watchdog.  Choose a model for which your guest has drivers.
 2525: 
 2526: Use @code{-watchdog ?} to list available hardware models.  Only one
 2527: watchdog can be enabled for a guest.
 2528: ETEXI
 2529: 
 2530: DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
 2531:     "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
 2532:     "                action when watchdog fires [default=reset]\n",
 2533:     QEMU_ARCH_ALL)
 2534: STEXI
 2535: @item -watchdog-action @var{action}
 2536: 
 2537: The @var{action} controls what QEMU will do when the watchdog timer
 2538: expires.
 2539: The default is
 2540: @code{reset} (forcefully reset the guest).
 2541: Other possible actions are:
 2542: @code{shutdown} (attempt to gracefully shutdown the guest),
 2543: @code{poweroff} (forcefully poweroff the guest),
 2544: @code{pause} (pause the guest),
 2545: @code{debug} (print a debug message and continue), or
 2546: @code{none} (do nothing).
 2547: 
 2548: Note that the @code{shutdown} action requires that the guest responds
 2549: to ACPI signals, which it may not be able to do in the sort of
 2550: situations where the watchdog would have expired, and thus
 2551: @code{-watchdog-action shutdown} is not recommended for production use.
 2552: 
 2553: Examples:
 2554: 
 2555: @table @code
 2556: @item -watchdog i6300esb -watchdog-action pause
 2557: @item -watchdog ib700
 2558: @end table
 2559: ETEXI
 2560: 
 2561: DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
 2562:     "-echr chr       set terminal escape character instead of ctrl-a\n",
 2563:     QEMU_ARCH_ALL)
 2564: STEXI
 2565: 
 2566: @item -echr @var{numeric_ascii_value}
 2567: @findex -echr
 2568: Change the escape character used for switching to the monitor when using
 2569: monitor and serial sharing.  The default is @code{0x01} when using the
 2570: @code{-nographic} option.  @code{0x01} is equal to pressing
 2571: @code{Control-a}.  You can select a different character from the ascii
 2572: control keys where 1 through 26 map to Control-a through Control-z.  For
 2573: instance you could use the either of the following to change the escape
 2574: character to Control-t.
 2575: @table @code
 2576: @item -echr 0x14
 2577: @item -echr 20
 2578: @end table
 2579: ETEXI
 2580: 
 2581: DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
 2582:     "-virtioconsole c\n" \
 2583:     "                set virtio console\n", QEMU_ARCH_ALL)
 2584: STEXI
 2585: @item -virtioconsole @var{c}
 2586: @findex -virtioconsole
 2587: Set virtio console.
 2588: 
 2589: This option is maintained for backward compatibility.
 2590: 
 2591: Please use @code{-device virtconsole} for the new way of invocation.
 2592: ETEXI
 2593: 
 2594: DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
 2595:     "-show-cursor    show cursor\n", QEMU_ARCH_ALL)
 2596: STEXI
 2597: @item -show-cursor
 2598: @findex -show-cursor
 2599: Show cursor.
 2600: ETEXI
 2601: 
 2602: DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
 2603:     "-tb-size n      set TB size\n", QEMU_ARCH_ALL)
 2604: STEXI
 2605: @item -tb-size @var{n}
 2606: @findex -tb-size
 2607: Set TB size.
 2608: ETEXI
 2609: 
 2610: DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
 2611:     "-incoming p     prepare for incoming migration, listen on port p\n",
 2612:     QEMU_ARCH_ALL)
 2613: STEXI
 2614: @item -incoming @var{port}
 2615: @findex -incoming
 2616: Prepare for incoming migration, listen on @var{port}.
 2617: ETEXI
 2618: 
 2619: DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
 2620:     "-nodefaults     don't create default devices\n", QEMU_ARCH_ALL)
 2621: STEXI
 2622: @item -nodefaults
 2623: @findex -nodefaults
 2624: Don't create default devices.
 2625: ETEXI
 2626: 
 2627: #ifndef _WIN32
 2628: DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
 2629:     "-chroot dir     chroot to dir just before starting the VM\n",
 2630:     QEMU_ARCH_ALL)
 2631: #endif
 2632: STEXI
 2633: @item -chroot @var{dir}
 2634: @findex -chroot
 2635: Immediately before starting guest execution, chroot to the specified
 2636: directory.  Especially useful in combination with -runas.
 2637: ETEXI
 2638: 
 2639: #ifndef _WIN32
 2640: DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
 2641:     "-runas user     change to user id user just before starting the VM\n",
 2642:     QEMU_ARCH_ALL)
 2643: #endif
 2644: STEXI
 2645: @item -runas @var{user}
 2646: @findex -runas
 2647: Immediately before starting guest execution, drop root privileges, switching
 2648: to the specified user.
 2649: ETEXI
 2650: 
 2651: DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
 2652:     "-prom-env variable=value\n"
 2653:     "                set OpenBIOS nvram variables\n",
 2654:     QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
 2655: STEXI
 2656: @item -prom-env @var{variable}=@var{value}
 2657: @findex -prom-env
 2658: Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
 2659: ETEXI
 2660: DEF("semihosting", 0, QEMU_OPTION_semihosting,
 2661:     "-semihosting    semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
 2662: STEXI
 2663: @item -semihosting
 2664: @findex -semihosting
 2665: Semihosting mode (ARM, M68K, Xtensa only).
 2666: ETEXI
 2667: DEF("old-param", 0, QEMU_OPTION_old_param,
 2668:     "-old-param      old param mode\n", QEMU_ARCH_ARM)
 2669: STEXI
 2670: @item -old-param
 2671: @findex -old-param (ARM)
 2672: Old param mode (ARM only).
 2673: ETEXI
 2674: 
 2675: DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
 2676:     "-readconfig <file>\n", QEMU_ARCH_ALL)
 2677: STEXI
 2678: @item -readconfig @var{file}
 2679: @findex -readconfig
 2680: Read device configuration from @var{file}.
 2681: ETEXI
 2682: DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
 2683:     "-writeconfig <file>\n"
 2684:     "                read/write config file\n", QEMU_ARCH_ALL)
 2685: STEXI
 2686: @item -writeconfig @var{file}
 2687: @findex -writeconfig
 2688: Write device configuration to @var{file}.
 2689: ETEXI
 2690: DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
 2691:     "-nodefconfig\n"
 2692:     "                do not load default config files at startup\n",
 2693:     QEMU_ARCH_ALL)
 2694: STEXI
 2695: @item -nodefconfig
 2696: @findex -nodefconfig
 2697: Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
 2698: The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
 2699: ETEXI
 2700: DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
 2701:     "-no-user-config\n"
 2702:     "                do not load user-provided config files at startup\n",
 2703:     QEMU_ARCH_ALL)
 2704: STEXI
 2705: @item -no-user-config
 2706: @findex -no-user-config
 2707: The @code{-no-user-config} option makes QEMU not load any of the user-provided
 2708: config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
 2709: files from @var{datadir}.
 2710: ETEXI
 2711: DEF("trace", HAS_ARG, QEMU_OPTION_trace,
 2712:     "-trace [events=<file>][,file=<file>]\n"
 2713:     "                specify tracing options\n",
 2714:     QEMU_ARCH_ALL)
 2715: STEXI
 2716: HXCOMM This line is not accurate, as some sub-options are backend-specific but
 2717: HXCOMM HX does not support conditional compilation of text.
 2718: @item -trace [events=@var{file}][,file=@var{file}]
 2719: @findex -trace
 2720: 
 2721: Specify tracing options.
 2722: 
 2723: @table @option
 2724: @item events=@var{file}
 2725: Immediately enable events listed in @var{file}.
 2726: The file must contain one event name (as listed in the @var{trace-events} file)
 2727: per line.
 2728: This option is only available if QEMU has been compiled with
 2729: either @var{simple} or @var{stderr} tracing backend.
 2730: @item file=@var{file}
 2731: Log output traces to @var{file}.
 2732: 
 2733: This option is only available if QEMU has been compiled with
 2734: the @var{simple} tracing backend.
 2735: @end table
 2736: ETEXI
 2737: 
 2738: DEF("qtest", HAS_ARG, QEMU_OPTION_qtest,
 2739:     "-qtest CHR      specify tracing options\n",
 2740:     QEMU_ARCH_ALL)
 2741: 
 2742: DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log,
 2743:     "-qtest-log LOG  specify tracing options\n",
 2744:     QEMU_ARCH_ALL)
 2745: 
 2746: HXCOMM This is the last statement. Insert new options before this line!
 2747: STEXI
 2748: @end table
 2749: ETEXI

unix.superglobalmegacorp.com