]> gitweb.fluxo.info Git - kvmx.git/commitdiff
Misc documentation updates
authorSilvio Rhatto <rhatto@riseup.net>
Sat, 24 Feb 2024 20:17:42 +0000 (17:17 -0300)
committerSilvio Rhatto <rhatto@riseup.net>
Sat, 24 Feb 2024 20:17:42 +0000 (17:17 -0300)
README.md

index 9acf2a7deeb2e3bf0cb153e19683f637523125b2..a4e2f4ae87125f1fbbd4af14dac27bb0abb575e8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-KVMX: vagrant-like QEMU KVM Wrapper
-===================================
+# KVMX: vagrant-like QEMU KVM Wrapper
 
 KVMX is a lightweight implementation of a virtual machine manager
 inspired by [vagrant](https://www.vagrantup.com/),
@@ -22,6 +21,7 @@ sources, you'll feel welcome here :)
 * Easily copy files or SSH into the guest.
 * Built-in shell.
 * GUI support via Spice, Xephyr, VNC and Xpra.
+* Safer clipboard sharing through the guest's SSH server.
 * Works both for desktop GUI virtualization, local development or at production servers.
 
 ## Dependencies
@@ -97,6 +97,21 @@ Then, if everything is fine, stop the guest and turn it on again, this time with
 
     kvmx up <project-name>
 
+## Clipboard
+
+Cliboard sharing is available by using a SSH server inside the guest:
+
+* Use `kvmx-clipboard` to send and receive content to and from guests.
+* `kvmx-spice-copy` and `kvmx-spice-paste` are handy wrappers to integrate with
+  your desktop environment.
+
+## Other features
+
+Check the other available commands with:
+
+    kvmx help
+
 ## References
 
-See [Virtualized GUI environments](https://blog.fluxo.info/suckless/virtual) for details.
+* The research which resulted in `kvmx` began in the [Virtualized GUI
+  environments](https://blog.fluxo.info/suckless/virtual) article.