mirror of
https://github.com/feschber/lan-mouse.git
synced 2026-03-07 11:59:59 +03:00
Update README.md
This commit is contained in:
committed by
GitHub
parent
e3f9947284
commit
39acce8e6a
20
README.md
20
README.md
@@ -1,7 +1,14 @@
|
||||
# Lan Mouse
|
||||
- _Now with a gtk frontend_
|
||||
|
||||
<img src="https://github.com/ferdinandschober/lan-mouse/assets/40996949/ccb33815-4357-4c8d-a5d2-8897ab626a08" width=75%>
|
||||
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).
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
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 <host> 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/`.
|
||||
|
||||
Reference in New Issue
Block a user