Update documentation.
This commit is contained in:
+48
-18
@@ -17,6 +17,8 @@ fenrir \- A modern, modular console screen reader for Linux
|
||||
.RB [ \-\-x11-window-id
|
||||
.IR WINDOWID ]
|
||||
.RB [ \-F ]
|
||||
.RB [ \-i
|
||||
.IR SCREEN ]
|
||||
|
||||
.SH DESCRIPTION
|
||||
Fenrir is a modern, modular, flexible and fast console screen reader written in Python 3.
|
||||
@@ -39,7 +41,7 @@ Run Fenrir in the foreground instead of as a daemon. Useful for debugging and te
|
||||
|
||||
.TP
|
||||
.BR \-s ", " \-\-setting " " \fISETTING-FILE\fR
|
||||
Path to a custom settings file. Default is /etc/fenrir/settings/settings.conf.
|
||||
Path to a custom settings file. Default is /etc/fenrirscreenreader/settings/settings.conf for root and ~/.local/share/stormux/fenrirscreenreader/settings/settings.conf for regular-user saves.
|
||||
|
||||
.TP
|
||||
.BR \-o ", " \-\-options " " \fISECTION#SETTING=VALUE;..\fR
|
||||
@@ -56,11 +58,19 @@ Print debug messages to screen in addition to logging them.
|
||||
|
||||
.TP
|
||||
.BR \-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.
|
||||
|
||||
.TP
|
||||
.BR \-i ", " \-I ", " \-\-ignore-screen " \fISCREEN\fR"
|
||||
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.
|
||||
|
||||
.TP
|
||||
.BR \-x ", " \-\-x11
|
||||
Run in X11 terminal mode using PTY screen monitoring and X11 keyboard input scoped to the terminal window.
|
||||
|
||||
.TP
|
||||
.BR \-\-x11-window-id " " \fIWINDOWID\fR
|
||||
Use a specific X11 terminal window id for X11 terminal mode.
|
||||
|
||||
.SH KEY CONCEPTS
|
||||
|
||||
@@ -179,12 +189,24 @@ Announce marked text
|
||||
.SS Settings File
|
||||
The main configuration file is located at:
|
||||
.IP \[bu] 2
|
||||
.B /etc/fenrir/settings/settings.conf
|
||||
.B /etc/fenrirscreenreader/settings/settings.conf
|
||||
(system-wide installation)
|
||||
.IP \[bu] 2
|
||||
.B ~/.local/share/stormux/fenrirscreenreader/settings/settings.conf
|
||||
(user-local settings)
|
||||
.IP \[bu] 2
|
||||
.B config/settings/settings.conf
|
||||
(development/git version)
|
||||
|
||||
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/.
|
||||
|
||||
.SS Key Sections
|
||||
.TP
|
||||
.B [speech]
|
||||
@@ -264,7 +286,7 @@ Override speech rate and sound volume settings.
|
||||
|
||||
.TP
|
||||
.B fenrir -F
|
||||
Force Fenrir to work on all screens, ignoring ignoreScreen settings.
|
||||
Force Fenrir to work on all screens, ignoring ignore_screen settings.
|
||||
|
||||
.TP
|
||||
.B fenrir -s /home/user/my-fenrir.conf
|
||||
@@ -275,14 +297,14 @@ Use a custom configuration file.
|
||||
Fenrir includes a powerful remote control system for automation and integration with external applications.
|
||||
|
||||
.SS Configuration
|
||||
Enable remote control in /etc/fenrir/settings/settings.conf:
|
||||
Enable remote control in /etc/fenrirscreenreader/settings/settings.conf or the user-local settings file:
|
||||
|
||||
.EX
|
||||
[remote]
|
||||
enable=True
|
||||
driver=unixDriver
|
||||
enableSettingsRemote=True
|
||||
enableCommandRemote=True
|
||||
enable_settings_remote=True
|
||||
enable_command_remote=True
|
||||
.EE
|
||||
|
||||
.SS Using socat with Unix Sockets
|
||||
@@ -323,13 +345,13 @@ echo "setting set focus#highlight=True" | socat - UNIX-CLIENT:/tmp/fenrirscreenr
|
||||
echo "setting set speech#rate=0.8" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
|
||||
# Change punctuation level (none/some/most/all)
|
||||
echo "setting set general#punctuationLevel=all" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
echo "setting set general#punctuation_level=all" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
|
||||
# Voice and TTS control
|
||||
echo "setting set speech#voice=en-us+f3" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
|
||||
# Multiple settings at once
|
||||
echo "setting set speech#rate=0.8;sound#volume=0.7;general#punctuationLevel=most" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
echo "setting set speech#rate=0.8;sound#volume=0.7;general#punctuation_level=most" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
|
||||
# Reset all settings
|
||||
echo "setting reset" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
@@ -387,7 +409,7 @@ command quitapplication - Quit Fenrir
|
||||
.TP
|
||||
.B Speech Control:
|
||||
.IP \[bu] 2
|
||||
general#punctuationLevel=none/some/most/all - Punctuation verbosity
|
||||
general#punctuation_level=none/some/most/all - Punctuation verbosity
|
||||
.IP \[bu] 2
|
||||
speech#rate=0.1-1.0 - Speech rate
|
||||
.IP \[bu] 2
|
||||
@@ -402,28 +424,32 @@ speech#module=module_name - TTS module
|
||||
.TP
|
||||
.B Screen Control:
|
||||
.IP \[bu] 2
|
||||
screen#ignoreScreen=1,2,3 - TTY screens to ignore
|
||||
screen#ignore_screen=1,2,3 - TTY screens to ignore
|
||||
.IP \[bu] 2
|
||||
focus#highlight=True/False - Follow text highlighting
|
||||
|
||||
.TP
|
||||
.B Input Control:
|
||||
.IP \[bu] 2
|
||||
keyboard#charEchoMode=0-2 - Character echo mode
|
||||
keyboard#char_echo_mode=0-2 - Character echo mode
|
||||
.IP \[bu] 2
|
||||
keyboard#wordEcho=True/False - Word echo
|
||||
keyboard#word_echo=True/False - Word echo
|
||||
|
||||
.SH FILES
|
||||
.TP
|
||||
.B /etc/fenrir/settings/settings.conf
|
||||
.B /etc/fenrirscreenreader/settings/settings.conf
|
||||
Main configuration file
|
||||
|
||||
.TP
|
||||
.B /etc/fenrir/keyboard/
|
||||
.B ~/.local/share/stormux/fenrirscreenreader/settings/settings.conf
|
||||
User-local configuration file
|
||||
|
||||
.TP
|
||||
.B /etc/fenrirscreenreader/keyboard/
|
||||
Keyboard layout definitions
|
||||
|
||||
.TP
|
||||
.B /etc/fenrir/punctuation/
|
||||
.B /etc/fenrirscreenreader/punctuation/
|
||||
Punctuation level definitions
|
||||
|
||||
.TP
|
||||
@@ -431,9 +457,13 @@ Punctuation level definitions
|
||||
System sound themes
|
||||
|
||||
.TP
|
||||
.B ~/.local/share/fenrirscreenreader/sounds/
|
||||
.B ~/.local/stormux/fenrir/sounds/
|
||||
User sound themes
|
||||
|
||||
.TP
|
||||
.B ~/.local/stormux/fenrir/
|
||||
User scripts
|
||||
|
||||
.TP
|
||||
.B /var/log/fenrir.log
|
||||
Debug log file
|
||||
|
||||
Reference in New Issue
Block a user