all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Aaron Lauterer <a.lauterer@proxmox.com>
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	[thread overview]
Message-ID: <20260728074418.1810160-1-a.lauterer@proxmox.com> (raw)

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 <a.lauterer@proxmox.com>
---
 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 <vmid> -amd-sev type=std,no-debug=1,no-key-sharing=1,kernel-hashes=1
+# qm set <vmid> --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 <vmid> -amd-sev type=snp,allow-smt=1,no-debug=1,kernel-hashes=1
+# qm set <vmid> --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 <vmid> -vga <displaytype>,clipboard=vnc
+# qm set <vmid> --vga <displaytype>,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 <vmid> -efidisk0 <storage>:1,format=<format>,efitype=4m,pre-enrolled-keys=1
+# qm set <vmid> --efidisk0 <storage>:1,format=<format>,efitype=4m,pre-enrolled-keys=1
 ----
 
 Where *<storage>* 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 <vmid> -delete efidisk0`) and add a new one as described above. This
+(`qm set <vmid> --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 <vmid> -tpmstate0 <storage>:1,version=<version>
+# qm set <vmid> --tpmstate0 <storage>:1,version=<version>
 ----
 
 Where *<storage>* is the storage you want to put the state on, and *<version>*
@@ -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 <vmid> -ivshmem size=32,name=foo
+# qm set <vmid> --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 <vmid> -audio0 device=<device>
+qm set <vmid> --audio0 device=<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 <vmid> -rng0 source=<source>[,max_bytes=X,period=Y]
+qm set <vmid> --rng0 source=<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 <vmid> -virtiofs0 dirid=<dirid>,cache=always,direct-io=1
-qm set <vmid> -virtiofs1 <dirid>,cache=never,expose-xattr=1
-qm set <vmid> -virtiofs2 <dirid>,expose-acl=1
+qm set <vmid> --virtiofs0 dirid=<dirid>,cache=always,direct-io=1
+qm set <vmid> --virtiofs1 <dirid>,cache=never,expose-xattr=1
+qm set <vmid> --virtiofs2 <dirid>,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 <vmid> -onboot 1
+# qm set <vmid> --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 <vmid> -spice_enhancements foldersharing=1,videostreaming=all
+qm set <vmid> --spice_enhancements foldersharing=1,videostreaming=all
 ----
 
 NOTE: To use these features the <<qm_display,*Display*>> 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 <name>
+# qm set ID --hostpci0 <name>
 ----
 
 for PCI devices, or
 
 ----
-# qm set <vmid> -usb0 <name>
+# qm set <vmid> --usb0 <name>
 ----
 
 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





                 reply	other threads:[~2026-07-28  7:44 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260728074418.1810160-1-a.lauterer@proxmox.com \
    --to=a.lauterer@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal