docs: update docs - remembering settings, point to github docs

This commit is contained in:
Peter F. Patel-Schneider 2021-02-21 12:00:58 -05:00
parent babdb44b4f
commit 69df28c155
4 changed files with 22 additions and 11 deletions

View File

@ -8,17 +8,23 @@ layout: page
[**Solaar**][solaar] reports on and controls [Logitech][logitech] devices
(keyboards, mice, and trackballs) that connect to your computer via a
Logitech USB receiver (a very small piece of hardware that plugs into one of
your USB ports)
It is designed to detect all devices paired with your
receivers, and at the very least display some basic information about them.
your USB ports).
Solaar is designed to detect all connected devices,
and at the very least display some basic information about them.
At this moment, all [Unifying][unifying] receivers are supported (devices
with USB ID `046d:c52b` or `046d:c532`) as are several Lightspeed Receivers
and a dozen Nano receivers.
Solaar also reports on and controls some Logitech devices that connect to your
computer using a USB cable or via Bluetooth.
At this moment only a few devices types that connect via a USB cable or Bluetooth
are supported in Solaar as information needs to be added to Solaar for each device type.
Solaar also reports on and controls some Logitech devices that directly connect
to your computer using a USB cable or via Bluetooth.
Not all such devices supported in Solaar as information needs to be added to Solaar
for each device type that directly connects.
Most devices forget changed settings when the are turned off
or go into a power-saving mode.
Solaar keeps track of the settings that it has changed.
The Solaar GUI application notices when devices reconnect and
applies the remembered settings to the device.
## HID++

View File

@ -15,11 +15,14 @@ Solaar is able to pair and unpair devices with
receivers as supported by the device and receiver.
Solaar can also control some changeable features of devices,
such as smooth scrolling or function key behavior.
Solaar keeps track of these changed settings and the GUI application restores them whenever a device connects.
(Devices forget most settings when powered down.)
For more information on how to use Solaar see
[the usage page](https://pwr-solaar.github.io/Solaar/usage),
and for more information on its capabilities see
[the capabilities page](https://pwr-solaar.github.io/Solaar/capabilities).
Solaar's GUI normally uses an icon in the system tray and starts with its main window visible.
The GUI can be started in several ways

View File

@ -121,7 +121,7 @@ then `solaar <command> --help` to see the arguments to any of the commands.
## Solaar settings
Solaar supports the following settings:
Solaar supports at least the following settings:
Setting | Description
---------------------------------|------------
@ -147,8 +147,8 @@ Gestures | Turn on and off various (mostly touchpad) gestures
Gesture params | Modify parameters for gestures
HID++ events are mostly not processed by Linux input drivers.
Settings that involve sending HID++ events exist so that they can be
turned off under Linux.
Settings that involve sending HID++ events exist so that these events can be
processed by Solaar rules instead of by Linux.
Different Logitech devices may implement the same functionality in different ways,
thus the different settings that do the same thing.

View File

@ -54,7 +54,9 @@ battery_icons_style = 'regular'
def _parse_arguments():
import argparse
arg_parser = argparse.ArgumentParser(prog=NAME.lower())
arg_parser = argparse.ArgumentParser(
prog=NAME.lower(), epilog='For more information see https://pwr-solaar.github.io/Solaar'
)
arg_parser.add_argument(
'-d',
'--debug',