From 39acce8e6af447b07a4e9a8a972b9dce2e48e561 Mon Sep 17 00:00:00 2001 From: Ferdinand Schober Date: Sat, 9 Dec 2023 02:03:18 +0100 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index af5dff4..0f0c19b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # Lan Mouse - _Now with a gtk frontend_ - +Lan Mouse is a mouse and keyboard sharing software similar to universal-control on Apple devices. +It allows for using multiple pcs with a single set of mouse and keyboard. + +The primary target is Wayland on Linux but Windows and MacOS have partial support as well (see below for more details). + +![Screenshot from 2023-12-09 01-48-12](https://github.com/feschber/lan-mouse/assets/40996949/016a06a9-76db-4951-9dcc-127d012c59df#gh-dark-mode-only) +![Screenshot from 2023-12-09 01-48-19](https://github.com/feschber/lan-mouse/assets/40996949/d6318340-f811-4e16-9d6e-d1b79883c709#gh-light-mode-only) + Goal of this project is to be an open-source replacement for proprietary tools like [Synergy](https://symless.com/synergy), [Share Mouse](https://www.sharemouse.com/de/). @@ -65,11 +72,12 @@ enter the corresponding hostname and activate it. If the mouse can not be moved onto a device, make sure you have port `4242` (or the one selected) opened up in your firewall. +### Command Line Interface The cli interface can be enabled using `--frontend cli` as commandline arguments. Type `help` to list the available commands. E.g.: -``` +```sh $ cargo run --release -- --frontend cli (...) > connect left|right|top|bottom @@ -79,6 +87,14 @@ $ cargo run --release -- --frontend cli > activate 0 ``` +### Daemon +Lan Mouse can be launched in daemon mode to keep it running in the background. +To do so, add `--daemon` to the commandline args: + +```sh +$ cargo run --release -- --daemon +``` + ## Configuration To automatically load clients on startup, the file `$XDG_CONFIG_HOME/lan-mouse/config.toml` is parsed. `$XDG_CONFIG_HOME` defaults to `~/.config/`.