qvm-run.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. .. program:: qvm-run
  2. :program:`qvm-run` -- Run a command in a specified VM
  3. =====================================================
  4. Synopsis
  5. --------
  6. :command:`qvm-run` [-h] [--verbose] [--quiet] [--all] [--exclude *EXCLUDE*] [--user *USER*] [--autostart] [--pass-io] [--localcmd *COMMAND*] [--gui] [--no-gui] [--colour-output *COLOR*] [--no-color-output] [--filter-escape-chars] [--no-filter-escape-chars] [*VMNAME*] *COMMAND*
  7. Options
  8. -------
  9. .. option:: --help, -h
  10. Show the help message and exit.
  11. .. option:: --verbose, -v
  12. Increase verbosity.
  13. .. option:: --quiet, -q
  14. Decrease verbosity.
  15. .. option:: --all
  16. Run the command on all qubes. You can use :option:`--exclude` to limit the
  17. qubes set. Command is never run on the dom0.
  18. .. option:: --exclude
  19. Exclude the qube from :option:`--all`.
  20. .. option:: --user=USER, -u USER
  21. Run command in a qube as *USER*.
  22. .. option:: --auto, --autostart, -a
  23. Ignored. Qube is autostarted by default.
  24. .. option:: --no-auto, --no-autostart, -n
  25. Do not start the qube automatically, fail the operation if not running.
  26. .. option:: --pass-io, -p
  27. Pass standard input and output to and from the remote program.
  28. .. option:: --localcmd=COMMAND
  29. With :option:`--pass-io`, pass standard input and output to and from the
  30. given program.
  31. .. option:: --gui
  32. Run the command with GUI forwarding enabled, which is the default. This
  33. switch can be used to counter :option:`--no-gui`.
  34. .. option:: --no-gui, --nogui
  35. Run the command without GUI forwarding enabled. Can be switched back with
  36. :option:`--gui`.
  37. .. option:: --colour-output=COLOUR, --color-output=COLOR
  38. Mark the qube output with given ANSI colour (ie. "31" for red). The exact
  39. mapping of numbers to colours and styles depends of the particular terminal
  40. emulator.
  41. Colouring can be disabled with :option:`--no-colour-output`.
  42. .. option:: --colour-stderr=COLOUR, --color-stderr=COLOR
  43. Mark the qube stderr with given ANSI colour (ie. "31" for red). The exact
  44. mapping of numbers to colours and styles depends of the particular terminal
  45. emulator.
  46. Colouring can be disabled with :option:`--no-colour-stderr`.
  47. .. option:: --no-colour-output, --no-color-output
  48. Disable colouring the stdout.
  49. .. option:: --no-colour-stderr, --no-color-stderr
  50. Disable colouring the stderr.
  51. .. option:: --filter-escape-chars
  52. Filter terminal escape sequences (default if output is terminal).
  53. Terminal control characters are a security issue, which in worst case amount
  54. to arbitrary command execution. In the simplest case this requires two often
  55. found codes: terminal title setting (which puts arbitrary string in the
  56. window title) and title repo reporting (which puts that string on the shell's
  57. standard input.
  58. .. option:: --no-filter-escape-chars
  59. Do not filter terminal escape sequences. This is DANGEROUS when output is
  60. a terminal emulator. See :option:`--filter-escape-chars` for explanation.
  61. Authors
  62. -------
  63. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  64. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  65. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  66. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  67. .. vim: ts=3 sw=3 et tw=80