]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: man: Document '--once' for 'virsh autostart'
authorPeter Krempa <pkrempa@redhat.com>
Mon, 5 May 2025 14:39:25 +0000 (16:39 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Thu, 15 May 2025 06:27:27 +0000 (08:27 +0200)
Document the '--once' option and how it combines with the setting
without '--once'.

Resolves: https://issues.redhat.com/browse/RHEL-89414
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
docs/manpages/virsh.rst

index cef9959f166ab65d2b00c44c61f378eae82d3690..0a54f6deff2ef0f4ea9587b209a8ca3b3a64cd42 100644 (file)
@@ -1088,12 +1088,17 @@ autostart
 
 ::
 
-   autostart [--disable] domain
+   autostart [--disable] [--once] domain
 
 
-Configure a domain to be automatically started at boot.
+Configure a domain to be automatically started at each boot of the host. The
+*--once* option configures the domain to be started on the next boot of the host.
 
-The option *--disable* disables autostarting.
+The option *--disable* disables the corresponding autostarting.
+
+Note that autostart configured via the *--once* option is independent from the
+autostart configured without it. Enabling either of them will cause the VM to
+be started on the next boot of the host.
 
 
 blkdeviotune