qvm-block.rst 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. .. program:: qvm-block
  2. :program:`qvm-block` -- Qubes volume and block device managment
  3. ===============================================================
  4. Synopsis
  5. --------
  6. | :command:`qvm-block` *COMMAND* [-h] [--verbose] [--quiet] [options] [arguments]
  7. Description
  8. -----------
  9. .. TODO Add description
  10. Options
  11. -------
  12. .. option:: --help, -h
  13. Show help message and exit
  14. .. option:: --verbose, -v
  15. Increase verbosity.
  16. .. option:: --quiet, -q
  17. Decrease verbosity.
  18. Commands
  19. --------
  20. list
  21. ^^^^
  22. | :command:`qvm-block list` [-h] [--verbose] [--quiet] [-p *POOL_NAME*] [-i] [*VMNAME* [*VMNAME* ...]]
  23. List block devices. By default the internal devices are hidden. When the
  24. stdout is connected to a TTY `qvm-block list` will print a pretty table by
  25. omitting redundant data. This behaviour is disabled when `--full` option is
  26. passed or stdout is redirected to a pipe or file.
  27. .. option:: -p, --pool
  28. list volumes from specified pool
  29. .. option:: -i, --internal
  30. list internal devices
  31. .. option:: --full
  32. print domain names
  33. .. option:: --all
  34. List volumes from all qubes. You can use :option:`--exclude` to limit the
  35. qubes set. Don't forget — internal devices are hidden by default!
  36. .. option:: --exclude
  37. Exclude the qube from :option:`--all`.
  38. aliases: ls, l
  39. attach
  40. ^^^^^^
  41. | :command:`qvm-block attach` [-h] [--verbose] [--quiet] [--ro] *VMNAME* *POOL_NAME:VOLUME_ID*
  42. Attach the volume with *VOLUME_ID* from *POOL_NAME* to the domain *VMNAME*
  43. .. option:: --ro
  44. attach device read-only
  45. aliases: a, at
  46. detach
  47. ^^^^^^
  48. | :command:`qvm-block detach` [-h] [--verbose] [--quiet] *VMNAME* *POOL_NAME:VOLUME_ID*
  49. Detach the volume with *POOL_NAME:VOLUME_ID* from domain *VMNAME*
  50. aliases: d, dt
  51. Authors
  52. -------
  53. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  54. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  55. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  56. | Bahtiar `kalkin-` Gadimov <bahtiar at gadimov dot de>
  57. .. vim: ts=3 sw=3 et tw=80