diff options
| author | Peter Maydell | 2020-11-12 15:40:40 +0100 |
|---|---|---|
| committer | Peter Maydell | 2020-11-23 12:10:04 +0100 |
| commit | 773ee3f1ea50eb996cced930cc29b1b27bfbc6fa (patch) | |
| tree | 2e5952023dd1b0ffdc4a1c4357beea9bd4a6ec15 /docs/system | |
| parent | docs: Move pr-manager.rst into the system manual (diff) | |
| download | qemu-773ee3f1ea50eb996cced930cc29b1b27bfbc6fa.tar.gz qemu-773ee3f1ea50eb996cced930cc29b1b27bfbc6fa.tar.xz qemu-773ee3f1ea50eb996cced930cc29b1b27bfbc6fa.zip | |
docs: Split qemu-pr-helper documentation into tools manual
Split the documentation of the qemu-pr-helper binary into the tools
manual, and give it a manpage like our other standalone executables.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Diffstat (limited to 'docs/system')
| -rw-r--r-- | docs/system/pr-manager.rst | 38 |
1 files changed, 5 insertions, 33 deletions
diff --git a/docs/system/pr-manager.rst b/docs/system/pr-manager.rst index 9b1de198b1..3f5b9f94dc 100644 --- a/docs/system/pr-manager.rst +++ b/docs/system/pr-manager.rst @@ -50,39 +50,11 @@ Alternatively, using ``-blockdev``:: -blockdev node-name=hd,driver=raw,file.driver=host_device,file.filename=/dev/sdb,file.pr-manager=helper0 -device scsi-block,drive=hd ----------------------------------- -Invoking :program:`qemu-pr-helper` ----------------------------------- - -QEMU provides an implementation of the persistent reservation helper, -called :program:`qemu-pr-helper`. The helper should be started as a -system service and supports the following option: - --d, --daemon run in the background --q, --quiet decrease verbosity --v, --verbose increase verbosity --f, --pidfile=path PID file when running as a daemon --k, --socket=path path to the socket --T, --trace=trace-opts tracing options - -By default, the socket and PID file are placed in the runtime state -directory, for example :file:`/var/run/qemu-pr-helper.sock` and -:file:`/var/run/qemu-pr-helper.pid`. The PID file is not created -unless :option:`-d` is passed too. - -:program:`qemu-pr-helper` can also use the systemd socket activation -protocol. In this case, the systemd socket unit should specify a -Unix stream socket, like this:: - - [Socket] - ListenStream=/var/run/qemu-pr-helper.sock - -After connecting to the socket, :program:`qemu-pr-helper`` can optionally drop -root privileges, except for those capabilities that are needed for -its operation. To do this, add the following options: - --u, --user=user user to drop privileges to --g, --group=group group to drop privileges to +You will also need to ensure that the helper program +:command:`qemu-pr-helper` is running, and that it has been +set up to use the same socket filename as your QEMU commandline +specifies. See the qemu-pr-helper documentation or manpage for +further details. --------------------------------------------- Multipath devices and persistent reservations |