aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-02-24 17:17:42 -0300
committerSilvio Rhatto <rhatto@riseup.net>2024-02-24 17:17:42 -0300
commitb9090f4aeaa28d20b616c190d96c2d636db6e830 (patch)
tree8c75a1205aac4e09fc66198e533dc9bf00a0b7fd /README.md
parenta1c79a077960e865aecdb698da41053a287cd55c (diff)
downloadkvmx-b9090f4aeaa28d20b616c190d96c2d636db6e830.tar.gz
kvmx-b9090f4aeaa28d20b616c190d96c2d636db6e830.tar.bz2
Misc documentation updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 18 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9acf2a7..a4e2f4a 100644
--- 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.