From 57a98b97cb47d22e18e4e4f77855107f8db11711 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Marczykowski-G=C3=B3recki?= Date: Sat, 8 Dec 2018 23:29:25 +0100 Subject: [PATCH] doc: improve qvm-device man page Move options after action. Make note about `qvm-block`, `qvm-usb`, `qvm-pci` more visible. Suggested by @GammaSQ QubesOS/qubes-issues#4530 --- doc/manpages/qvm-device.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/doc/manpages/qvm-device.rst b/doc/manpages/qvm-device.rst index 2f22a21..8b957f5 100644 --- a/doc/manpages/qvm-device.rst +++ b/doc/manpages/qvm-device.rst @@ -6,13 +6,12 @@ Synopsis ======== -| :command:`qvm-device` [*options*] *DEVICE_CLASS* {list,ls,l} <*vm-name*> -| :command:`qvm-device` [*options*] *DEVICE_CLASS* {attach,at,a} <*vm-name*> <*device*> -| :command:`qvm-device` [*options*] *DEVICE_CLASS* {detach,dt,d} <*vm-name*> [<*device*>] -| :command:`qvm-*DEVICE_CLASS*` [*options*] {list,ls,l,attach,at,a,detach,dt,d} <*vmname*> ... +| :command:`qvm-device` *DEVICE_CLASS* {list,ls,l} [*options*] <*vm-name*> +| :command:`qvm-device` *DEVICE_CLASS* {attach,at,a} [*options*] <*vm-name*> <*device*> +| :command:`qvm-device` *DEVICE_CLASS* {detach,dt,d} [*options*] <*vm-name*> [<*device*>] +| :command:`qvm-*DEVICE_CLASS*` {list,ls,l,attach,at,a,detach,dt,d} [*options*] <*vmname*> ... -Tool can be called either as `qvm-device *DEVICE_CLASS* ...`, or -`qvm-*DEVICE_CLASS* ...`. The latter is used for `qvm-pci`, `qvm-block` etc. +.. note:: :command:`qvm-block`, :command:`qvm-usb` and :command:`qvm-pci` are just aliases for :command:`qvm-device block`, :command:`qvm-device usb` and :command:`qvm-device pci` respectively. Options =======