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

docs: update installation instructions

This commit is contained in:
Peter F. Patel-Schneider 2022-11-19 16:03:51 -05:00
parent 49c7e5cc44
commit 17c30a22bb
1 changed files with 43 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
docs/installation.md
View File

@ -3,7 +3,18 @@ title: Manual Installation
layout: page layout: page
--- ---
# Manual installation # Installing from PyPI
An easy way to install the most recent release version of Solaar is from the PyPI repository.
First install pip, and then run
`pip install --user 'solaar[report-descriptor,git-commit]'`.
This will not install the Solaar udev rule, which you will need to copy from
`~/.local/share/solaar/udev-rules.d/42-logitech-unify-permissions.rules`
to `/etc/udev/rules.d` as root.
# Manual installation from GitHub
## Downloading ## Downloading
@ -11,8 +22,8 @@ Clone Solaar from GitHub by `git clone https://github.com/pwr-Solaar/Solaar.git`
## Requirements for Solaar ## Requirements for Solaar
Installing Solaar from a repository should have set up all these requirements If you have previously successfully installed a recent version of Solaar from a repository
so in this situation you should be able to skip this section. you should be able to skip this section.
Solaar needs a reasonably new kernel with kernel modules `hid-logitech-dj` Solaar needs a reasonably new kernel with kernel modules `hid-logitech-dj`
and `hid-logitech-hidpp` loaded. and `hid-logitech-hidpp` loaded.
@ -22,8 +33,7 @@ The `udev` package must be installed and its daemon running.
Solaar requires Python 3.7+ and requires several packages to be installed. Solaar requires Python 3.7+ and requires several packages to be installed.
If you are running the system version of Python you should have the If you are running the system version of Python you should have the
`python3-pyudev`, `python3-psutil`, `python3-xlib`, `python3-evdev`, `python3-pyudev`, `python3-psutil`, `python3-xlib`, `python3-evdev`, `python3-typing-extensions`,
`python3-typing-extensions`,
and `python3-yaml` or `python3-pyyaml` packages installed. and `python3-yaml` or `python3-pyyaml` packages installed.
To run the GUI Solaar also requires Gtk3 and its GObject introspection bindings. To run the GUI Solaar also requires Gtk3 and its GObject introspection bindings.
@ -38,21 +48,6 @@ Although the Solaar CLI does not require Gtk3,
and thus should tell the Solaar GUI to update its information about settings and thus should tell the Solaar GUI to update its information about settings
so it is a good idea to have Gtk3 available even for the Solaar CLI. so it is a good idea to have Gtk3 available even for the Solaar CLI.
If the `hid_parser` Python package is available, Solaar parses HID report descriptors
and can control more HID++ devices that do not use a receiver.
This package may not be available in some distributions but can be installed using pip
via `pip install --user hid-parser`.
If you are running a version of Python different from the system version,
you may need to use pip to install projects that provide the above Python packages.
Solaar runs best under X11 with the Xtest extension enabled so that Solaar rules can fake keyboard input using Xtest.
Solaar also uses the X11 library to access the XKB extension,
which requires installation of the X11 development package.
(In Fedora this is `libX11-devel`. In other distributions it may be `libX11-dev`.)
Solaar will run under Wayland but some parts of Solaar rules will not work.
For more information see [the rules page](https://pwr-solaar.github.io/Solaar/rules).
Solaar needs a library to interact with the system tray. Solaar needs a library to interact with the system tray.
The library that provides this interaction depends on the distribution and window system. The library that provides this interaction depends on the distribution and window system.
If ayatana appindicator is available then it is best to have this library installed, If ayatana appindicator is available then it is best to have this library installed,
@ -64,7 +59,27 @@ depending on distribution.
If desktop notifications bindings are also installed If desktop notifications bindings are also installed
(`gir1.2-notify-0.7` for Debian/Ubuntu), (`gir1.2-notify-0.7` for Debian/Ubuntu),
you will also see desktop notifications when devices come online/go offline. you will also see desktop notifications when devices come online and go offline.
If the `hid_parser` Python package is available, Solaar parses HID report descriptors
and can control more HID++ devices that do not use a receiver.
This package may not be available in some distributions but can be installed using pip
via `pip install --user hid-parser`.
If the `gitinfo` Python package is available, Solaar shows better information
about which version of Solaar is running.
This package may not be available in some distributions but can be installed using pip
via `pip install --user python-git-info`.
If you are running a version of Python different from the system version,
you may need to use pip to install projects that provide the above Python packages.
Solaar runs best under X11 with the Xtest extension enabled so that Solaar rules can fake keyboard input using Xtest.
Solaar also uses the X11 library to access the XKB extension,
which requires installation of the X11 development package.
(In Fedora this is `libX11-devel`. In other distributions it may be `libX11-dev`.)
Solaar will run under Wayland but some parts of Solaar rules will not work.
For more information see [the rules page](https://pwr-solaar.github.io/Solaar/rules).
### Installing Solaar's udev rule ### Installing Solaar's udev rule
@ -83,20 +98,22 @@ you will then need to either disconnect your receivers and
any USB-connected or Bluetooth-connected devices and any USB-connected or Bluetooth-connected devices and
re-connect them or reboot your computer. re-connect them or reboot your computer.
## Running from the Download Directories ## Running from the download directory
To run Solaar from the download directories, first install the Solaar udev rule if necessary. To run Solaar from the download directory, first install the Solaar udev rule if necessary.
Then cd to the solaar directory and run `bin/solaar` for the GUI Then cd to the solaar directory and run `bin/solaar` for the GUI
or `bin/solaar <command> <arguments>` for the CLI. or `bin/solaar <command> <arguments>` for the CLI.
Do not run Solaar as root, you may encounter problems with X11 integration and with the system tray. Do not run Solaar as root, you may encounter problems with X11 integration and with the system tray.
## Installing Solaar Using Pip ## Installing Solaar from the download directory using Pip
Python programs are usually installed using [pip][pip]. Python programs are usually installed using [pip][pip].
The pip instructions for Solaar are in `setup.py`, the standard place to put such instructions. The pip instructions for Solaar are in `setup.py`, the standard place to put such instructions.
To install Solaar for yourself only run `pip install --user .` from the solaar directory. To install Solaar for yourself only run
`pip install --user '.[report-descriptor,git-commit]'`.
from the download directory.
This tells pip to install into your `.local` directory, but does not install Solaar's udev rule. This tells pip to install into your `.local` directory, but does not install Solaar's udev rule.
(See above for installing the udev rule.) (See above for installing the udev rule.)
Once the udev rule has been installed you can then run Solaar as `~/.local/bin/solaar`. Once the udev rule has been installed you can then run Solaar as `~/.local/bin/solaar`.
@ -117,19 +134,10 @@ If you want to have Solaar's user messages in some other language you need to ru
`tools/po-compile.sh` to create the translation files before running or installing Solaar `tools/po-compile.sh` to create the translation files before running or installing Solaar
and set the LANGUAGE environment variable appropriately when running Solaar. and set the LANGUAGE environment variable appropriately when running Solaar.
## Running Solaar at Startup # Running Solaar at Startup
Distributions can cause Solaar can be run automatically at user login by installing a desktop file at Distributions can cause Solaar can be run automatically at user login by installing a desktop file at
`/etc/xdg/autostart/solaar.desktop`. An example of this file content can be seen in the repository at `/etc/xdg/autostart/solaar.desktop`. An example of this file content can be seen in the repository at
[share/autostart/solaar.desktop](https://github.com/pwr-Solaar/Solaar/blob/master/share/autostart/solaar.desktop). [share/autostart/solaar.desktop](https://github.com/pwr-Solaar/Solaar/blob/master/share/autostart/solaar.desktop).
If you install Solaar yourself you may need to create or modify this file or install a startup file under your home directory. If you install Solaar yourself you may need to create or modify this file or install a startup file under your home directory.
## Installing from PyPI
As an alternative to downloading and installing you can install the most recent release
(but not the current github version) of Solaar from PyPI.
Just run `pip install --user solaar`.
This will not install the Solaar udev rule, which you will need to copy from
`~/.local/share/solaar/udev-rules.d/42-logitech-unify-permissions.rules`
to `/etc/udev/rules.d` as root.