storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/fenrir.adoc
+21 -14
View File
@@ -27,9 +27,12 @@ and voices provided by Speech Dispatcher. +
Keyboard shortcuts are bound to commands to read the screen, review it
and perform other actions like modify the settings on the fly, switch
languages, copy and paste text, provide miscellaneous information. +
=== Configuration file === The permanent settings are recorded in the
configuration file /etc/fenrirscreenreader/settings.conf, that is
heavily commented. +
=== Configuration file === The system-wide settings are recorded in the
configuration file /etc/fenrirscreenreader/settings/settings.conf, that is
heavily commented. Regular-user sessions, including `+fenrir -x+`, load
`+~/.local/share/stormux/fenrirscreenreader/settings/settings.conf+` when it
exists, otherwise they fall back to the system settings file. Saving settings
as a regular user creates or updates the user-local file. +
These settings are described in this user guide.
To start Fenrir once type as root:
@@ -1215,10 +1218,10 @@ Enable debug mode. Debug information will be logged.
Print debug messages to screen in addition to logging them.
`+-F, --force-all-screens+`::
Force Fenrir to respond on all screens, ignoring the ignoreScreen setting. This temporarily overrides screen filtering for the current session.
Force Fenrir to respond on all screens, ignoring the ignore_screen setting. This temporarily overrides screen filtering for the current session.
`+-i, -I, --ignore-screen <SCREEN>+`::
Ignore specific screen(s). Can be used multiple times to ignore multiple screens. This is equivalent to setting ignoreScreen in the configuration file and will be combined with any existing ignore settings.
Ignore specific screen(s). Can be used multiple times to ignore multiple screens. This is equivalent to setting ignore_screen in the configuration file and will be combined with any existing ignore settings.
==== Set settings options
@@ -1483,6 +1486,8 @@ By default we ship two sound packs.
. `+default-wav+` wav encoded, just for compatibility
Sound packs are located at /usr/share/sounds/fenrirscreenreader/
User sound packs in `+~/.local/stormux/fenrir/sounds/+` are loaded before
system sound packs.
Sound volume controls how loud the sounds for your selected sound pack
are.
@@ -1789,7 +1794,7 @@ keyboard_layout=desktop
....
Values: An absolute Path to a Keyboard definition file or a Filename
without extension located in `+/etc/fenrir/keyboard+`
without extension located in `+/etc/fenrirscreenreader/keyboard+`
Announce characters while typing.
@@ -1857,7 +1862,7 @@ the current punctuation and dict file in use:
punctuation_profile=default
....
Values: Text, see available profiles in `+/etc/fenrir/punctuation+` or
Values: Text, see available profiles in `+/etc/fenrirscreenreader/punctuation+` or
in `+sourceTree/config/punctuation+`
The current punctuation level in use:
@@ -1963,19 +1968,20 @@ Values: Text, see aspell dictionary's.
Folder Path for your scripts "scriptKey" functionality:
....
scriptPath=/usr/share/fenrirscreenreader/scripts
script_path=/usr/share/fenrirscreenreader/scripts
....
Values: Text, Existing path on file system.
Values: Text, Existing path on file system. User scripts in
`+~/.local/stormux/fenrir/+` are loaded before this configured path.
Override commands or create new ones without changing the Fenrir
defaults:
....
commandPath=/usr/share/fenrirscreenreader/commands
command_path=/usr/share/fenrirscreenreader/commands
....
Values: Text, Existing path on file system. Subfolders in commandPath
Values: Text, Existing path on file system. Subfolders in command_path
are:
* `+commands+` = to create shortcut commands
@@ -2111,14 +2117,15 @@ Values: on=`+True+`, off=`+False+`
=== Scripting
Scripts can be in any language, bash, python, sh or others. Place your
scripts in the directory /usr/share/fenrirscreenreader/scripts/ (the
path is configurable in settings.conf). The script key is the
personal scripts in `+~/.local/stormux/fenrir/+`, or place system scripts in
the directory /usr/share/fenrirscreenreader/scripts/ (the path is configurable
in settings.conf). The script key is the
applications key. Usually this key can be found on the keyboard located
just left of the right most control key. When you name a script, the key
name appears in the script seperated by the sequence [.underline]#-#.
So, for example, if you have a python weather script you want assigned
to the script key plus the letter w you would name the script
/usr/share/fenrirscreenreader/scripts/weather[.underline]##-##key_w.py
~/.local/stormux/fenrir/weather[.underline]##-##key_w.py
Then, to access the script, simply press the script key and the letter
w. Scripts must be executable. So, make sure to chmod 755 your script
when you place it in the scripts directory. The script gets some