Update documentation.

This commit is contained in:
Storm Dragon
2026-05-12 22:34:30 -04:00
parent 116f254e11
commit 6876547590
6 changed files with 105 additions and 40 deletions
+21 -3
View File
@@ -123,9 +123,19 @@ Requires root privileges
sudo ./fenrir
Settings are located in:
- **After installation**: `/etc/fenrir/settings/settings.conf`
- **System-wide installation**: `/etc/fenrirscreenreader/settings/settings.conf`
- **User-local settings**: `~/.local/share/stormux/fenrirscreenreader/settings/settings.conf`
- **Development**: `config/settings/settings.conf`
When Fenrir runs as a regular user, including `fenrir -x`, it loads the
user-local settings file if it exists. If it does not exist, Fenrir falls back
to the system settings file, but saving settings writes to the user-local path.
When Fenrir runs as root, settings save to the system-wide path by default.
User sound themes are loaded before system themes from
`~/.local/stormux/fenrir/sounds/`. User scripts are loaded before configured
system scripts from `~/.local/stormux/fenrir/`.
By default Fenrir uses:
- **Sound driver**: genericDriver (via sox)
- **Speech driver**: speechdDriver (via speech-dispatcher)
@@ -217,7 +227,8 @@ Fenrir supports two main keyboard layouts:
- **Desktop Layout**: Uses numeric keypad for navigation (recommended for desktop users)
- **Laptop Layout**: Alternative bindings for keyboards without numeric keypad
Configure in `/etc/fenrir/settings/settings.conf`:
Configure in `/etc/fenrirscreenreader/settings/settings.conf` or your
user-local settings file:
```ini
[keyboard]
keyboard_layout=desktop # or 'laptop'
@@ -246,7 +257,8 @@ Fenrir includes a powerful remote control system that allows external applicatio
### Configuration
Enable remote control in `/etc/fenrir/settings/settings.conf`:
Enable remote control in `/etc/fenrirscreenreader/settings/settings.conf` or
your user-local settings file:
```ini
[remote]
@@ -758,6 +770,12 @@ By default, Fenrir targets the X11 window from `WINDOWID`, falling back to the a
X11 terminal mode uses the normal keyboard layout files, including desktop and laptop bindings. It supports Fenrir keys such as numpad Insert/`KEY_KP0`, CapsLock/`KEY_CAPSLOCK`, Insert/`KEY_INSERT`, and Super/Windows/`KEY_META`. Script keys such as Compose use `KEY_COMPOSE`.
In this mode Fenrir runs as a regular user. Settings are loaded from
`~/.local/share/stormux/fenrirscreenreader/settings/settings.conf` when present,
otherwise from `/etc/fenrirscreenreader/settings/settings.conf`; saving settings
creates or updates the user-local file. User sound themes and scripts are read
first from `~/.local/stormux/fenrir/sounds/` and `~/.local/stormux/fenrir/`.
This mode requires `python-xlib`.
For users who want a dedicated PTY/terminal screen reader instead of Fenrir's Linux console focus, see TDSR: https://github.com/tspivey/tdsr