[pve-devel] [PATCH docs 1/3] add spice enhancements documentation

[Thomas Lamprecht]

On 10/4/19 12:09 PM, Aaron Lauterer wrote:
> Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
> ---
>  qm.adoc | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 56 insertions(+)
> 
> diff --git a/qm.adoc b/qm.adoc
> index 0a1dfa6..583a248 100644
> --- a/qm.adoc
> +++ b/qm.adoc
> @@ -819,6 +819,62 @@ start after those where the parameter is set. Further, this parameter can only
>  be enforced between virtual machines running on the same host, not
>  cluster-wide.
>  
> +[[qm_spice_enhancements]]
> +Spice Enhancements
> +~~~~~~~~~~~~~~~~~~
> +

this just starts out of the blue, some introduction would be nice hear, else
I've no idea what this is all about, in general.

> +The Spice enhancements can be enabled in the options of a virtual machine. Run

.. in the webinterface options ...
To be more clear that the webinterface is meant here? (not sure though)

> +the following command to enable them via the CLI:
> +

The rest of the docs and all sites somewhat related to the project use the
all-caps SPICE spelling, so it would be nice if you keep that consistent and
not introduce mixed spelling now..

> +----
> +qm set <vmid> -spice_enhancements foldersharing=1,videostreaming=all
> +----
> +
> +Folder sharing
> +^^^^^^^^^^^^^^
> +
> +Share a local folder with the guest. The `spice-webdavd` daemon needs to be
> +installed in the guest. It makes the shared folder available through a local
> +WebDAV server located at http://localhost:9843 in the guest.
> +
> +For Windows guests the installer for the 'Spice WebDAV daemon' can be downloaded
> +from the
> +https://www.spice-space.org/download.html#windows-binaries[official Spice website].
> +
> +Most Linux distributions have a package called `spice-webdavd` that can be
> +installed.
> +
> +To share a folder in Virt-Viewer (Remote Viewer) go to 'File -> Preferences'.
> +Select the folder to share and then enable the checkbox.
> +
> +NOTE: Folder sharing currently only works in the Linux version of Virt-Viewer.
> +
> +Video Streaming
> +^^^^^^^^^^^^^^^
> +
> +Fast refreshing areas are encoded into a video stream. Two options exist:
> +
> +* *all*: Any fast refreshing window can be encoded into a video stream.

can or is?

> +* *filter*: Filters more if video streaming should be activated (currently only
> +  skips small windows surfaces).

isn't it activated once I set this to filter?

> +
> +A general recommendation if it should be enabled and which option to choose
> +cannot be given. Your mileage may vary depending on the specific circumstances.

Above first sentence is maybe a bit complicated, could be improved by
s/it/video streaming/.

> +
> +Troubleshooting
> +^^^^^^^^^^^^^^^
> +
> +Shared folder does not show up
> +++++++++++++++++++++++++++++++
> +
> +Make sure the WebDAV service is enabled and running in the guest. On Windows it
> +is called 'Spice webdav proxy'. In Linux the name is 'spice-webdavd' but can be
> +different depending on the distribution.
> +
> +If the service is running, check the WebDAV server by opening
> +http://localhost:9843 in a browser in the guest.
> +
> +It can help to restart the Spice connection.
>  
>  [[qm_migration]]
>  Migration
>