From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id 59CE31FF0E4 for ; Tue, 28 Jul 2026 09:44:29 +0200 (CEST) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 77450214B1; Tue, 28 Jul 2026 09:44:28 +0200 (CEST) From: Aaron Lauterer To: pve-devel@lists.proxmox.com Subject: [PATCH docs] qm.adoc: switch named parameter to double dashes Date: Tue, 28 Jul 2026 09:44:18 +0200 Message-ID: <20260728074418.1810160-1-a.lauterer@proxmox.com> X-Mailer: git-send-email 2.47.3 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1785224622255 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.262 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) KAM_SHORT 0.001 Use of a URL Shortener for very short URL RCVD_IN_DNSWL_LOW -0.7 Sender listed at https://www.dnswl.org/, low trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: Z7SWMZ5MT2NVLSUSKM2G4OBHVN4Z4S4H X-Message-ID-Hash: Z7SWMZ5MT2NVLSUSKM2G4OBHVN4Z4S4H X-MailFrom: a.lauterer@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: While single dashes technically work, the man pages shows them always with the usualy double dashes. Autocompletion is also expecting double dashes to work properly. Signed-off-by: Aaron Lauterer --- qm.adoc | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/qm.adoc b/qm.adoc index 93372c5..07483d5 100644 --- a/qm.adoc +++ b/qm.adoc @@ -860,7 +860,7 @@ https://github.com/PSPReverse/amd-sev-migration-attack[attackable]. *Example Configuration (SEV):* ---- -# qm set -amd-sev type=std,no-debug=1,no-key-sharing=1,kernel-hashes=1 +# qm set --amd-sev type=std,no-debug=1,no-key-sharing=1,kernel-hashes=1 ---- The *type* defines the encryption technology ("type=" is not necessary). @@ -902,7 +902,7 @@ Output should be 1. *Example Configuration (SEV-SNP):* ---- -# qm set -amd-sev type=snp,allow-smt=1,no-debug=1,kernel-hashes=1 +# qm set --amd-sev type=snp,allow-smt=1,no-debug=1,kernel-hashes=1 ---- The `allow-smt` policy-bit is set by default. If you disable it by setting @@ -1056,7 +1056,7 @@ setting will be ignored in that case. You can enable the VNC clipboard by setting `clipboard` to `vnc`. ---- -# qm set -vga ,clipboard=vnc +# qm set --vga ,clipboard=vnc ---- In order to use the clipboard feature, you must first install the @@ -1145,7 +1145,7 @@ This disk will be included in backups and snapshots, and there can only be one. You can create such a disk with the following command: ---- -# qm set -efidisk0 :1,format=,efitype=4m,pre-enrolled-keys=1 +# qm set --efidisk0 :1,format=,efitype=4m,pre-enrolled-keys=1 ---- Where ** is the storage where you want to have the disk, and @@ -1166,7 +1166,7 @@ xref:qm_secure_boot_ca_expiration[Secure Boot Certificate Expiration]. NOTE: If you want to start using Secure Boot in an existing VM (that still uses a '2m' efidisk), you need to recreate the efidisk. To do so, delete the old one -(`qm set -delete efidisk0`) and add a new one as described above. This +(`qm set --delete efidisk0`) and add a new one as described above. This will reset any custom configurations you have made in the OVMF menu! When using OVMF with a virtual display (without VGA passthrough), @@ -1248,7 +1248,7 @@ efidisk, in that it cannot be changed (only removed) once created. You can add one via the following command: ---- -# qm set -tpmstate0 :1,version= +# qm set --tpmstate0 :1,version= ---- Where ** is the storage you want to put the state on, and ** @@ -1274,7 +1274,7 @@ share memory between the host and a guest, or also between multiple guests. To add such a device, you can use `qm`: ---- -# qm set -ivshmem size=32,name=foo +# qm set --ivshmem size=32,name=foo ---- Where the size is in MiB. The file will be located under @@ -1295,7 +1295,7 @@ Audio Device To add an audio device run the following command: ---- -qm set -audio0 device= +qm set --audio0 device= ---- Supported audio devices are: @@ -1330,7 +1330,7 @@ slow down or run into problems), especially during the guests boot process. To add a VirtIO-based emulated RNG, run the following command: ---- -qm set -rng0 source=[,max_bytes=X,period=Y] +qm set --rng0 source=[,max_bytes=X,period=Y] ---- `source` specifies where entropy is read from on the host and has to be one of @@ -1434,9 +1434,9 @@ parameter to `1` (default: `0`). This will degrade performance, but is useful if applications do their own caching. ---- -qm set -virtiofs0 dirid=,cache=always,direct-io=1 -qm set -virtiofs1 ,cache=never,expose-xattr=1 -qm set -virtiofs2 ,expose-acl=1 +qm set --virtiofs0 dirid=,cache=always,direct-io=1 +qm set --virtiofs1 ,cache=never,expose-xattr=1 +qm set --virtiofs2 ,expose-acl=1 ---- To temporarily mount virtiofs in a guest VM with the Linux kernel virtiofs @@ -1501,7 +1501,7 @@ boot' from the 'Options' Tab of your VM in the web interface, or set it with the following command: ---- -# qm set -onboot 1 +# qm set --onboot 1 ---- .Start and Shutdown Order @@ -1664,7 +1664,7 @@ To enable them via the GUI go to the *Options* panel of the virtual machine. Run the following command to enable them via the CLI: ---- -qm set -spice_enhancements foldersharing=1,videostreaming=all +qm set --spice_enhancements foldersharing=1,videostreaming=all ---- NOTE: To use these features the <> of the virtual machine @@ -1913,8 +1913,8 @@ footnote:[Online GUID generator http://guid.one/] by using it as value, for example: ---- -# qm set VMID -vmgenid 1 -# qm set VMID -vmgenid 00000000-0000-0000-0000-000000000000 +# qm set VMID --vmgenid 1 +# qm set VMID --vmgenid 00000000-0000-0000-0000-000000000000 ---- NOTE: The initial addition of a 'vmgenid' device to an existing VM, may result @@ -1926,7 +1926,7 @@ its value on VM creation, or retroactively delete the property in the configuration with: ---- -# qm set VMID -delete vmgenid +# qm set VMID --delete vmgenid ---- The most prominent use case for 'vmgenid' are newer Microsoft Windows @@ -2220,13 +2220,13 @@ which exact virtual function is passed through. You can assign such a device to a guest either with the GUI or with ---- -# qm set ID -hostpci0 +# qm set ID --hostpci0 ---- for PCI devices, or ---- -# qm set -usb0 +# qm set --usb0 ---- for USB devices. @@ -2275,7 +2275,7 @@ Using an iso file uploaded on the 'local' storage, create a VM with a 4 GB IDE disk on the 'local-lvm' storage ---- -# qm create 300 -ide0 local-lvm:4 -net0 e1000 -cdrom local:iso/proxmox-mailgateway_2.1.iso +# qm create 300 --ide0 local-lvm:4 --net0 e1000 --cdrom local:iso/proxmox-mailgateway_2.1.iso ---- Start the new VM @@ -2293,14 +2293,14 @@ Send a shutdown request, then wait until the VM is stopped. Same as above, but only wait for 40 seconds. ---- -# qm shutdown 300 && qm wait 300 -timeout 40 +# qm shutdown 300 && qm wait 300 --timeout 40 ---- If the VM does not shut down, force-stop it and overrule any running shutdown tasks. As stopping VMs may incur data loss, use it with caution. ---- -# qm stop 300 -overrule-shutdown 1 +# qm stop 300 --overrule-shutdown 1 ---- Destroying a VM always removes it from Access Control Lists and it always -- 2.47.3