qvm-run.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  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. Start the qube if it is not running.
  24. .. option:: --pass-io, -p
  25. Pass standard input and output to and from the remote program.
  26. .. option:: --localcmd=COMMAND
  27. With :option:`--pass-io`, pass standard input and output to and from the
  28. given program.
  29. .. option:: --gui
  30. Run the command with GUI forwarding enabled, which is the default. This
  31. switch can be used to counter :option:`--no-gui`.
  32. .. option:: --no-gui, --nogui
  33. Run the command without GUI forwarding enabled. Can be switched back with
  34. :option:`--gui`.
  35. .. option:: --colour-output=COLOUR, --color-output=COLOR
  36. Mark the qube output with given ANSI colour (ie. "31" for red). The exact
  37. apping of numbers to colours and styles depends of the particular terminal
  38. emulator.
  39. Colouring can be disabled with :option:`--no-colour-output`.
  40. .. option:: --no-colour-output, --no-color-output
  41. Disable colouring the stdio.
  42. .. option:: --filter-escape-chars
  43. Filter terminal escape sequences (default if output is terminal).
  44. Terminal control characters are a security issue, which in worst case amount
  45. to arbitrary command execution. In the simplest case this requires two often
  46. found codes: terminal title setting (which puts arbitrary string in the
  47. window title) and title repo reporting (which puts that string on the shell's
  48. standard input.
  49. .. option:: --no-filter-escape-chars
  50. Do not filter terminal escape sequences. This is DANGEROUS when output is
  51. a terminal emulator. See :option:`--filter-escape-chars` for explanation.
  52. Authors
  53. -------
  54. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  55. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  56. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  57. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  58. .. vim: ts=3 sw=3 et tw=80