diff options
Diffstat (limited to 'qemu-options.hx')
| -rw-r--r-- | qemu-options.hx | 138 |
1 files changed, 67 insertions, 71 deletions
diff --git a/qemu-options.hx b/qemu-options.hx index 6c34c7050f..252db9357c 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1894,16 +1894,17 @@ DEF("spice", HAS_ARG, QEMU_OPTION_spice, "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" " [,x509-key-file=<file>][,x509-key-password=<file>]\n" " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" - " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" + " [,x509-dh-key-file=<file>][,addr=addr]\n" + " [,ipv4=on|off][,ipv6=on|off][,unix=on|off]\n" " [,tls-ciphers=<list>]\n" " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" - " [,sasl][,password=<secret>][,disable-ticketing]\n" + " [,sasl=on|off][,password=<secret>][,disable-ticketing=on|off]\n" " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" " [,jpeg-wan-compression=[auto|never|always]]\n" " [,zlib-glz-wan-compression=[auto|never|always]]\n" - " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" - " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" + " [,streaming-video=[off|all|filter]][,disable-copy-paste=on|off]\n" + " [,disable-agent-file-xfer=on|off][,agent-mouse=[on|off]]\n" " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" " [,gl=[on|off]][,rendernode=<file>]\n" " enable spice\n" @@ -1920,13 +1921,13 @@ SRST Set the IP address spice is listening on. Default is any address. - ``ipv4``; \ ``ipv6``; \ ``unix`` + ``ipv4=on|off``; \ ``ipv6=on|off``; \ ``unix=on|off`` Force using the specified IP version. ``password=<secret>`` Set the password you need to authenticate. - ``sasl`` + ``sasl=on|off`` Require that the client use SASL to authenticate with the spice. The exact choice of authentication method used is controlled from the system / user's SASL configuration file for the 'qemu' @@ -1940,13 +1941,13 @@ SRST data encryption preventing compromise of authentication credentials. - ``disable-ticketing`` + ``disable-ticketing=on|off`` Allow client connects without authentication. - ``disable-copy-paste`` + ``disable-copy-paste=on|off`` Disable copy paste between the client and the guest. - ``disable-agent-file-xfer`` + ``disable-agent-file-xfer=on|off`` Disable spice-vdagent based file-xfer between the client and the guest. @@ -2122,13 +2123,13 @@ SRST Following the display value there may be one or more option flags separated by commas. Valid options are - ``reverse`` + ``reverse=on|off`` Connect to a listening VNC client via a "reverse" connection. The client is specified by the display. For reverse network connections (host:d,``reverse``), the d argument is a TCP port number, not a display number. - ``websocket`` + ``websocket=on|off`` Opens an additional TCP listening port dedicated to VNC Websocket connections. If a bare websocket option is given, the Websocket port is 5700+display. An alternative port can be @@ -2142,7 +2143,7 @@ SRST runs in unencrypted mode. If TLS credentials are provided, the websocket connection requires encrypted client connections. - ``password`` + ``password=on|off`` Require that password based authentication is used for client connections. @@ -2179,7 +2180,7 @@ SRST on the fly while the VNC server is active. If missing, it will default to denying access. - ``sasl`` + ``sasl=on|off`` Require that the client use SASL to authenticate with the VNC server. The exact choice of authentication method used is controlled from the system / user's SASL configuration file for @@ -2202,7 +2203,7 @@ SRST fly while the VNC server is active. If missing, it will default to denying access. - ``acl`` + ``acl=on|off`` Legacy method for enabling authorization of clients against the x509 distinguished name and SASL username. It results in the creation of two ``authz-list`` objects with IDs of @@ -2212,13 +2213,13 @@ SRST This option is deprecated and should no longer be used. The new ``sasl-authz`` and ``tls-authz`` options are a replacement. - ``lossy`` + ``lossy=on|off`` Enable lossy compression methods (gradient, JPEG, ...). If this option is set, VNC client may receive lossy framebuffer updates depending on its encoding settings. Enabling this option can save a lot of bandwidth at the expense of quality. - ``non-adaptive`` + ``non-adaptive=on|off`` Disable adaptive encodings. Adaptive encodings are enabled by default. An adaptive encoding will try to detect frequently updated screen regions, and send updates in these regions using @@ -2253,7 +2254,7 @@ SRST must be omitted, otherwise is must be present and specify a valid audiodev. - ``power-control`` + ``power-control=on|off`` Permit the remote client to issue shutdown, reboot or reset power control requests. ERST @@ -2405,8 +2406,8 @@ DEFHEADING(Network options:) DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, #ifdef CONFIG_SLIRP - "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n" - " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" + "-netdev user,id=str[,ipv4=on|off][,net=addr[/mask]][,host=addr]\n" + " [,ipv6=on|off][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n" " [,tftp=dir][,tftp-server-name=name][,bootfile=f][,hostfwd=rule][,guestfwd=rule]" @@ -2453,8 +2454,8 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, #endif #ifdef __linux__ "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" - " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" - " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" + " [,rxsession=rxsession],txsession=txsession[,ipv6=on|off][,udp=on|off]\n" + " [,cookie64=on|off][,counter][,pincounter][,txcookie=txcookie]\n" " [,rxcookie=rxcookie][,offset=offset]\n" " configure a network backend with ID 'str' connected to\n" " an Ethernet over L2TPv3 pseudowire.\n" @@ -2883,7 +2884,7 @@ SRST -device e1000,netdev=n1,mac=52:54:00:12:34:56 \\ -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 -``-netdev l2tpv3,id=id,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]`` +``-netdev l2tpv3,id=id,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6=on|off][,udp=on|off][,cookie64][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]`` Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3931) is a popular protocol to transport Ethernet (and other Layer 2) data frames between two systems. It is present in routers, firewalls and @@ -3032,13 +3033,13 @@ DEFHEADING(Character device options:) DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, "-chardev help\n" "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" - "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" - " [,server][,nowait][,telnet][,websocket][,reconnect=seconds][,mux=on|off]\n" + "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4=on|off][,ipv6=on|off][,delay=on|off][,reconnect=seconds]\n" + " [,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds][,mux=on|off]\n" " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n" - "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,websocket][,reconnect=seconds]\n" + "-chardev socket,id=id,path=path[,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds]\n" " [,mux=on|off][,logfile=PATH][,logappend=on|off][,abstract=on|off][,tight=on|off] (unix)\n" "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" - " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" + " [,localport=localport][,ipv4=on|off][,ipv6=on|off][,mux=on|off]\n" " [,logfile=PATH][,logappend=on|off]\n" "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" @@ -3148,21 +3149,21 @@ The available backends are: A void device. This device will not emit any data, and will drop any data it receives. The null backend does not take any options. -``-chardev socket,id=id[,TCP options or unix options][,server][,nowait][,telnet][,websocket][,reconnect=seconds][,tls-creds=id][,tls-authz=id]`` +``-chardev socket,id=id[,TCP options or unix options][,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect=seconds][,tls-creds=id][,tls-authz=id]`` Create a two-way stream socket, which can be either a TCP or a unix socket. A unix socket will be created if ``path`` is specified. Behaviour is undefined if TCP options are specified for a unix socket. - ``server`` specifies that the socket shall be a listening socket. + ``server=on|off`` specifies that the socket shall be a listening socket. - ``nowait`` specifies that QEMU should not block waiting for a client + ``wait=on|off`` specifies that QEMU should not block waiting for a client to connect to a listening socket. - ``telnet`` specifies that traffic on the socket should interpret + ``telnet=on|off`` specifies that traffic on the socket should interpret telnet escape sequences. - ``websocket`` specifies that the socket uses WebSocket protocol for + ``websocket=on|off`` specifies that the socket uses WebSocket protocol for communication. ``reconnect`` sets the timeout for reconnecting on non-server @@ -3183,7 +3184,7 @@ The available backends are: TCP and unix socket options are given below: - ``TCP options: port=port[,host=host][,to=to][,ipv4][,ipv6][,nodelay]`` + ``TCP options: port=port[,host=host][,to=to][,ipv4=on|off][,ipv6=on|off][,delay=on|off]`` ``host`` for a listening socket specifies the local address to be bound. For a connecting socket species the remote host to connect to. ``host`` is optional for listening sockets. If not @@ -3199,21 +3200,21 @@ The available backends are: bind to subsequent ports up to and including ``to`` until it succeeds. ``to`` must be specified as a port number. - ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be - used. If neither is specified the socket may use either - protocol. + ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 + or IPv6 must be used. If neither is specified the socket may + use either protocol. - ``nodelay`` disables the Nagle algorithm. + ``delay=on|off`` disables the Nagle algorithm. ``unix options: path=path[,abstract=on|off][,tight=on|off]`` ``path`` specifies the local path of the unix socket. ``path`` is required. - ``abstract`` specifies the use of the abstract socket namespace, + ``abstract=on|off`` specifies the use of the abstract socket namespace, rather than the filesystem. Optional, defaults to false. - ``tight`` sets the socket length of abstract sockets to their minimum, + ``tight=on|off`` sets the socket length of abstract sockets to their minimum, rather than the full sun_path length. Optional, defaults to true. -``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4][,ipv6]`` +``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4=on|off][,ipv6=on|off]`` Sends all traffic from the guest to a remote host over UDP. ``host`` specifies the remote host to connect to. If not specified @@ -3228,7 +3229,7 @@ The available backends are: ``localport`` specifies the local port to bind to. If not specified any available local port will be used. - ``ipv4`` and ``ipv6`` specify that either IPv4 or IPv6 must be used. + ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 or IPv6 must be used. If neither is specified the device may use either protocol. ``-chardev msmouse,id=id`` @@ -3592,30 +3593,30 @@ SRST ``telnet options:`` localhost 5555 - ``tcp:[host]:port[,server][,nowait][,nodelay][,reconnect=seconds]`` + ``tcp:[host]:port[,server=on|off][,wait=on|off][,delay=on|off][,reconnect=seconds]`` The TCP Net Console has two modes of operation. It can send the serial I/O to a location or wait for a connection from a location. By default the TCP Net Console is sent to host at the - port. If you use the server option QEMU will wait for a client + port. If you use the ``server=on`` option QEMU will wait for a client socket application to connect to the port before continuing, - unless the ``nowait`` option was specified. The ``nodelay`` - option disables the Nagle buffering algorithm. The ``reconnect`` - option only applies if noserver is set, if the connection goes + unless the ``wait=on|off`` option was specified. The ``delay=on|off`` + option disables the Nagle buffering algorithm. The ``reconnect=on`` + option only applies if ``server=no`` is set, if the connection goes down it will attempt to reconnect at the given interval. If host is omitted, 0.0.0.0 is assumed. Only one TCP connection at a - time is accepted. You can use ``telnet`` to connect to the + time is accepted. You can use ``telnet=on`` to connect to the corresponding character device. ``Example to send tcp console to 192.168.0.2 port 4444`` -serial tcp:192.168.0.2:4444 ``Example to listen and wait on port 4444 for connection`` - -serial tcp::4444,server + -serial tcp::4444,server=on ``Example to not wait and listen on ip 192.168.0.100 port 4444`` - -serial tcp:192.168.0.100:4444,server,nowait + -serial tcp:192.168.0.100:4444,server=on,wait=off - ``telnet:host:port[,server][,nowait][,nodelay]`` + ``telnet:host:port[,server=on|off][,wait=on|off][,delay=on|off]`` The telnet protocol is used instead of raw tcp sockets. The options work the same as if you had specified ``-serial tcp``. The difference is that the port acts like a telnet server or @@ -3625,11 +3626,11 @@ SRST you do it with Control-] and then type "send break" followed by pressing the enter key. - ``websocket:host:port,server[,nowait][,nodelay]`` + ``websocket:host:port,server=on[,wait=on|off][,delay=on|off]`` The WebSocket protocol is used instead of raw tcp socket. The port acts as a WebSocket server. Client mode is not supported. - ``unix:path[,server][,nowait][,reconnect=seconds]`` + ``unix:path[,server=on|off][,wait=on|off][,reconnect=seconds]`` A unix domain socket is used instead of a tcp socket. The option works the same as if you had specified ``-serial tcp`` except the unix domain socket path is used for connections. @@ -3642,7 +3643,7 @@ SRST multiplex the monitor onto a telnet server listening on port 4444 would be: - ``-serial mon:telnet::4444,server,nowait`` + ``-serial mon:telnet::4444,server=on,wait=off`` When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate QEMU any more but will be passed to the guest @@ -4134,8 +4135,8 @@ SRST ERST DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ - "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ - "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ + "-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]\n" \ + "-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]\n" \ "-incoming unix:socketpath\n" \ " prepare for incoming migration, listen on\n" \ " specified protocol and socket address\n" \ @@ -4147,9 +4148,9 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ " wait for the URI to be specified via migrate_incoming\n", QEMU_ARCH_ALL) SRST -``-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]`` +``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]`` \ -``-incoming rdma:host:port[,ipv4][,ipv6]`` +``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]`` Prepare for incoming migration, listen on a given tcp port. ``-incoming unix:socketpath`` @@ -4334,13 +4335,8 @@ SRST ERST DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, "-writeconfig <file>\n" - " read/write config file\n", QEMU_ARCH_ALL) + " read/write config file (deprecated)\n", QEMU_ARCH_ALL) SRST -``-writeconfig file`` - Write device configuration to file. The file can be either filename - to save command line and device configuration into file or dash - ``-``) character to print the output to stdout. This can be later - used as input file for ``-readconfig`` option. ERST DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, @@ -4815,11 +4811,11 @@ SRST primary: -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 - -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait - -chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait - -chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait + -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off + -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off + -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 - -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait + -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 -object iothread,id=iothread1 -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 @@ -4841,13 +4837,13 @@ SRST primary: -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 - -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait - -chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait - -chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait + -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off + -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off + -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off -chardev socket,id=compare0-0,host=3.3.3.3,port=9001 - -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait + -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off -chardev socket,id=compare_out0,host=3.3.3.3,port=9005 - -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server,nowait + -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server=on,wait=off -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 |