Fenrir is a modern command line screen reader written in Python3.
It has a modular structure, a flexible based driver model, is highly configurable and easy to customize and extend ([[fenrir_development_manual|see Developer Manual]]).
Please see the following pages for the [[fenrir_current_version|current]] and [[fenrir_git_version|Git]] version of Fenrir.
====== Support and Requirements ======
Fenrir requires several drivers to interact with the operating system.
A speech driver is for communication with the text to speech system like [[#SpeechDispatcher|Speech-Dispatcher]] or [[http://espeak.sourceforge.net|Espeak]]. \\
This invokes speech via a sub-process. This is almost the same as entering the command by commandline. The performance depends on the overhead of the speech synthesis application but it is really flexible.
Fenrir does not require installation. You can try it and make sure everything works before you decide to install. In this way you can be sure that your system doesnt break or stop talking.
for that you can just grab the code and run as root ''src/fenrir/fenrir'' (in foreground) or ''src/fenrir/fenrir-daemon'' (in background, that one is used by systemd for autostart)
* For an individual installation see [[#Support and Requirements|Support and Requirements]] or consult the [[https://github.com/chrys87/fenrir/blob/master/README.md|Readme]])
|FenrirKey + Shift + X|[[#Get text between marks|announce marked text]]|
^Linux specific ^
|<Unbound>|export clipboard to X|
|FenrirKey + CTRL + Up|increases Alsa volume|
|FenrirKey + CTRL + Down|decreases Alsa volume|
==== General ====
=== quit Fenrir ===
Just stops fenrir.
=== shut up ===
Interrupt the current spoken.
==== Review Modes ====
Fenrir provides a virtual cursor, with it you can navigate all over the screen without changing the text cursor.
Using the review feature will open the review mode automatically.
The review cursor always starts at the text cursor. Attention: after using the review mode, the review cursor will stay open until you use the ''exit review'' shortcut.
Think about that when using clipboard operations and similar. The review cursor is always prefered over the text cursor.
Fenrir can bell a sound if the used review command jumped to an other line or end the screen.
=== exit review ===
You can leave the review mode by pressing the ''exit review'' shortcut.
=== review bottom ===
Set the review cursor to first column in the last line.
=== review top ===
Set the review cursor to the first column in the first line
=== review current line ===
Set the review cursor to the beginn of the the current line and review it.
=== review previous line ===
Set the review cursor to the previous line and review it.
=== review next line ===
Set the review cursor to the next line and review it.
=== review line beginning ===
Set the review cursor to the begin of the current line
=== review line ending ===
Set the review cursor to the end of the current line
=== review line first character ===
Set the review cursor the first char (that is not space) in the current line and review it.
=== review line last character ===
Set the review cursor the last char (that is not space) in the current line and review it.
=== review current word ===
Sets the review cursor to the beginning of the current word and review it.
=== review previous word ===
Sets the review cursor to the beginning of the previous word and review it.
=== review next word ===
Sets the review cursor to the beginning of the next word and review it.
=== review current word phonetic ===
Sets the review cursor to the beginning of the current word and spell it phonetic.
=== review previous word phonetic ===
Sets the review cursor to the beginning of the previous word and spell it phonetic.
=== review next word phonetic ===
Sets the review cursor to the beginning of the next word and spell it phonetic.
=== review current character ===
Does not change the review cursor. Just announce the current char.
=== review previous character ===
Sets review cursor to the previous column and review it
=== review next character ===
Sets review cursor to the next column and review it
=== review current character phonetic ===
Does not change the review cursor. Just announce the current char phonetic.
=== review previous character phonetic ===
Sets review cursor to the previous column and announce the char phonetic.
=== review next character phonetic ===
Sets review cursor to the next column and announce the char phonetic.
=== review up ===
Set the review cursor in the same column one line above the current one and review it.
=== review down ===
Set the review cursor in the same column one line below the current one and review it.
==== Handling marking ====
A mark defines a point of origin or end to prepare to copy or paste a block of text.
\\
Examples where you need marks are:
* copy to clipboard
* set window application
* set bookmark 1 - X
=== Set mark ===
How to set an mark:
- navigate with review or textcursor to the position you want to set the mark. Attention: if a review cursor is set, that one is prefered. If you want to use text cursor, be sure that you are not in review mode.
- press shortcut for ''set mark''
you can set two marks (begin and end). Some commands allow some simpler usecases just using the whole line if only one mark is set. you may want to try this out.
=== Get text between marks ===
To get the text that is currently between your marks press shortcut for ''marked text''.\\
=== Remove Marks ===
You can remove all current marks by pressing the shortcut for ''remove marks''.
Changing the screen also removes the marks.
==== Screen Interaction ====
Fenrir provides several functionality to interact with the current screen.
=== forward keypress ===
This just forewarts the next shortcut to the screen whatever it is an Fenrir shortcut or not. This is useful if the currently pressed shortcut is also in use by Fenrir itself.
=== Clipboard ===
Fenrir provides an clipboard with multible slots, represented by an list. You navigate thought the list and paste the selected clipboard.
== copy marked to clipboard ==
To copy somthing to the clipboard you need to set one or two marks. if you set one mark, the text between the mark and your current cursor is copied to clipboard. Setting two marks just copies the text between the marks into the clipboard. If you copy something it is always placed as first element in your clipboard list.
== clear clipboard ==
You can remove all elements from the current clipboard list by ''clear clipboard'' functionalty.
== first clipboard ==
This moves quick to the first element of the clipboard list.
== last clipboard ==
This moves quick to the last element of the clipboard list.
== previous clipboard ==
Go to previous element in the clipboard list
== next clipboard ==
Go to next element in the clipboard list
== read current clipboard ==
Read the content of the current element of the clipboard list
== paste clipboard ==
Past whatever element is currently selected by first, last, prev or next clipboard commands.
if no special clipboard is selected the first one (last copied) is used.
Fenrir provides some shortcuts to change settings temporarily and on the fly without need to permanently change the ''settings.conf'' file.
=== toggle braille ===
Enables and disables Braille. This is not persistent stored in your ''settings.conf'' but during run time.
=== toggle sound ===
Enables and disables sound. This is not persistent stored in your ''settings.conf'' but during run time.
=== toggle speech ===
Enables and disables speech. This is not persistent stored in your ''settings.conf'' but during run time.
=== disable speech temporarily ===
Disables the speech until next key press. it might be useful if you want to listen to music or similar. As soon as an key is pressed it is going to be enabled again.
=== toggle punctuation level ===
Cycle between all available punctuation levels. This is not persistent stored in your ''settings.conf'' but during run time.
=== toggle auto spell check ===
Enables and disables automatic spellchecker (when typing). This is not persistent stored in your ''settings.conf'' but during run time.
=== toggle emoticons ===
Enables and disables emoticons. This is not persistent stored in your ''settings.conf'' but during runtime.
=== toggle output ===
Enables and disables all output at once (sound, braille, speech). This is not persistent stored in your ''settings.conf'' but during run time.
=== toggle auto read ===
Enables and disables that incoming is automatic spoken. This is not persistent stored in your ''settings.conf'' but during run time.
=== toggle auto time ===
Enables and disables auto time functionality. This is not persistent stored in your ''settings.conf'' but during run time.
=== toggle highlight tracking ===
Enables and disables highlight tracking. This is not persistent stored in your ''settings.conf'' but during run time.
=== increase speech volume ===
Increase the volume of the speech. This is not persistent stored in your ''settings.conf'' but during runtime.
=== decrease speech volume ===
Decrease the volume of the speech. This is not persistent stored in your ''settings.conf'' but during runtime.
=== increase speech rate ===
Increase the rate of the speech. This is not persistent stored in your ''settings.conf'' but during runtime.
=== decrease speech rate ===
Decrease the rate of the speech. This is not persistent stored in your ''settings.conf'' but during runtime.
=== increase speech pitch ===
Increase the pitch of the speech. This is not persistent stored in your ''settings.conf'' but during runtime.
=== decrease speech pitch ===
Decrease the pitch of the speech. This is not persistent stored in your ''settings.conf'' but during runtime.
=== increase sound volume ===
Increase the volume of the sound. This is not persistent stored in your ''settings.conf'' but during runtime.
=== decrease sound volume ===
Decrease the volume of the sound. This is not persistent stored in your ''settings.conf'' but during runtime.
==== Window Mode ====
Fenrir supports window mode, a window is a partial area of the screen.
=== Create Window ===
To create a window you need to do the following:
- set a beginning mark (as the start of the window)
- set an end mark (where the window should end)
- press ''set window application'' shortcut.
Now Fenrir ignores anything outside of the window.\\
=== Remove Window ===
You can remove the window by pressing ''the clear window application'' shortcut.
Now Fenrir will read everything on the screen again.
==== Tracking Modes ====
Different types of tracking are currently supported
See section [[#Focus|Focus]] in ''settings.conf'' for more information.
=== Cursor Tracking ===
This follows the text cursor. This is the typical way an application works. This is used by:
* almost any shell such as (Bash, Zsh, sh)
* vim
* nano
* emacs
* mutt
* tintin++
=== Highlight Tracking ===
In some applications there are no text cursors. In those applications cursor changes are represented by different colors or attributes (underlined or bold). This mode tracks and announce this changes for you. This is used by:
* wifi-menu
* dialog
* alpine
==== Tutorial Mode ====
Fenrir provides a Tutorial mode.
When you enter tutorial mode, sscreen reader commands are intercepted and explained instead of executing them.
==== Information ====
=== Time ===
Announces the current Time.
=== Date ===
Announces the current Date.
=== Bookmarks ===
Bookmarks provide quick access to part of the screen without the need to navigate to that area.
By default Fenrir provides 10 bookmarks. Those can be set and accessed via shortcut.
This is useful for status lines or other information that the position does not change.
== set Bookmark X ==
You need to set the bookmark first. For that you have to set one or two lines for use.
- Set marks (one or two)
- press shortcut for ''set bookmark X''. X represents the number 1 - 10.
== read Bookmark X ==
If a bookmark is set you can access the area just by pressing the ''bookmark X'' shortcut. X represents the number 1 - 10. Bookmarks are dynamic. That means the content changes with the screen.
== clear Bookmark X ==
to remove a bookmark just press the ''clear bookmark X'' shortcut. X represents the number 1 - 10.
Afterward the bookmark is no longer available.
=== cursor position ===
You can get information about the current cursor and its position by using the "cursor position" functionality.
=== indent current line ===
Announce the current indention level of the current line. It represents the number of trailing spaces of the line.
=== current screen ===
Reads all the current screen from the beginning to the end.
=== current screen before cursor ===
Reads current screen from the beginning of the screen to the current cursor position.
=== current screen after cursor ===
Read anything after current cursor postion to the end.
=== cursor read to end of line ===
Read from the current cursor position to the end of the current line.
=== cursor column ===
Read the current X postion of an cursor (column of the current line).
=== cursor line number ===
Read the current Y postion of an cursor (line number).
=== present first line ===
Reads just the first line. this is maybe useful for status information.
=== present last line ===
Presets the last line. This is maybe useful for status information.
=== last incoming ===
Repeat the last automatical inomming text.
===== Input =====
==== Echo ====
Fenrir provides different methods of echoing content:
* Word: Will speak each word after you push space
* Character: speak any letter you type on the screen
* Delete Character: speaks the character prior to the cursor when you push backspace
==== Silence on Key press ====
==== Spellchecker ====
Fenrir has a build-in spellchecker, it can invoke automatically while typing or be called by a shortcut.
Commands to add or remove the current word to the dictionary are included.
As using the spellchecker is enhanced usage. You will need dictionary aspell-<language>.
See section [[#General|General]] in ''settings.conf'' for more information.
=== spell check ===
Invokes the spellcheck on the word that contains the Review or text cursor.
=== add word to spell check ===
Adds the word under the Review or Text cursor to the dictionary.
=== removes word from spell check ===
Removes the word under the Review or Text cursor from the dictionary.
===== Announcements =====
==== Emoticons ====
If you want to replace ":)" emoticons with "smile" in speech you can use this feature.
It can be toggled on or off.
You can define emoticons in an dictionary, please see Emoticon Dictionary.
See section [[#General|General]] in ''settings.conf'' to see how to enable or disable this feature.
==== Time ====
Announce the time in an periodic way. So you can track the time more easy.
You can define 2 different ways of time announcements.
- periodic
- on fix minutes
Example periodic, every 20 minutes "delaySec=20":
[time]
enabled=True
presentTime=True
presentDate=True
delaySec=20
onMinutes=
announce=True
interrupt=False
Example on fix minutes in an hour. example every quarter "delaySec=0" and "onMinutes=00,15,30,45":
[time]
enabled=True
presentTime=True
presentDate=True
#delaySec is repected bevore onMinutes so it need to be set to 0
delaySec=0
onMinutes=00,15,30,45
announce=True
interrupt=False
==== Promoted List ====
Promoted Lists are a nice feature if you are away from your computer or doing more longer tasks.
you can define a list of words for that you want to hear a sound icon after an period of inactivity.
Example if the word "chrys" appears after 120 Seconds of inactivity:
[promote]
enabled=True
inactiveTimeoutSec=120
list=chrys
See section [[#Promote|Promote]] in ''settings.conf'' for more information.
==== Punctuation ====
Fenrir handles punctuation levels and names for you.
For that job it provides several dicts
See levelDict
See punctuationDict
===== Braille =====
Fenrir provides Braille support in Version >= 2.0.
See section [[#Braille|Braille]] in ''settings.conf'' for more information.
==== braille flush ====
If an message appers on the Braille device you can flush it to got back to the review- or system cursor
==== braille pan left ====
If an line is more longer than your braille device is you can move the view (called panning) to the left.
So you can read stuff without need to move the review- or system cursor.
==== braille pan right ====
If an line is more longer than your braille device is you can move the view (called panning) to the right.
So you can read stuff without need to move the review- or system cursor.
==== braille return to cursor ====
If you finished with reading the line on its braille device using panning, the focus can be returned to the current used cursor by using "return to cursor" command.
===== Dictionary =====
You can make use of different kinds of build-in dictionary's.
A dictionary has a name and list of keys and values separated by :===:
Example:
[customDict]
chrys:===:Chrys is cool
lollipop:===:lolli
that means that every instance "chrys" is displayed, speech will say Chrys is cool.
"lollipop" is spoken as "lolli".
Before making changes to a dictionary we recommend making a backup of your current dictionary in case future updates overwrite your local changes.
==== Punctuation ====
=== Level ===
The punctuation level dict contains lists with "what punctuation is spoken in what level".
the default one looks like this:
[levelDict]
none:===:
some:===:.-$~+*-/\@
most:===:.,:-$~+*-/\@!#%^&*()[]}{<>;
all:===:!"#$%& \'()*+,-./:;<=>?@[\\]^_`{|}~
the level "none" has no values. so it should not speak any punctuation (sadly this is not respected by every TTS system)
if "some" is the current level the following are spoken: dot dash dollar tilde plus star slash backslash at.
same for most and all. you can add new levels. if you cycle punctuation levels those are recognized. the default punctuation level is set in settings.conf. default is "some".
=== Punctuation ===
The punctuation dictionary "[punctDict]" contains how the punctuation is spoken.
Example:
[punctDict]
_:===:line
speaks an _ as "line".
[punctDict]
_:===:underscore
speaks an _ as underscore.
for question mark an ? is appended to the word that the TTS system can announce the question correctly.
The dict "[customDict]" is just for your own use, it just replace the key with the value without any special functionality. This might be used to fix incorrectly spoken words, make words more common, shorter or just for fun. :)
The Emoticons dictionary "[emoticonDict]" by default contains some emoticons. it can replace ":)" with "smile" or "XD" with "loool" Making chat more colorful.
A nice feature with this dictionary is that you can toggle the substitution on or off during run time or in settings.conf. This is useful because while doing programming or other serious work you want to hear colons and parans not smiles.
genericFrequencyCommand=play -q -v fenrirVolume -n -c1 synth fenrirDuration sine fenrirFrequence
==== Speech ====
The speech is configured in section ''[speech]''.
Turn speech on or off:
enabled=True
Values: on=''True'', off=''False''
# Select speech driver, options are speechdDriver (default), genericDriver or espeakDriver:
driver=speechdDriver
#driver=espeakDriver
#driver=genericDriver
Select the driver used to generate speech output.
driver=speechdDriver
Available Drivers:
* ''genericDriver'' using the generic driver, for Fenrir <1.5 this is not available
* ''speechdDriver'' using speech-dispatcher, for Fenrir <1.5 just use ''speechd''
* ''espeakDriver'' using the espeak directly, for Fenrir <1.5 just use ''espeak''
The rate selects how fast Fenrir will speak.
rate=0.65
Values: Range Minimum:''0.0'' is slowest, Maximum:''1.0'' is fastest.
Pitch controls the pitch of the voice.
pitch=0.5
Values: Range Minimum:''0.0'' is lowest, Maximum:''1.0'' is highest.
A Pitch for capital letters can be set.
capitalPitch=0.9
Values: Range Minimum:''0.0'' is lowest, Maximum:''1.0'' is highest.
The Volume controls the loudness of the voice.
volume=1.0
Values: Range Minimum:''0.0'' is quietest, Maximum:''1.0'' is loudest.
Some speech drivers like speechdDriver can support various modules. these can be set here.
module=espeak
Values: Text, Consult speech-dispatcher's configuration to see what modules are available.
Voice selects the varient you want to use, for example, f5 will use the female voice #5 in Espeak,
or if using the Espeak module in Speech-dispatcher. To find out which voices are available, consult the documentation provided with your selected synthesizer.
voice=
Values: Text, see your TTS synths documentation what is available.
Select the language you want Fenrir to use.
language=english-us
Values: Text, see your TTS synths documentation what is available.
Read new text as it occurs
autoReadIncoming=True
Values: on=''True'', off=''False''
=== Generic Driver ===
The generic speech driver uses shell commands for speech synthisus.
''genericSpeechCommand'' defines the command that is executed for creating speech
The following variables are substituted in ''genericSpeechCommand'':
* ''FenrirText'' = is the text that should be spoken
* ''fenrirModule'' = may be the speech module like used in speech-dispatcher, not every TTY needs this
* ''fenrirLanguage'' = the language to speak in
* ''fenrirVoice'' = is the current voice that should be used
* ''fenrirVolume'' = is replaced with the current volume
* ''fenrirPitch'' = is replaced with the current pitch
* ''fenrirRate'' = is replaced with the current speed (speech rate)
Example genericSpeechCommand (default):
genericSpeechCommand=espeak -a fenrirVolume -s fenrirRate -p fenrirPitch -v fenrirVoice "fenrirText"
Those are the minimum and maximum values of the TTS system that is used in genericSpeechCommand. They are needed to calculate the abstract range in volume, rate and pitch 0.0 - 1.0.
FenrirMinVolume=0
fenrirMaxVolume=200
fenrirMinPitch=0
fenrirMaxPitch=99
fenrirMinRate=80
fenrirMaxRate=450
The current volume, pitch and rate is calculated like this
value = min + [volume,pitch,rate] * (min - max )
==== Braille ====
Braille is a WIP and not ready yet.
Braille support can be configured in section ''[braille]''.
Turn braille on or off:
enabled=False
Values: on=''True'', off=''False''
Select the driver used for communication with an braille device.
driver=brlapiDriver
Values: Text, available Driver
Available Drivers:
* ''brlttyDriver'' using brltty for braille communication, for Fenrir <1.5 just use ''brltty''
The braille layout can be configured here
layout=en
Values: Text, see braille driver for layouts.
To what should the flush timeout relate to
flushMode=word
Values: Text, an flushMode
Existing flushModes:
* ''word'' = flush after (number of words to display) * seconds
* ''char'' = flush after (number of chars to display) * seconds
* ''fix'' = flush after X seconds
* ''none'' = no automatic flush (manual via shortcut)
Seconds to flush (see flushMode)
flushTimeout=3
Values: Integer, in Seconds or ''-1'' = no automatic flush (manual via shortcut)
The total flush time calculates in relation to flushMode.
How should the braille cursor focused be tracked?
cursorFocusMode=page
Values: Text, an existing cursor focus mode
Available cursor focus modes:
* ''page'' = if cursor cross the border move to next page and start at begin
* ''fixCell'' = ajust the cursor on an special cell where it is always placed. the display scroll here more smooth.
Define the cell on the Braille device where Fenrir should scroll and keep the cursor
fixCursorOnCell=-1
Values: Integer
* ''0'' = first cell on device,
* ''-1'' = last cell on device
* ''>0'' = fix cell number
What cursor should fenrir show on braille device
cursorFollowMode=review
Values: Text, an exsiting cursor following mode.
Existing cursor following mode:
* ''none'' = no automatic toggle command used
* ''review'' = priority to review
* ''last'' = follow last used cursor
number of cells in panning (horizontal). How many cell should be panned on press the routing key?
If you want Fenrir to not be active on any screen for various reasons. Maybe an X server or Wayland is running on that screen. You can make Fenrir ignore it or multiple screens seperated by '','' with:
Scripts can be in any language, bash, python, sh or others. Place your scripts in the directory /usr/share/fenrir/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 __-__. 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/fenrir/scripts/weather__-__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.
Commands are python files with a special scheme. You can assign them to a shortcut using the filename without an extension or place them in a hook trigger like OnInput or OnScreenChange. For further information see developer guide.
Good Examples: [[https://github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/date.py|"date.py"]] (announce the Date), [[https://github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/shut_up.py|"shut_up.py"]] (interrupt output)
- make sure that fenrir has permission to /dev/input/* and /dev/uinput (or run it as root)
===== you get no sound at all =====
- Run the script to configure pulseaudio once as root and once as your user. This will setup pulseaudio but require a restart of pulseaudio. The script is located in ''tools/configure_pulse.sh''
