RomanNum3ral
/
Solaar
mirror of https://github.com/pwr-Solaar/Solaar.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: state that the Solaar GUI should run continously

This commit is contained in:
Peter F. Patel-Schneider 2022-08-31 10:38:14 -04:00
parent f39aebb089
commit 8b3fb3cc23
2 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/index.md
View File

@ -4,8 +4,8 @@ layout: default
---
**Solaar** is a Linux manager for many Logitech keyboards, mice, and trackpads
that connect wirelessly to a USB [Unifying][unifying], Bolt, Lightspeed, or Nano receiver,
connect directly via a USB cable, or connect via Bluetooth.
that connect wirelessly to a USB [Unifying][unifying], Bolt, Lightspeed, or Nano receiver;
connect directly via a USB cable; or connect via Bluetooth.
Solaar does not work with peripherals from other companies.
Documentation here is for the current version of Solaar.
@ -13,8 +13,13 @@ Some Linux distributions distribute old versions of Solaar.
If you are using an old version and something described here does not work you should upgrade
using one of the methods described below.
Solaar can be used as a GUI application or via its command-line interface.
Both interfaces are able to list the connected devices and
Solaar can be used as a GUI application, the usual case, or via its command-line interface.
The Solaar GUI is meant to run continuously in the background,
monitoring devices, making changes to them, and responding to some messages they emit.
To this end, it is useful to have Solaar start at user login so that
changes made to devices by Solaar are applied at login and through out the user's session.
Both Solaar interfaces are able to list the connected devices and
show information about each device, often including battery status.
Solaar is able to pair and unpair devices with
receivers as supported by the device and receiver.

16
docs/usage.md
View File

@ -1,17 +1,20 @@
---
title: Solaar Usage
title: Solaar GUI Usage
layout: page
---
# Solaar usage
# Solaar GUI Usage
Under normal usage Solaar creates an icon in your system tray. This icon is
The Solaar GUI (the usual way to run Solaar) is meant to run continuously in the background,
monitoring devices, making changes to them, and responding to some messages they emit.
The Solaar GUI normally creates an icon in your system tray that provides an interface
to Solaar. This icon is
usually a battery icon showing the approximate battery level for your device
with the lowest known battery level. If there are no devices with battery information,
then the icon is one of the Solaar icons.
Solaar also has a main window. When the main window is invisible,
click on the icon in the system tray to bring up the menu, and then
click on Solaar's icon in the system tray to bring up the Solaar menu, and then
click on a receiver or device in the menu to see information about
that receiver or device.
@ -21,11 +24,12 @@ also be other battery icons or versions of the Logitech Unifying icon.
![Solaar-menu](Solaar-menu.png)
Clicking on “Quit” in the Solaar menu terminates the program, and “About Solaar” pops up a window with further information.
Clicking on “Quit” in the Solaar menu terminates the program.
Clicking on “About Solaar” pops up a window with further information about Solaar.
## Solaar options
There are several options that affect how Solaar behaves:
There are several options that affect how the Solaar GUI behaves:
* `--help` shows a help message and then quits
* `---window=show` starts Solaar with the main window showing