From patchwork Tue Jun 1 01:43:13 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ahmed Abouzied X-Patchwork-Id: 12290373 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-21.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4C4C5C47082 for ; Tue, 1 Jun 2021 03:19:44 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id BF5D160FEE for ; Tue, 1 Jun 2021 03:19:43 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org BF5D160FEE Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=aabouzied.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:43944 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lnuwQ-0005gE-Ue for qemu-devel@archiver.kernel.org; Mon, 31 May 2021 23:19:42 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:34372) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lntV5-0005SG-9i for qemu-devel@nongnu.org; Mon, 31 May 2021 21:47:23 -0400 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]:46670) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lntV1-0005fZ-Ob for qemu-devel@nongnu.org; Mon, 31 May 2021 21:47:23 -0400 Received: by mail-wm1-x32e.google.com with SMTP id l18-20020a1c79120000b0290181c444b2d0so890397wme.5 for ; Mon, 31 May 2021 18:47:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aabouzied-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=9hVzdzbb8GVsVCXn3Me44FSGiP/knRo1iN1KKR+WEpE=; b=fkNtQVOcP0nmZOJ18bh64/KKxFNZ/b4qada8RcRrwreiSedGUZIK4oMSA2MQ514qoK brDvlJxiKroR5lqNXfzYG+lvOB7qVET6cUVxEPxbuCBge9VnuHWBh0qhcBHSrbh4lDYz IG+PYLIUXIVudqahtX/TU6lu1EWpJxuze9f2zxdcKchazIl/IpzQhvg2bCd/YjAUc0GE V04bBsby1mQaIb1B7FhKMg+X3qB+kjqNG0Odh1gkA73OTlLwCltij7kPVEcjElkV5S16 XNf8iaKlNzPSQYeU8Py51qDwOte3KWTU4gpWjN4Ccw5onxq6kQ7kYzhUtDsDNRvmQNjr 1f0Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=9hVzdzbb8GVsVCXn3Me44FSGiP/knRo1iN1KKR+WEpE=; b=nH7/FyzV5fmEHrCX1B1HwNEcUAopQklE9g9ko6aqY1vwm3/zTnVsXjM+7+3Ys7Kx9W oBZWO1YWbqbvxSWlEOws3cDGkc3h0CEJEqR2E7JiSOR88J5SrWHii0hejb/vyhV5E2gH 97848i56d+0VPnJ0u6rUxCJwX3/AJbWCySITAcUfhY6o5rd6yVdRAfUiefglGSof7BhO uVxjptb35YaqXC9reD+IFYML3mDxMKNEauoWiH4BhKKOEQOgf4hhCm9p8iYYzGuLS6NV tiBnOZvsYYEm3fHWMyNtvqHj7lNZU63TwPdiBXUa0WFxgQ76MVUMZ0B+14FW94vOKt4f nkvw== X-Gm-Message-State: AOAM531HwN6NMKzeaRmms/WV95NvuLzxpIQelmpV4bz6en7arS84YAm/ n8lGwvch0EPSX73/iFxlGBNsYeK/Y+UeoaVaYMN3FA== X-Google-Smtp-Source: ABdhPJwr5e6sAMfVHe1hY+0bKaHTrG+9rm9VizLOv3u7dlIQzce3gBqbcUcAXMq+ToS45MbEO/z/Eg== X-Received: by 2002:a05:600c:2dd0:: with SMTP id e16mr23357405wmh.135.1622512037300; Mon, 31 May 2021 18:47:17 -0700 (PDT) Received: from pythagoras.localdomain ([154.187.234.222]) by smtp.gmail.com with ESMTPSA id f5sm1483266wrf.22.2021.05.31.18.47.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 31 May 2021 18:47:16 -0700 (PDT) From: email@aabouzied.com To: qemu-devel@nongnu.org Subject: [PATCH] Add display suboptions to man pages Date: Tue, 1 Jun 2021 03:43:13 +0200 Message-Id: <20210601014312.17981-1-email@aabouzied.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Received-SPF: none client-ip=2a00:1450:4864:20::32e; envelope-from=email@aabouzied.com; helo=mail-wm1-x32e.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Mon, 31 May 2021 23:18:21 -0400 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: qemu-trivial@nongnu.org, Ahmed Abouzied Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" From: Ahmed Abouzied Updates man pages with the suboptions for the `-display`. Resolves: https://gitlab.com/qemu-project/qemu/-/issues/128 Buglink: https://bugs.launchpad.net/qemu/+bug/1620660 Signed-off-by: Ahmed Abouzied --- This is just a trivial update for the man pages. It's the first time I get to know QEMU source code. I didn't know which maintainer to CC here. The `scripts/get_maintainer.pl` script didn't show any maintainers for this file. I did CC the trivial mailing list because this is a very small change. Please let me know if the patch format is incorrect or something and I'll fix it. Looking forward to getting back feedback. Thanks --- qemu-options.hx | 71 ++++++++++++++++++++++++++----------------------- 1 file changed, 37 insertions(+), 34 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index 14258784b3..587cd7786d 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -227,15 +227,15 @@ DEF("numa", HAS_ARG, QEMU_OPTION_numa, QEMU_ARCH_ALL) SRST ``-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` - \ + \ ``-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node][,initiator=initiator]`` \ ``-numa dist,src=source,dst=destination,val=distance`` - \ + \ ``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]`` - \ + \ ``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]`` - \ + \ ``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]`` Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA distance from a source node to a destination node. Set the ACPI @@ -430,7 +430,7 @@ DEF("global", HAS_ARG, QEMU_OPTION_global, QEMU_ARCH_ALL) SRST ``-global driver.prop=value`` - \ + \ ``-global driver=driver,property=property,value=value`` Set default value of driver's property prop to value, e.g.: @@ -976,9 +976,9 @@ SRST ``-hda file`` \ ``-hdb file`` - \ + \ ``-hdc file`` - \ + \ ``-hdd file`` Use file as hard disk 0, 1, 2 or 3 image (see the :ref:`disk images` chapter in the System Emulation Users Guide). @@ -1468,7 +1468,7 @@ DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, SRST ``-fsdev local,id=id,path=path,security_model=security_model [,writeout=writeout][,readonly=on][,fmode=fmode][,dmode=dmode] [,throttling.option=value[,throttling.option=value[,...]]]`` - \ + \ ``-fsdev proxy,id=id,socket=socket[,writeout=writeout][,readonly=on]`` \ ``-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=writeout][,readonly=on]`` @@ -1589,9 +1589,9 @@ DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, SRST ``-virtfs local,path=path,mount_tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly=on] [,fmode=fmode][,dmode=dmode][,multidevs=multidevs]`` - \ + \ ``-virtfs proxy,socket=socket,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` - \ + \ ``-virtfs proxy,sock_fd=sock_fd,mount_tag=mount_tag [,writeout=writeout][,readonly=on]`` \ ``-virtfs synth,mount_tag=mount_tag`` @@ -1819,11 +1819,22 @@ SRST old style -sdl/-curses/... options. Use ``-display help`` to list the available display types. Valid values for type are - ``sdl`` + ``spice-app[,gl=on|off]`` + Start QEMU as a Spice server and launch the default Spice client + application. The Spice server will redirect the serial consoles + and QEMU monitors. (Since 4.0) + + ``sdl[,alt_grab=on|off][,ctrl_grab=on|off][,window_close=on|off][,gl=on|core|es|off]`` + Display video output via SDL (usually in a separate graphics window; see the SDL documentation for other possibilities). - ``curses`` + ``gtk[,grab_on_hover=on|off][,gl=on|off]`` + Display video output in a GTK window. This interface provides + drop-down menus and other UI elements to configure and control + the VM during runtime. + + ``curses [,charset=]`` Display video output via curses. For graphics device models which support a text mode, QEMU can display this output using a curses/ncurses interface. Nothing is displayed when the graphics @@ -1834,6 +1845,14 @@ SRST ``charset=CP850`` for IBM CP850 encoding. The default is ``CP437``. + ``vnc=[,]`` + Start a VNC server on display + + ``egl-headless[,rendernode]`` + Offload all OpenGL operations to a local DRI device. For any + graphical display, this display needs to be paired with either + VNC or SPICE displays. + ``none`` Do not display video output. The guest will still see an emulated graphics card, but its output will not be displayed to @@ -1842,24 +1861,8 @@ SRST also changes the destination of the serial and parallel port data. - ``gtk`` - Display video output in a GTK window. This interface provides - drop-down menus and other UI elements to configure and control - the VM during runtime. - - ``vnc`` - Start a VNC server on display - - ``egl-headless`` - Offload all OpenGL operations to a local DRI device. For any - graphical display, this display needs to be paired with either - VNC or SPICE displays. - ``spice-app`` - Start QEMU as a Spice server and launch the default Spice client - application. The Spice server will redirect the serial consoles - and QEMU monitors. (Since 4.0) -ERST + ERST DEF("nographic", 0, QEMU_OPTION_nographic, "-nographic disable graphical output and redirect serial I/Os to console\n", @@ -3799,10 +3802,10 @@ DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL) SRST ``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]`` - Setup monitor on chardev name. ``mode=control`` configures + Setup monitor on chardev name. ``mode=control`` configures a QMP monitor (a JSON RPC-style protocol) and it is not the same as HMP, the human monitor that has a "(qemu)" prompt. - ``pretty`` is only valid when ``mode=control``, + ``pretty`` is only valid when ``mode=control``, turning on JSON pretty printing to ease human reading and debugging. ERST @@ -3863,7 +3866,7 @@ DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit, QEMU_ARCH_ALL) SRST ``-overcommit mem-lock=on|off`` - \ + \ ``-overcommit cpu-pm=on|off`` Run qemu with hints about host resource overcommit. The default is to assume that host overcommits all resources. @@ -4249,7 +4252,7 @@ DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ QEMU_ARCH_ALL) SRST ``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]`` - \ + \ ``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]`` Prepare for incoming migration, listen on a given tcp port. @@ -4998,7 +5001,7 @@ SRST [...] ``-object secret,id=id,data=string,format=raw|base64[,keyid=secretid,iv=string]`` - \ + \ ``-object secret,id=id,file=filename,format=raw|base64[,keyid=secretid,iv=string]`` Defines a secret to store a password, encryption key, or some other sensitive data. The sensitive data can either be passed