From ebace165fb180e60ae0f00b84d333dadf21df612 Mon Sep 17 00:00:00 2001 From: Mr Keuz Date: Wed, 13 Apr 2022 00:16:49 +0300 Subject: [PATCH 1/2] Add command line option section --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 9cd73c2..2443953 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,32 @@ Supports Flatpak's RemoteDesktop portal (for Wayland), Windows and X11. * Portal & X11: `go install -tags portal,x11 github.com/unrud/remote-touchpad@latest` * Windows: `go install github.com/unrud/remote-touchpad@latest` +## Command line options + + $ remote-touchpad --help + + Usage of remote-touchpad: + -bind string + bind server to [HOSTNAME]:PORT (default ":0") + -cert string + file containing TLS certificate + -key string + file containing TLS private key + -mouse-move-speed float + mouse move speed multiplier (default 1) + -mouse-scroll-speed float + mouse scroll speed multiplier (default 1) + -move-speed float + move speed multiplier (default 1) + -scroll-speed float + scroll speed multiplier (default 1) + -secret string + shared secret for client authentication + -update-rate uint + number of updates per second (default 30) + -version + show program's version number and exit + ## Screenshots ![screenshot 1](https://raw.githubusercontent.com/Unrud/remote-touchpad/master/screenshots/1.png) From 7f332f170fe10801f9aa31d3155093f8bb07f645 Mon Sep 17 00:00:00 2001 From: Mr Keuz Date: Thu, 1 Sep 2022 05:29:07 +0300 Subject: [PATCH 2/2] Remove exactly values of cli options Remove exactly values of CLI options for avoid possible inconsistency (or missingoptions) during releases --- README.md | 25 ++----------------------- 1 file changed, 2 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 2443953..dcb5cde 100644 --- a/README.md +++ b/README.md @@ -16,31 +16,10 @@ Supports Flatpak's RemoteDesktop portal (for Wayland), Windows and X11. * Windows: `go install github.com/unrud/remote-touchpad@latest` ## Command line options - + + # For see command line option (sensitive, static QR-code and secrets, ecetra) $ remote-touchpad --help - Usage of remote-touchpad: - -bind string - bind server to [HOSTNAME]:PORT (default ":0") - -cert string - file containing TLS certificate - -key string - file containing TLS private key - -mouse-move-speed float - mouse move speed multiplier (default 1) - -mouse-scroll-speed float - mouse scroll speed multiplier (default 1) - -move-speed float - move speed multiplier (default 1) - -scroll-speed float - scroll speed multiplier (default 1) - -secret string - shared secret for client authentication - -update-rate uint - number of updates per second (default 30) - -version - show program's version number and exit - ## Screenshots ![screenshot 1](https://raw.githubusercontent.com/Unrud/remote-touchpad/master/screenshots/1.png)