From 5bc91a4bcd74363e64c5152cee6696ba4f584f81 Mon Sep 17 00:00:00 2001 From: pierwill Date: Thu, 5 Dec 2019 22:13:15 -0800 Subject: [PATCH] Edit qrexec command line tools descriptions --- developer/services/qrexec-internals.md | 35 +++++++++++++++++--------- 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/developer/services/qrexec-internals.md b/developer/services/qrexec-internals.md index 4f69ef08..cc50fe2c 100644 --- a/developer/services/qrexec-internals.md +++ b/developer/services/qrexec-internals.md @@ -31,10 +31,14 @@ These tools are not designed to be used by users directly. `/usr/sbin/qrexec-daemon` One instance is required for every active domain. -Responsible for: - * Handling execution and service requests from **dom0** (source: `qrexec-client`). - * Handling service requests from the associated domain (source: `qrexec-client-vm`, then `qrexec-agent`). -* Command line: `qrexec-daemon domain-id domain-name [default user]` +`qrexex-daemon` is responsible for both: +- handling execution and service requests from **dom0** (source: `qrexec-client`); and +- handling service requests from the associated domain (source: `qrexec-client-vm`, then `qrexec-agent`). + +Command line usage: + +`qrexec-daemon domain-id domain-name [default user]` + * `domain-id`: Numeric Qubes ID assigned to the associated domain. * `domain-name`: Associated domain name. * `default user`: Optional. If passed, `qrexec-daemon` uses this user as default for all execution requests that don't specify one. @@ -50,12 +54,14 @@ Internal program used to evaluate the RPC policy and decide whether an RPC call `/usr/bin/qrexec-client` Used to pass execution and service requests to `qrexec-daemon`. -Command line parameters: - * `-d target-domain-name`: Specifies the target for the execution/service request. - * `-l local-program`: Optional. If present, `local-program` is executed and its stdout/stdin are used when sending/receiving data to/from the remote peer. - * `-e`: Optional. If present, stdout/stdin are not connected to the remote peer. Only process creation status code is received. - * `-c `: used for connecting a VM-VM service request by `qrexec-policy`. Details described below in the service example. - * `cmdline`: Command line to pass to `qrexec-daemon` as the execution/service request. Service request format is described below in the service example. + +Command line usage: + +* `-d target-domain-name`: Specifies the target for the execution/service request. +* `-l local-program`: Optional. If present, `local-program` is executed and its stdout/stdin are used when sending/receiving data to/from the remote peer. +* `-e`: Optional. If present, stdout/stdin are not connected to the remote peer. Only process creation status code is received. +* `-c `: used for connecting a VM-VM service request by `qrexec-policy`. Details described below in the service example. +* `cmdline`: Command line to pass to `qrexec-daemon` as the execution/service request. Service request format is described below in the service example. ## VM tools implementation @@ -67,7 +73,8 @@ One instance runs in each active domain. Responsible for: * Handling service requests from `qrexec-client-vm` and passing them to connected `qrexec-daemon` in dom0. * Executing associated `qrexec-daemon` execution/service requests. -* Command line parameters: none. + +The `qrexec-agent` command takes no paramaters. ### qrexec-client-vm @@ -75,7 +82,11 @@ Responsible for: Runs in an active domain. Used to pass service requests to `qrexec-agent`. -* Command line: `qrexec-client-vm target-domain-name service-name local-program [local program arguments]` + +Command line usage: + +`qrexec-client-vm target-domain-name service-name local-program [local program arguments]` + * `target-domain-name`: Target domain for the service request. Source is the current domain. * `service-name`: Requested service name. * `local-program`: `local-program` is executed locally and its stdin/stdout are connected to the remote service endpoint.