diff --git a/reference/tools/4.0/domU.md b/reference/tools/4.0/domU.md index a2ac1716..6429c9c4 100644 --- a/reference/tools/4.0/domU.md +++ b/reference/tools/4.0/domU.md @@ -7,8 +7,9 @@ permalink: /doc/tools/4.0/domU/ DomU Command-Line Tools for Qubes 4.0 ===================================== -Reference pages for these tools are being written. -This page will be updated when they're available. - -Tracking issue: + * [qrexec-client-vm](/doc/tools/4.0/domU/qrexec-client-vm/) + * [qvm-copy-to-vm](/doc/tools/4.0/domU/qvm-copy-to-vm/) + * [qvm-open-in-dvm](/doc/tools/4.0/domU/qvm-open-in-dvm/) + * [qvm-open-in-vm](/doc/tools/4.0/domU/qvm-open-in-vm/) + * [qvm-run-vm](/doc/tools/4.0/domU/qvm-run-vm/) diff --git a/reference/tools/4.0/domU/qrexec-client-vm.md b/reference/tools/4.0/domU/qrexec-client-vm.md new file mode 100644 index 00000000..8483e463 --- /dev/null +++ b/reference/tools/4.0/domU/qrexec-client-vm.md @@ -0,0 +1,98 @@ +--- +layout: doc +title: qrexec-client-vm +permalink: /doc/tools/4.0/domU/qrexec-client-vm/ +--- + +``` +================ +qrexec-client-vm +================ + +NAME +==== +qrexec-client-vm - call Qubes RPC service + +SYNOPSIS +======== +| qrexec-client-vm *target_vmname* *service* [*local_program* [*local program arguments*]] + +DESCRIPTION +=========== + +Call Qubes RPC (aka qrexec) service to a different VM. The service call request +is sent to dom0, where Qubes RPC policy is evaluated and when it allows the +call, it is forwarded to appropriate target VM (which may be different than +requested, if policy says so). Local program (if given) is started only +when service call is allowed by the policy. + +Remote service can communicate with the caller (``qrexec-client-vm``) using +stdin/stdout. When *local_program* is given, its stdin/stdout is connected to +service stdin/stdout (stderr is not redirected), otherwise - service +stdin/stdout is connected to those of ``qrexec-client-vm``. + +OPTIONS +======= + +*target_vmname* + + Name of target VM to which service is requested. Qubes RPC policy may + ignore this value and redirect call somewhere else. + + This argument, can contain VM name, or one of special values: + + * ``$default`` or empty string - let Qubes RPC policy decide, without giving any preference + + * ``$dispvm`` - new Disposable VM + + * ``$dispvm:dispvm-template`` - new Disposable VM based on *dispvm-template* + + This field is limited to 31 characters (alphanumeric, plus ``-_.$``). + +*service* + + Requested service. Besides service name, it can contain a service argument + after ``+`` character. For example ``some.service+argument``. + + This field is limited to 63 characters (alphanumeric, plus ``-_.$+``). + +*local_program* + + Full path to local program to be connected with remote service. Optional. + +*local program arguments* + + Arguments to *local_program*. Optional. + +EXIT STATUS +=========== + +If service call is allowed by dom0 and ``qrexec-client-vm`` is started without +*local_program* argument, it reports remote service exit code. + +If service call is allowed by dom0 and ``qrexec-client-vm`` is started with +*local_program* argument, it reports the local program exit code. There is no +way to learn exit code of remote service in this case. + +In both cases, if process (local or remote) was terminated by a signal, exit +status is 128+signal number. + +If service call is denied by dom0, ``qrexec-client-vm`` exit with status 126. + +AUTHORS +======= +| Joanna Rutkowska +| Rafal Wojtczuk +| Marek Marczykowski-Górecki +``` + +----- + +**Note:** The Markdown source of this page in [`qubes-doc`] was generated by running the [`update-manpages-4-0`] script on `qubes-core-agent-linux/doc/vm-tools/`. +If you wish to update the contents of this page as it appears on the Qubes OS website, please submit a pull request to change the appropriate file in `qubes-core-agent-linux/doc/vm-tools/`. +Do not attempt to change the Markdown source of this page in [`qubes-doc`] directly. +All direct changes to the Markdown file will be overwritten the next time this page is regenerated. + +[`qubes-doc`]: https://github.com/QubesOS/qubes-doc/ +[`update-manpages-4-0`]: https://github.com/QubesOS/qubesos.github.io/blob/master/_utils/update-manpages-4-0 + diff --git a/reference/tools/4.0/domU/qvm-copy-to-vm.md b/reference/tools/4.0/domU/qvm-copy-to-vm.md new file mode 100644 index 00000000..4b2a1380 --- /dev/null +++ b/reference/tools/4.0/domU/qvm-copy-to-vm.md @@ -0,0 +1,41 @@ +--- +layout: doc +title: qvm-copy-to-vm +permalink: /doc/tools/4.0/domU/qvm-copy-to-vm/ +--- + +``` +============== +qvm-copy-to-vm +============== + +NAME +==== +qvm-copy-to-vm - copy specified files to specified destination VM + +SYNOPSIS +======== +| qvm-copy-to-vm [--without-progress] dest_vmname file [file]+ + +OPTIONS +======= +--without-progress + Don't display progress info + +AUTHORS +======= +| Joanna Rutkowska +| Rafal Wojtczuk +| Marek Marczykowski +``` + +----- + +**Note:** The Markdown source of this page in [`qubes-doc`] was generated by running the [`update-manpages-4-0`] script on `qubes-core-agent-linux/doc/vm-tools/`. +If you wish to update the contents of this page as it appears on the Qubes OS website, please submit a pull request to change the appropriate file in `qubes-core-agent-linux/doc/vm-tools/`. +Do not attempt to change the Markdown source of this page in [`qubes-doc`] directly. +All direct changes to the Markdown file will be overwritten the next time this page is regenerated. + +[`qubes-doc`]: https://github.com/QubesOS/qubes-doc/ +[`update-manpages-4-0`]: https://github.com/QubesOS/qubesos.github.io/blob/master/_utils/update-manpages-4-0 + diff --git a/reference/tools/4.0/domU/qvm-open-in-dvm.md b/reference/tools/4.0/domU/qvm-open-in-dvm.md new file mode 100644 index 00000000..b7139bd0 --- /dev/null +++ b/reference/tools/4.0/domU/qvm-open-in-dvm.md @@ -0,0 +1,39 @@ +--- +layout: doc +title: qvm-open-in-dvm +permalink: /doc/tools/4.0/domU/qvm-open-in-dvm/ +--- + +``` +=============== +qvm-open-in-dvm +=============== + +NAME +==== +qvm-open-in-dvm - open a specified file in disposable VM + +SYNOPSIS +======== +| qvm-open-in-dvm filename + +OPTIONS +======= + +AUTHORS +======= +| Joanna Rutkowska +| Rafal Wojtczuk +| Marek Marczykowski +``` + +----- + +**Note:** The Markdown source of this page in [`qubes-doc`] was generated by running the [`update-manpages-4-0`] script on `qubes-core-agent-linux/doc/vm-tools/`. +If you wish to update the contents of this page as it appears on the Qubes OS website, please submit a pull request to change the appropriate file in `qubes-core-agent-linux/doc/vm-tools/`. +Do not attempt to change the Markdown source of this page in [`qubes-doc`] directly. +All direct changes to the Markdown file will be overwritten the next time this page is regenerated. + +[`qubes-doc`]: https://github.com/QubesOS/qubes-doc/ +[`update-manpages-4-0`]: https://github.com/QubesOS/qubesos.github.io/blob/master/_utils/update-manpages-4-0 + diff --git a/reference/tools/4.0/domU/qvm-open-in-vm.md b/reference/tools/4.0/domU/qvm-open-in-vm.md new file mode 100644 index 00000000..13aff79e --- /dev/null +++ b/reference/tools/4.0/domU/qvm-open-in-vm.md @@ -0,0 +1,39 @@ +--- +layout: doc +title: qvm-open-in-vm +permalink: /doc/tools/4.0/domU/qvm-open-in-vm/ +--- + +``` +============== +qvm-open-in-vm +============== + +NAME +==== +qvm-open-in-vm - open a specified file in other VM + +SYNOPSIS +======== +| qvm-open-in-vm vmname filename + +OPTIONS +======= + +AUTHORS +======= +| Joanna Rutkowska +| Rafal Wojtczuk +| Marek Marczykowski +``` + +----- + +**Note:** The Markdown source of this page in [`qubes-doc`] was generated by running the [`update-manpages-4-0`] script on `qubes-core-agent-linux/doc/vm-tools/`. +If you wish to update the contents of this page as it appears on the Qubes OS website, please submit a pull request to change the appropriate file in `qubes-core-agent-linux/doc/vm-tools/`. +Do not attempt to change the Markdown source of this page in [`qubes-doc`] directly. +All direct changes to the Markdown file will be overwritten the next time this page is regenerated. + +[`qubes-doc`]: https://github.com/QubesOS/qubes-doc/ +[`update-manpages-4-0`]: https://github.com/QubesOS/qubesos.github.io/blob/master/_utils/update-manpages-4-0 + diff --git a/reference/tools/4.0/domU/qvm-run-vm.md b/reference/tools/4.0/domU/qvm-run-vm.md new file mode 100644 index 00000000..8505a7b5 --- /dev/null +++ b/reference/tools/4.0/domU/qvm-run-vm.md @@ -0,0 +1,41 @@ +--- +layout: doc +title: qvm-run-vm +permalink: /doc/tools/4.0/domU/qvm-run-vm/ +--- + +``` +========== +qvm-run-vm +========== + +NAME +==== +qvm-run-vm - run a specified command in a specified VM + +SYNOPSIS +======== +| qvm-run-vm vmname command [aguments] + +OPTIONS +======= +--dispvm + Pass this option instead of vmname to start new DisposableVM + +AUTHORS +======= +| Joanna Rutkowska +| Rafal Wojtczuk +| Marek Marczykowski +``` + +----- + +**Note:** The Markdown source of this page in [`qubes-doc`] was generated by running the [`update-manpages-4-0`] script on `qubes-core-agent-linux/doc/vm-tools/`. +If you wish to update the contents of this page as it appears on the Qubes OS website, please submit a pull request to change the appropriate file in `qubes-core-agent-linux/doc/vm-tools/`. +Do not attempt to change the Markdown source of this page in [`qubes-doc`] directly. +All direct changes to the Markdown file will be overwritten the next time this page is regenerated. + +[`qubes-doc`]: https://github.com/QubesOS/qubes-doc/ +[`update-manpages-4-0`]: https://github.com/QubesOS/qubesos.github.io/blob/master/_utils/update-manpages-4-0 +