diff --git a/CREDITS b/CREDITS index 1f5a4359..1f889316 100644 --- a/CREDITS +++ b/CREDITS @@ -1,18 +1,30 @@ -# Fenrir screen reader +# Fenrir Screen Reader Credits -## Developers +## Current Maintainer -* Storm Dragon: Project leader -* Jeremiah: Coder. +* **Storm Dragon** - Project leader and maintainer + + +## Current Contributors + +* **Jeremiah** - Developer ## Previous Developers -* Chrys: coder. +* **Chrys** - Original creator and main developer -## Special thanks to: +## Special Thanks -* F123 Consulting for suggestions, some funding, and endless testing. -* Stormux for continuation of the project. +* **F123 Consulting** - Suggestions, funding, and extensive testing +* **Stormux Community** - Continuation of the project and ongoing support +* **All contributors** - Bug reports, feature requests, and community support + + +## Community + +* IRC: irc.stormux.org #stormux +* Email list: stormux+subscribe@groups.io +* Wiki: https://git.stormux.org/storm/fenrir/wiki diff --git a/README.md b/README.md index 550cf132..7a809d23 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,97 @@ # Fenrir -A modern, modular, flexible and fast console screenreader. +A modern, modular, flexible and fast console screen reader. It should run on any operating system. If you want to help, or write drivers to make it work on other systems, just let me know. This software is licensed under the LGPL v3. +**Current maintainer:** Storm Dragon +**Previous developer:** Chrys + +## Key Features + +- **Multiple Interface Support**: Works in Linux TTY, and terminal emulators +- **Flexible Driver System**: Modular architecture with multiple drivers for speech, sound, input, and screen +- **Review Mode**: Navigate and review screen content without moving the edit cursor +- **Multiple Clipboard Support**: Manage multiple clipboard entries +- **Configurable Key Bindings**: Desktop and laptop keyboard layouts +- **Sound Icons**: Audio feedback for various events +- **Spell Checking**: Built-in spell checker with word management +- **Language Support**: Multiple speech synthesis languages and voices +- **Bookmark System**: Quick access to specific screen areas +- **Auto-announcement**: Automatic reading of incoming text and time announcements +- **Tutorial Mode**: Built-in help system for learning keyboard shortcuts + ## OS Requirements -- Linux (ptyDriver, vcsaDriver, evdevDriver) -- macOS (ptyDriver) -- BSD (ptyDriver) -- Windows (ptyDriver) +- Linux (ptyDriver, vcsaDriver, evdevDriver) - Primary platform with full support +- macOS (ptyDriver) - Limited support +- BSD (ptyDriver) - Limited support +- Windows (ptyDriver) - Limited support ## Core Requirements -- python3 >= 3.3 -- screen, input, speech, sound drivers dependencies see "Features, Drivers, Extras". +- Python 3 >= 3.9 (recommended 3.13+) +- Screen, input, speech, sound driver dependencies (see "Features, Drivers, Extras" section) +- For full functionality on Linux: evdev, speech-dispatcher, sox ## Features, Drivers, Extras, Dependencies ### Input Drivers: -1. "evdevDriver" input driver for linux evdev - - python-evdev >=0.6.3 (This is commonly referred to as python3-evdev by your distribution) - - python-pyudev - - loaded uinput kernel module - - ReadWrite permission - - /dev/input - - /dev/uinput -2. "ptyDriver" terminal emulation input driver - - python-pyte +1. **evdevDriver** - Linux evdev input driver (recommended for Linux) + - python-evdev >=0.6.3 (This is commonly referred to as python3-evdev by your distribution) + - python-pyudev + - loaded uinput kernel module + - ReadWrite permission: + - /dev/input + - /dev/uinput +2. **ptyDriver** - Terminal emulation input driver (cross-platform) + - python-pyte +3. **atspiDriver** - AT-SPI input driver for desktop environments + - python-pyatspi2 + +### Remote Drivers: +1. **unixDriver** - Unix socket remote control (default) + - socat (for command-line interaction) +2. **tcpDriver** - TCP socket remote control (localhost only) + - netcat or telnet (for command-line interaction) ### Screen Drivers: -1. "vcsaDriver" screen driver for linux VCSA devices - - python-dbus - - Read permission to the following files and services: - - /sys/devices/virtual/tty/tty0/active - - /dev/tty[1-64] - - /dev/vcsa[1-64] - - read logind DBUS -2. "ptyDriver" terminal emulation driver - - python-pyte +1. **vcsaDriver** - Linux VCSA devices driver (recommended for Linux TTY) + - python-dbus + - Read permission to the following files and services: + - /sys/devices/virtual/tty/tty0/active + - /dev/tty[1-64] + - /dev/vcsa[1-64] + - read logind DBUS +2. **ptyDriver** - Terminal emulation driver (cross-platform) + - python-pyte ### Speech Drivers: -1. "genericDriver" (default) speech driver for sound as subprocess: - - espeak or espeak-ng -2. "speechdDriver" speech driver for Speech-dispatcher: - - Speech-dispatcher - - python-speechd -3. "emacspeakDriver" speech driver for emacspeak - - emacspeak +1. **speechdDriver** - Speech-dispatcher driver (recommended) + - Speech-dispatcher + - python-speechd +2. **genericDriver** - Generic subprocess speech driver + - espeak or espeak-ng (or any TTS command) +3. **debugDriver** - Debug speech driver for testing + - No dependencies ### Sound Drivers: -1. "genericDriver" (default) sound driver for sound as subprocess: - - Sox -2. "gstreamerDriver" sound driver for gstreamer - - gstreamer >=1.0 - - GLib +1. **genericDriver** (default) - Generic subprocess sound driver + - Sox with opus support (recommended) +2. **gstreamerDriver** - GStreamer sound driver + - gstreamer >=1.0 + - GLib +3. **debugDriver** - Debug sound driver for testing + - No dependencies ## Extras: @@ -91,16 +119,353 @@ If there is a package for your distrobution of choice, please let us know so we - You can also just run it from Git without installing: Requires root privileges - cd src/fenrir/ + cd src/ sudo ./fenrir -Settings "settings.conf" is located in the "config" directory or after installation in /etc/fenrir/settings. -Take care to use drivers from the config matching your installed drivers. -By default it uses: -- sound driver: genericDriver (via sox, could configured in settings.conf) -- speech driver: genericDriver (via espeak or espeak-ng, could configured in settings.conf) -- input driver: evdevDriver +Settings are located in: +- **After installation**: `/etc/fenrir/settings/settings.conf` +- **Development**: `config/settings/settings.conf` +By default Fenrir uses: +- **Sound driver**: genericDriver (via sox) +- **Speech driver**: speechdDriver (via speech-dispatcher) +- **Input driver**: evdevDriver (Linux) or ptyDriver (other platforms) +- **Screen driver**: vcsaDriver (Linux TTY) or ptyDriver (terminal emulation) + +## Getting Started + +### Basic Usage + +1. **Start Fenrir**: + ```bash + sudo systemctl start fenrir # If installed as service + # OR + sudo fenrir # Run directly + ``` + +2. **Basic Navigation**: + - **Fenrir Key**: By default `Insert`, `Keypad Insert`, or `Meta/Super` key + - **Tutorial Mode**: `Fenrir + H` to learn all commands interactively + - **Quit Fenrir**: `Fenrir + Q` + +3. **Essential Commands**: + - `Ctrl` - Stop speech (shut up) + - `Fenrir + Keypad 5` - Read current screen + - `Keypad 8` - Read current line + - `Keypad 5` - Read current word + - `Keypad 2` - Read current character + - `Fenrir + T` - Announce time + - `Fenrir + S` - Spell check current word + +### Keyboard Layouts + +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`: +```ini +[keyboard] +keyboardLayout=desktop # or 'laptop' +``` + +### First Time Setup + +1. **Enable Fenrir at boot**: + ```bash + sudo systemctl enable fenrir + ``` + +2. **Configure audio** (if needed): + - For PulseAudio: Run configure_pulse.sh script (see below) + - For PipeWire: Run configure_pipewire.sh script (see below) + +3. **Test speech**: + ```bash + # Test speech-dispatcher directly + sudo spd-say "Hello World" + ``` + +## Remote Control + +Fenrir includes a powerful remote control system that allows external applications and scripts to control Fenrir through Unix sockets or TCP connections. This is particularly useful for automation, integration with other applications, or providing alternative control methods. + +### Configuration + +Enable remote control in `/etc/fenrir/settings/settings.conf`: + +```ini +[remote] +enable=True +driver=unixDriver # or tcpDriver +port=22447 # for TCP driver +socketFile= # custom socket path (optional) +enableSettingsRemote=True # allow settings changes +enableCommandRemote=True # allow command execution +``` + +### Remote Drivers + +1. **unixDriver** (recommended): Uses Unix domain sockets + - Socket location: `/tmp/fenrirscreenreader-deamon.sock` (TTY mode) or `/tmp/fenrirscreenreader-.sock` + - More secure, local-only access + - Works with `socat` + +2. **tcpDriver**: Uses TCP sockets on localhost + - Default port: 22447 + - Works with `netcat`, `telnet`, or any TCP client + - Local connections only (127.0.0.1) + +### Using socat with Unix Sockets + +The `socat` command provides the easiest way to send commands to Fenrir: + +#### Basic Speech Control +```bash +# Interrupt current speech +echo "command interrupt" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Speak custom text +echo "command say Hello, this is a test message" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Temporarily disable speech (until next keystroke) +echo "command tempdisablespeech" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### Settings Control +```bash +# Enable highlight tracking mode +echo "setting set focus#highlight=True" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Change speech parameters +echo "setting set speech#rate=0.8" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set speech#pitch=0.6" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set speech#volume=0.9" | 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#punctuationLevel=none" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Voice and TTS engine control +echo "setting set speech#voice=en-us+f3" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set speech#module=espeak-ng" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Disable sound temporarily +echo "setting set sound#enabled=False" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set sound#volume=0.5" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Keyboard and input settings +echo "setting set keyboard#charEchoMode=1" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set keyboard#wordEcho=True" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Screen control (ignore specific TTYs) +echo "setting set screen#ignoreScreen=1,2,3" | 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 + +# Reset all settings to defaults +echo "setting reset" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Save current settings +echo "setting save" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting saveas /tmp/my-fenrir-settings.conf" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### Clipboard Operations +```bash +# Place text into clipboard +echo "command clipboard This text will be copied to clipboard" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Export clipboard to file +echo "command exportclipboard" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### Window Management +```bash +# Define a window area (x1 y1 x2 y2) +echo "command window 0 0 80 24" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Reset window to full screen +echo "command resetwindow" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### VMenu Control +```bash +# Set virtual menu context +echo "command vmenu nano/file" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Reset virtual menu +echo "command resetvmenu" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### Application Control +```bash +# Quit Fenrir +echo "command quitapplication" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +### Using TCP Driver + +If using the TCP driver, replace socat commands with netcat: + +```bash +# Using netcat +echo "command say Hello from TCP" | nc localhost 22447 + +# Using telnet +echo "command interrupt" | telnet localhost 22447 +``` + +### Remote Command Reference + +#### Command Format +``` +command [parameters] +setting [parameters] +``` + +#### Available Commands + +**Speech Commands:** +- `command say ` - Speak the specified text +- `command interrupt` - Stop current speech +- `command tempdisablespeech` - Disable speech until next key press + +**Clipboard Commands:** +- `command clipboard ` - Add text to clipboard +- `command exportclipboard` - Export clipboard to file + +**Window Commands:** +- `command window ` - Define window area +- `command resetwindow` - Reset to full screen + +**VMenu Commands:** +- `command vmenu ` - Set vmenu context +- `command resetvmenu` - Reset vmenu + +**Application Commands:** +- `command quitapplication` - Quit Fenrir + +#### Available Settings + +**Settings Commands:** +- `setting set
#=` - Set configuration value +- `setting reset` - Reset all settings to defaults +- `setting save [path]` - Save current settings +- `setting saveas ` - Save settings to specific file + +**Common Settings:** + +*Speech Settings:* +- `speech#enabled=True/False` - Enable/disable speech +- `speech#rate=0.1-1.0` - Speech rate (speed) +- `speech#pitch=0.1-1.0` - Speech pitch (tone) +- `speech#volume=0.1-1.0` - Speech volume +- `speech#voice=voice_name` - Voice selection (e.g., "en-us+f3") +- `speech#module=module_name` - TTS module (e.g., "espeak-ng") +- `speech#driver=driver_name` - Speech driver (speechdDriver/genericDriver) +- `speech#autoReadIncoming=True/False` - Auto-read new text + +*Sound Settings:* +- `sound#enabled=True/False` - Enable/disable sound +- `sound#volume=0.1-1.0` - Sound volume +- `sound#driver=driver_name` - Sound driver (genericDriver/gstreamerDriver) +- `sound#theme=theme_name` - Sound theme + +*General Settings:* +- `general#punctuationLevel=none/some/most/all` - Punctuation verbosity +- `general#debugLevel=0-3` - Debug level +- `general#emoticons=True/False` - Enable emoticon replacement +- `general#autoSpellCheck=True/False` - Automatic spell checking + +*Focus Settings:* +- `focus#cursor=True/False` - Follow text cursor +- `focus#highlight=True/False` - Follow text highlighting + +*Keyboard Settings:* +- `keyboard#charEchoMode=0-2` - Character echo (0=none, 1=always, 2=capslock only) +- `keyboard#wordEcho=True/False` - Echo complete words +- `keyboard#charDeleteEcho=True/False` - Echo deleted characters +- `keyboard#interruptOnKeyPress=True/False` - Interrupt speech on key press + +*Screen Settings:* +- `screen#ignoreScreen=1,2,3` - TTY screens to ignore +- `screen#autodetectIgnoreScreen=True/False` - Auto-detect screens to ignore +- `screen#screenUpdateDelay=float` - Screen update delay + +*Time Settings:* +- `time#enabled=True/False` - Enable time announcements +- `time#presentTime=True/False` - Announce time +- `time#presentDate=True/False` - Announce date changes +- `time#delaySec=seconds` - Announcement interval +- `time#onMinutes=00,30` - Specific minutes to announce + +### Scripting Examples + +#### Bash Script for Speech Notifications +```bash +#!/bin/bash +# notify_fenrir.sh - Send notifications to Fenrir + +SOCKET="/tmp/fenrirscreenreader-deamon.sock" + +fenrir_say() { + echo "command say $1" | socat - UNIX-CLIENT:$SOCKET +} + +fenrir_interrupt() { + echo "command interrupt" | socat - UNIX-CLIENT:$SOCKET +} + +# Usage examples +fenrir_say "Build completed successfully" +fenrir_interrupt +``` + +#### Python Integration +```python +#!/usr/bin/env python3 +import socket +import os + +def send_fenrir_command(command): + """Send command to Fenrir via Unix socket""" + socket_path = "/tmp/fenrirscreenreader-deamon.sock" + if os.path.exists(socket_path): + sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + try: + sock.connect(socket_path) + sock.send(command.encode('utf-8')) + finally: + sock.close() + +# Examples +send_fenrir_command("command say Processing complete") +send_fenrir_command("setting set speech#rate=0.9") +``` + +### Security Considerations + +- Unix sockets are accessible only to the user running Fenrir +- TCP driver binds only to localhost (127.0.0.1) +- Socket file permissions are set to write-only (0o222) +- Commands are processed with Fenrir's privileges +- Settings changes can be disabled via `enableSettingsRemote=False` +- Command execution can be disabled via `enableCommandRemote=False` + +### Troubleshooting + +**Socket not found:** +- Verify Fenrir is running: `ps aux | grep fenrir` +- Check socket location: `/tmp/fenrirscreenreader-*` +- Ensure remote driver is enabled in settings + +**Commands not working:** +- Verify `enableCommandRemote=True` in settings +- Check Fenrir debug logs: `/var/log/fenrir.log` +- Test with simple command: `echo "command interrupt" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock` ## Configure pulseaudio @@ -127,12 +492,59 @@ just run the configuration script twice (once as user, once as root): The script is also located in the tools directory in git -## localization -copy fenrir.mo translations file from fenrir/locale/your_language/LC_MESSAGES/fenrir.mo to /usr/share/locale/your_language/LC_MESSAGES/fenrir.mo +## Command Line Options + +Fenrir supports several command-line options for different use cases: + +``` +fenrir [OPTIONS] +``` + +### Options: +- `-h, --help` - Show help message and exit +- `-v, --version` - Show version information and exit +- `-f, --foreground` - Run in foreground (don't daemonize) +- `-s, --setting SETTING-FILE` - Path to custom settings file +- `-o, --options SECTION#SETTING=VALUE;..` - Override settings file options +- `-d, --debug` - Enable debug mode +- `-p, --print` - Print debug messages to screen +- `-e, --emulated-pty` - Use PTY emulation with escape sequences for input (enables desktop/X/Wayland usage) +- `-E, --emulated-evdev` - Use PTY emulation with evdev for input (single instance) +- `-F, --force-all-screens` - Force Fenrir to respond on all screens, ignoring ignoreScreen setting + +### Examples: +```bash +# Run in foreground with debug output +sudo fenrir -f -d + +# Use PTY emulation for desktop use +sudo fenrir -e + +# Override settings via command line +sudo fenrir -o "speech#rate=0.8;sound#volume=0.5" + +# Force Fenrir to work on all screens (ignore ignoreScreen setting) +sudo fenrir -F +``` + +## Localization +Translation files are located in the `locale/` directory. To install translations: + +```bash +# Copy translation file to system location +sudo cp locale/your_language/LC_MESSAGES/fenrir.mo /usr/share/locale/your_language/LC_MESSAGES/fenrir.mo +``` + +Available languages: +- German (de) +- Spanish (es) +- Polish (pl) +- Portuguese (pt) +- Russian (ru) - ## Documentation and Support -- Email list: [stormux+subscribe@groups.io](mailto:stormux+subscribe@groups.io?subject=subscribe) with the subject subscribe. -- [Fenrir Wiki](https://git.stormux.org/storm/fenrir/wiki) -- IRC: irc.stormux.org #stormux +- **Email list**: [stormux+subscribe@groups.io](mailto:stormux+subscribe@groups.io?subject=subscribe) with the subject subscribe +- **Fenrir Wiki**: [https://git.stormux.org/storm/fenrir/wiki](https://git.stormux.org/storm/fenrir/wiki) +- **IRC**: irc.stormux.org #stormux +- **Issues**: Report bugs and feature requests on the project repository diff --git a/docs/development.txt b/docs/development.txt index 26d1a4ea..66b4cb51 100644 --- a/docs/development.txt +++ b/docs/development.txt @@ -1,4 +1,389 @@ -1. Basic -2. Commands -3. Useful API +# Fenrir Development Guide +This document provides information for developers who want to contribute to Fenrir or understand its architecture. + +## Project Structure + +Fenrir follows a modular, driver-based architecture: + +``` +src/fenrirscreenreader/ +├── core/ # Core system modules +│ ├── fenrirManager.py # Main application manager +│ ├── screenManager.py # Screen handling +│ ├── inputManager.py # Input handling +│ ├── outputManager.py # Speech/sound output +│ ├── commandManager.py # Command system +│ └── settingsManager.py # Configuration management +├── commands/ # Command implementations +│ ├── commands/ # User-invoked commands +│ ├── onCursorChange/ # Cursor movement hooks +│ ├── onScreenUpdate/ # Screen update hooks +│ ├── onKeyInput/ # Key input hooks +│ └── help/ # Tutorial system +├── drivers/ # Driver implementations +│ ├── inputDriver/ # Input drivers (evdev, pty, atspi) +│ ├── screenDriver/ # Screen drivers (vcsa, pty) +│ ├── speechDriver/ # Speech drivers (speechd, generic) +│ └── soundDriver/ # Sound drivers (generic, gstreamer) +└── utils/ # Utility modules +``` + +## Core Architecture + +### Driver System +Fenrir uses a pluggable driver architecture: + +1. **Input Drivers**: Capture keyboard input + - evdevDriver: Linux evdev (recommended) + - ptyDriver: Terminal emulation + - atspiDriver: AT-SPI for desktop + +2. **Screen Drivers**: Read screen content + - vcsaDriver: Linux VCSA devices + - ptyDriver: Terminal emulation + +3. **Speech Drivers**: Text-to-speech output + - speechdDriver: Speech-dispatcher + - genericDriver: Command-line TTS + +4. **Sound Drivers**: Audio output + - genericDriver: Sox-based + - gstreamerDriver: GStreamer + +5. **Remote Drivers**: Remote control interfaces + - unixDriver: Unix socket control + - tcpDriver: TCP socket control + +### Command System +Commands are Python modules that implement specific functionality: + +```python +class command(): + def __init__(self): + pass + + def initialize(self, environment): + self.env = environment + + def shutdown(self): + pass + + def getDescription(self): + return _('Command description') + + def run(self): + # Command implementation + pass +``` + +### Event Hooks +Fenrir supports various event hooks: + +- **onCursorChange**: Triggered when cursor moves +- **onScreenUpdate**: Triggered on screen content changes +- **onKeyInput**: Triggered on key presses +- **onByteInput**: Triggered on byte-level input +- **onScreenChanged**: Triggered when switching screens + +## Development Setup + +### Requirements +- Python 3.6+ +- python3-evdev +- python3-pyudev +- speech-dispatcher +- sox + +### Getting Started +```bash +# Clone repository +git clone https://git.stormux.org/storm/fenrir.git +cd fenrir + +# Install dependencies +sudo pip3 install -r requirements.txt + +# Run from source +cd src/ +sudo ./fenrir -f -d +``` + +### Testing +```bash +# Run in debug mode +sudo ./fenrir -f -d -p + +# Debug output goes to: +# - Console (with -p flag) +# - /var/log/fenrir.log +``` + +## Creating Commands + +### Basic Command +Create a file in `src/fenrirscreenreader/commands/commands/`: + +```python +from fenrirscreenreader.core import debug + +class command(): + def __init__(self): + pass + + def initialize(self, environment): + self.env = environment + + def shutdown(self): + pass + + def getDescription(self): + return _('My custom command') + + def run(self): + # Get current text + text = self.env['screen']['newContentText'] + + # Speak something + self.env['runtime']['outputManager'].presentText('Hello World') + + # Play sound + self.env['runtime']['outputManager'].playSoundIcon('Accept') +``` + +### Key Bindings +Add key bindings in keyboard layout files: +`config/keyboard/desktop.conf` or `config/keyboard/laptop.conf` + +```ini +[KEY_CTRL]#[KEY_ALT]#[KEY_H]=my_command +``` + +### Event Hooks +Create event handlers in appropriate directories: + +```python +# onCursorChange/my_hook.py +class command(): + def __init__(self): + pass + + def initialize(self, environment): + self.env = environment + + def shutdown(self): + pass + + def getDescription(self): + return _('My cursor change handler') + + def run(self): + if self.env['runtime']['cursorManager'].isCursorHorizontalMove(): + # Handle horizontal cursor movement + pass +``` + +## Creating Drivers + +### Driver Template +```python +class driver(): + def __init__(self): + pass + + def initialize(self, environment): + self.env = environment + + def shutdown(self): + pass + + # Driver-specific methods... +``` + +### Input Driver +Implement these methods: +- `getInputEvent()`: Return input events +- `writeEventBuffer()`: Handle output events +- `grabDevices()`: Take exclusive control +- `releaseDevices()`: Release control + +### Screen Driver +Implement these methods: +- `getCurrScreen()`: Get current screen content +- `getSessionInformation()`: Get session info + +### Speech Driver +Implement these methods: +- `speak()`: Speak text +- `cancel()`: Stop speech +- `setCallback()`: Set callback functions + +### Remote Driver +Implement these methods: +- `initialize()`: Setup socket/connection +- `watchDog()`: Listen for incoming commands +- `shutdown()`: Clean up connections + +#### Remote Driver Example +```python +class driver(remoteDriver): + def initialize(self, environment): + self.env = environment + # Start watchdog thread + self.env['runtime']['processManager'].addCustomEventThread( + self.watchDog, multiprocess=True + ) + + def watchDog(self, active, eventQueue): + # Listen for connections and process commands + while active.value: + # Accept connections + # Parse incoming data + # Send to event queue + eventQueue.put({ + "Type": fenrirEventType.RemoteIncomming, + "Data": command_text + }) +``` + +## Configuration + +### Settings System +Settings are hierarchical: +1. Command-line options (`-o`) +2. Configuration file +3. Hard-coded defaults + +### Adding Settings +1. Add default value to `core/settingsData.py` +2. Access via `self.env['runtime']['settingsManager'].getSetting(section, key)` + +## Debugging + +### Debug Levels +- 0: DEACTIVE +- 1: ERROR +- 2: WARNING +- 3: INFO + +### Debug Output +```python +self.env['runtime']['debug'].writeDebugOut( + 'Debug message', + debug.debugLevel.INFO +) +``` + +### Testing Commands +```bash +# Test specific functionality +sudo fenrir -f -d -o "general#debugLevel=3" + +# Test with custom config +sudo fenrir -f -s /path/to/test.conf +``` + +## Contributing + +### Code Style +- Follow PEP 8 +- Use descriptive variable names +- Add docstrings for complex functions +- Handle exceptions gracefully + +### Testing +- Test with different drivers +- Test keyboard layouts +- Test on different terminals +- Verify accessibility features + +### Submitting Changes +1. Fork the repository +2. Create feature branch +3. Make changes with clear commit messages +4. Test thoroughly +5. Submit pull request + +## API Reference + +### Environment Structure +The `environment` dict contains all runtime data: + +```python +environment = { + 'runtime': { + 'settingsManager': settingsManager, + 'commandManager': commandManager, + 'screenManager': screenManager, + 'inputManager': inputManager, + 'outputManager': outputManager, + 'debug': debugManager, + # ... other managers + }, + 'screen': { + 'newContentText': '', + 'oldContentText': '', + 'newCursor': {'x': 0, 'y': 0}, + 'oldCursor': {'x': 0, 'y': 0}, + # ... screen data + }, + 'general': { + 'prevCommand': '', + 'currCommand': '', + # ... general data + } +} +``` + +### Common Operations + +#### Speaking Text +```python +self.env['runtime']['outputManager'].presentText('Hello') +``` + +#### Playing Sounds +```python +self.env['runtime']['outputManager'].playSoundIcon('Accept') +``` + +#### Getting Settings +```python +rate = self.env['runtime']['settingsManager'].getSetting('speech', 'rate') +``` + +#### Cursor Information +```python +x = self.env['screen']['newCursor']['x'] +y = self.env['screen']['newCursor']['y'] +``` + +#### Screen Content +```python +text = self.env['screen']['newContentText'] +lines = text.split('\n') +current_line = lines[self.env['screen']['newCursor']['y']] +``` + +## Maintenance + +### Release Process +1. Update version in `fenrirVersion.py` +2. Update changelog +3. Test on multiple systems +4. Tag release +5. Update documentation + +### Compatibility +- Maintain Python 3.6+ compatibility +- Test on multiple Linux distributions +- Ensure driver compatibility +- Check dependencies + +## Resources + +- **Repository**: https://git.stormux.org/storm/fenrir +- **Wiki**: https://git.stormux.org/storm/fenrir/wiki +- **Issues**: Use repository issue tracker +- **Community**: IRC irc.stormux.org #stormux +- **Email**: stormux+subscribe@groups.io \ No newline at end of file diff --git a/docs/fenrir.1 b/docs/fenrir.1 index c604e491..c6347dd0 100644 --- a/docs/fenrir.1 +++ b/docs/fenrir.1 @@ -1,2764 +1,515 @@ -.\"t -.\" Automatically generated by Pandoc 1.19.2.1 -.\" -.TH "" "" "" "" "" -.hy -.SH Fenrir User Manual -.PP -Fenrir is a modern command line screen reader written in Python3. -.PP -It has a modular structure, a flexible based driver model, is highly -configurable and easy to customize and extend (see Developer -Manual (fenrir_development_manual)). -.PP -Please see the following pages for the current (fenrir_current_version) -and Git (fenrir_git_version) version of Fenrir. -.SH Support and Requirements -.PP -Fenrir requires several drivers to interact with the operating system. -.SS Speech Drivers -.PP -A speech driver is for communication with the text to speech system like -Speech\-Dispatcher (#SpeechDispatcher) or -Espeak (http://espeak.sourceforge.net). -\\ See section Speech (#Speech) in \[aq]\[aq]settings.conf\[aq]\[aq] for -more information. -.SS SpeechDispatcher -.PP -This driver is used by default. -It uses Speech\-dispatcher as its backend. -.PP -Dependencies: -.IP \[bu] 2 -Speech\-dispatcher (installed and configured, -Documentation (https///devel.freebsoft.org/speechd#sec2)) -.IP \[bu] 2 -Python\-speechd -.SS Espeak -.PP -Uses Espeak via Python bindings. -.PP -Dependencies: -.IP \[bu] 2 -Espeak or Espeak\-ng -.IP \[bu] 2 -python\-espeak (https///launchpad.net/python-espeak) -.SS Generic -.PP -This invokes speech via a sub\-process. -This is almost the same as using the commandline. -The performance depends on the overhead of the speech synthesis -application but it is really flexible. -.PP -Dependencies: -.IP \[bu] 2 -Espeak or Espeak\-ng -.PP -The Requirements are flexible, they depend on the configuration in -settings.conf. -.SS Dummy -.PP -this is just for debugging, logs are output to the screen and logged as -well. -.SS Sound Drivers -.PP -To play sound icons and similar.\\ See section Sound (#Sound) in -\[aq]\[aq]settings.conf\[aq]\[aq] for more information. -.SS Generic -.PP -This driver is used by default. -.PP -Dependencies: -.IP \[bu] 2 -Sox (http://sox.sourceforge.net/) with opus support The Requirements are -flexible, they depend on the configuration in settings.conf. -.SS Gstreamer -.PP -if you prefer to use Gstreamer for sound output. -.PP -Dependencies: -.IP \[bu] 2 -Gstreamer >= 1.x -.IP \[bu] 2 -Glibc -.SS Dummy -.PP -this is just for debugging, logs are output to the screen and logged as -well. -.SS Input Drivers -.PP -Input drivers are to capture keyboard shortcuts issued to the screen -reader -.PD 0 -.P -.PD -See section Keyboard (#Keyboard) in \[aq]\[aq]settings.conf\[aq]\[aq] -for more information. -.SS Evdev -.PP -This driver is used by default. -.PP -Evdev is the low level input device framework for Linux. -.PP -Dependencies: -.IP \[bu] 2 -python\-evdev >=0.6.3 -.IP \[bu] 2 -pyudev -.IP \[bu] 2 -loaded uinput kernel module -.IP \[bu] 2 -exclusive access to the input devices Read permission to the following -files and services: -.IP \[bu] 2 -/dev/input -.IP \[bu] 2 -/dev/uinput -.SS Screen Drivers -.PP -The job of a screen driver is to get the information of current screen -content.\\ See section Screen (#Screen) in -\[aq]\[aq]settings.conf\[aq]\[aq] for more information. -.SS VCSA -.PP -This driver is used by default. -For Linux VCSA devices. -These exist on any current standard installation of Linux. -.PP -Dependencie s: -.IP \[bu] 2 -python\-dbus Read permission to the following files and services (or run -as root): -.IP \[bu] 2 -/sys/devices/virtual/tty/tty0/active -.IP \[bu] 2 -/dev/tty[1 \- 64] -.IP \[bu] 2 -/dev/vcsa[1 \- 64] (VCSA manpage (https///linux.die.net/man/4/vcsa)) -.IP \[bu] 2 -read Logind DBUS -.SS Braille Drivers -.PP -This is for Braille support. -Braille is currently a work in progress and is planned for the Fenrir -2.0 release.\\ See section Braille (#Braille) in -\[aq]\[aq]settings.conf\[aq]\[aq] for more information. -.SS BRLTTY -.PP -This driver is used by default. -It uses BrlTTY (brltty) to communicate with with a Braille device. -.PP -Dependencies: -.IP \[bu] 2 -BrlTTY (configured and running, -Documentation (http://mielke.cc/brltty/doc/Manual-BRLTTY/English/BRLTTY.html)) -.IP \[bu] 2 -python\-brlapi (configured, -Documentation (http://mielke.cc/brltty/doc/Manual-BrlAPI/English/BrlAPI.html)) -## Currently supported platforms -.PP -Currently Fenrir completely supports the following Platforms: -.IP \[bu] 2 -Linux TTY Support for further Systems are planned. -.SH Installation -.PP -Fenrir can run without installation. -It just requires the dependencies are installed first. -.PP -We recommend to try it out before installation to be sure everything -works and prevent yourself from experiencing a non\-talking environment. -.SS Try Out -.PP -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 -\[aq]\[aq]src/fenrir/fenrir\[aq]\[aq] (in foreground) or -\[aq]\[aq]src/fenrir/fenrir\-daemon\[aq]\[aq] (in background, used by -systemd for autostart) -.SS Install it -.SS Documented operating systems -.SS Arch Linux -.PP -For Arch there are PKGBUILDs in the AUR: -.IP \[bu] 2 -fenrir (https///aur.archlinux.org/packages/fenrir/) -.IP \[bu] 2 -fenrir\-git (https///aur.archlinux.org/packages/fenrir-git/) -.SS Manual -.IP "1." 3 -Download the latest stable version from the -Fenrir\-Project (https///linux-a11y.org/index.php?page=fenrir-screenreader) -site. -.IP "2." 3 -Unpack the archive -.IP "3." 3 -Check the needed Dependencys by running -check\-dependencys.py (https///github.com/chrys87/fenrir/blob/master/check-dependencies.py) -script -.IP "4." 3 -install the missing dependencies an standard installation requires the -following: -.RS 4 -.IP \[bu] 2 -python3 >= 3.3 (and all the following is needed for python3 ) -.IP \[bu] 2 -python3\-speechd (screen) -.IP \[bu] 2 -python3\-dbus (screen) -.IP \[bu] 2 -python3\-evdev >= 0.6.4(input) -.IP \[bu] 2 -python3\-daemonize (background service) -.IP \[bu] 2 -python3\-brlapi (braille) -.IP \[bu] 2 -python3\-pyenchant (spellchecker) -.IP \[bu] 2 -your language for aspell (aspell\-\f[C]\f[]) (spellchecker) -.IP \[bu] 2 -sox (sound) -.IP \[bu] 2 -For an individual installation see Support and -Requirements (#Support and Requirements) or consult the -Readme (https///github.com/chrys87/fenrir/blob/master/README.md)) -.RE -.IP "5." 3 -run "install.sh" as root -.PP -this installs Fenrir as the following -.IP -.nf -\f[C] -*\ Application:\[aq]\[aq]/opt/fenrir\[aq]\[aq] -*\ Settings:\[aq]\[aq]/etc/fenrir\[aq]\[aq] -*\ Sound\ Icons:\[aq]\[aq]/usr/share/fenrirscreenreader/\[aq]\[aq] -\f[] -.fi -.PP -to remove Fenrir just run uninstall.sh as root -.SS Git -.PP -if you want to get the latest code you can use git to get a development -snapshot: -.IP -.nf -\f[C] -git\ clone\ https://github.com/chrys87/fenrir.git -\f[] -.fi -.SS Auto Start -.PP -To start Fenrir once: systemctl start fenrir -.PP -To enable auto start on system boot: systemctl enable fenrir -.SH First Steps -.PP -If you are using Fenrir for the first time you may want to take a look -at these resources: -.IP \[bu] 2 -Keybindings (#Keybindings) -.IP \[bu] 2 -Tutorial Mode (#Tutorial Mode) -.SH Features -.SS Commands -.SS Keybindings -.PP -Normal commands can be invoked in two ways: 1. -Using a Metakey (FenrirKey (#Fenrir Key)) 2. -Shortcuts with a single key -.PP -See section Keyboard (#Keyboard) in \[aq]\[aq]settings.conf\[aq]\[aq] -for more information. -#### Fenrir Key -.PP -The Fenrir Key is for invoking screen reader commands. -Fenrir can utilize more than one FenrirKey at the same time. -By default the following keys are used: 1. -Insert 2. -KeyPad Insert 3. -Meta (Super, Windows) -.SS Script Key -.PP -To invoke "Scripts" the Script Key is mandatory. -The shortcut is encoded in the filename of the script. -See Scripting (#Scripting) #### Desktop Layout -.PP -.TS -tab(@); -l l. -T{ -Shortcut -T}@T{ -Command -T} -_ -T{ -FenrirKey + H -T}@T{ -toggle tutorial mode (#Tutorial Mode) -T} -T{ -CTRL -T}@T{ -shut up (interrupts speech) (#shut up) -T} -T{ -FenrirKey + KeyPad 9 -T}@T{ -reviews bottom (#review bottom) -T} -T{ -FenrirKey + KeyPad 7 -T}@T{ -reviews top (#review top) -T} -T{ -KeyPad 8 -T}@T{ -reviews current line (#review current line) -T} -T{ -KeyPad 7 -T}@T{ -reviews previous line (#review previous line) -T} -T{ -KeyPad 9 -T}@T{ -reviews next line (#review next line) -T} -T{ -FenrirKey + KeyPad 4 -T}@T{ -reviews line beginning (#review line beginning) -T} -T{ -FenrirKey + KeyPad 6 -T}@T{ -reviews line ending (#review line ending) -T} -T{ -FenrirKey + KeyPad 1 -T}@T{ -reviews line first character (#review line first character) -T} -T{ -FenrirKey + KeyPad 3 -T}@T{ -reviews line last character (#review line last character) -T} -T{ -FenrirKey + Alt + 1 -T}@T{ -presents first line (#present first line) -T} -T{ -FenrirKey + Alt + 2 -T}@T{ -presents last line (#present last line) -T} -T{ -KeyPad 5 -T}@T{ -reviews current word (#review current word) -T} -T{ -KeyPad 4 -T}@T{ -reviews previous word (#review previous word) -T} -T{ -KeyPad 6 -T}@T{ -reviews next word (#review next word) -T} -T{ -FenrirKey + Shift + KeyPad 5 -T}@T{ -reviews current word phonetic (#review current word phonetic) -T} -T{ -FenrirKey + Shift + KeyPad 4 -T}@T{ -reviews previous word phonetic (#review previous word phonetic) -T} -T{ -FenrirKey + Shift + KeyPad 6 -T}@T{ -reviews next word phonetic (#review next word phonetic) -T} -T{ -KeyPad 2 -T}@T{ -reviews current char (#review current character) -T} -T{ -KeyPad 1 -T}@T{ -reviews previous char (#review previous character) -T} -T{ -KeyPad 3 -T}@T{ -reviews next char (#review next character) -T} -T{ -FenrirKey + Shift + KeyPad 2 -T}@T{ -reviews current character -phonetic (#review current character phonetic) -T} -T{ -FenrirKey + Shift + KeyPad 1 -T}@T{ -reviews previous character -phonetic (#review previous character phonetic) -T} -T{ -FenrirKey + Shift + KeyPad 3 -T}@T{ -reviews next character phonetic (#review next character phonetic) -T} -T{ -FenrirKey + CTRL + KeyPad 8 -T}@T{ -reviews up (#review up) -T} -T{ -FenrirKey + CTRL + KeyPad 2 -T}@T{ -reviews down (#review down) -T} -T{ -FenrirKey + KeyPad dot -T}@T{ -exit review (#exit review) -T} -T{ -KeyPad dot -T}@T{ -cursor position (#cursor position) -T} -T{ -FenrirKey + I -T}@T{ -indent curr line (#indent current line) -T} -T{ -FenrirKey + KeyPad 5 -T}@T{ -current screen (#current screen) -T} -T{ -FenrirKey + KeyPad 8 -T}@T{ -current screen before cursor (#current screen before cursor) -T} -T{ -FenrirKey + KeyPad 2 -T}@T{ -current screen after cursor (#current screen after cursor) -T} -T{ -\f[C]\f[] -T}@T{ -cursor read to end of line (#cursor read to end of line) -T} -T{ -\f[C]\f[] -T}@T{ -cursor column (#cursor column) -T} -T{ -\f[C]\f[] -T}@T{ -cursor line number (#cursor line number) -T} -T{ -\f[C]\f[] -T}@T{ -Braille flush (#braille flush) -T} -T{ -\f[C]\f[] -T}@T{ -Braille pan left (#braille pan left) -T} -T{ -\f[C]\f[] -T}@T{ -Braille pan right (#braille pan right) -T} -T{ -\f[C]\f[] -T}@T{ -Braille return to cursor (#braille return to cursor) -T} -T{ -FenrirKey + CTRL + 1 -T}@T{ -clear bookmark 1 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 1 -T}@T{ -set bookmark 1 (#set Bookmark X) -T} -T{ -FenrirKey + 1 -T}@T{ -bookmark 1 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 2 -T}@T{ -clear bookmark 2 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 2 -T}@T{ -set bookmark 2 (#set Bookmark X) -T} -T{ -FenrirKey + 2 -T}@T{ -bookmark 2 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 3 -T}@T{ -clear bookmark 3 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 3 -T}@T{ -set bookmark 3 (#set Bookmark X) -T} -T{ -FenrirKey + 3 -T}@T{ -bookmark 3 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 4 -T}@T{ -clear bookmark 4 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 4 -T}@T{ -set bookmark 4 (#set Bookmark X) -T} -T{ -FenrirKey + 4 -T}@T{ -bookmark 4 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 5 -T}@T{ -clear bookmark 5 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 5 -T}@T{ -set bookmark 5 (#set Bookmark X) -T} -T{ -FenrirKey + 5 -T}@T{ -bookmark 5 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 6 -T}@T{ -clear bookmark 6 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 6 -T}@T{ -set bookmark 6 (#set Bookmark X) -T} -T{ -FenrirKey + 6 -T}@T{ -bookmark 6 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 7 -T}@T{ -clear bookmark 7 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 7 -T}@T{ -set bookmark 7 (#set Bookmark X) -T} -T{ -FenrirKey + 7 -T}@T{ -bookmark 7 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 8 -T}@T{ -clear bookmark 8 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 8 -T}@T{ -set bookmark 8 (#set Bookmark X) -T} -T{ -FenrirKey + 8 -T}@T{ -bookmark 8 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 9 -T}@T{ -clear bookmark 9 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 9 -T}@T{ -set bookmark 9 (#set Bookmark X) -T} -T{ -FenrirKey + 9 -T}@T{ -bookmark 9 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 0 -T}@T{ -clear bookmark 10 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 0 -T}@T{ -set bookmark 10 (#set Bookmark X) -T} -T{ -FenrirKey + 0 -T}@T{ -bookmark 10 (#read Bookmark X) -T} -T{ -FenrirKey + KeyPad Slash -T}@T{ -set window application (#Create Window) -T} -T{ -2 * FenrirKey + KeyPad Slash -T}@T{ -clear window application (#Remove Window) -T} -T{ -KeyPad Plus -T}@T{ -read last incoming (#last incoming) -T} -T{ -FenrirKey + F2 -T}@T{ -toggles braille (#toggle braille) -T} -T{ -FenrirKey + F3 -T}@T{ -toggles sound (#toggle sound) -T} -T{ -FenrirKey + F4 -T}@T{ -toggles speech (#toggle speech) -T} -T{ -KeyPad Enter -T}@T{ -temporarily disables speech (#disable speech temporarily) -T} -T{ -FenrirKey + CTRL + P -T}@T{ -toggles punctuation level (#toggle punctuation level) -T} -T{ -FenrirKey + RightBrace -T}@T{ -toggle auto spell check (#toggle auto spell check) -T} -T{ -FenrirKey + Backslash -T}@T{ -toggles output (#toggle output) -T} -T{ -FenrirKey + CTRL + E -T}@T{ -toggles emoticons (#toggle emoticons) -T} -T{ -FenrirKey + KeyPad Enter -T}@T{ -toggles auto read (#toggle auto read) -T} -T{ -FenrirKey + CTRL + T -T}@T{ -toggles auto time (#toggle auto time) -T} -T{ -FenrirKey + KeyPad ASTERISK -T}@T{ -toggles highlight tracking (#toggle highlight tracking) -T} -T{ -FenrirKey + Q -T}@T{ -quits fenrir (#quit Fenrir) -T} -T{ -FenrirKey + T -T}@T{ -Announce time (#Time) -T} -T{ -2 * FenrirKey + T -T}@T{ -Announce date (#Date) -T} -T{ -FenrirKey + S -T}@T{ -spell check (#spell check) -T} -T{ -2 * FenrirKey + S -T}@T{ -add word to spell check (#add word to spell check) -T} -T{ -FenrirKey + Shift + S -T}@T{ -removes word from spell check (#removes word from spell check) -T} -T{ -FenrirKey + Backspace -T}@T{ -forward keypress (#forward keypress) -T} -T{ -FenrirKey + Up -T}@T{ -increase speech volume (#increase speech volume) -T} -T{ -FenrirKey + Down -T}@T{ -decrease speech volume (#decrease speech volume) -T} -T{ -FenrirKey + Right -T}@T{ -increase speech rate (#increase speech rate) -T} -T{ -FenrirKey + Left -T}@T{ -decrease speech rate (#decrease speech rate) -T} -T{ -FenrirKey + Alt + Right -T}@T{ -increase speech pitch (#increase speech pitch) -T} -T{ -FenrirKey + Alt + Left -T}@T{ -decrease speech pitch (#decrease speech pitch) -T} -T{ -FenrirKey + Alt + Up -T}@T{ -increase sound volume (#increase sound volume) -T} -T{ -FenrirKey + Alt + Down -T}@T{ -decrease sound volume (#decrease sound volume) -T} -T{ -FenrirKey + CTRL + Shift + C -T}@T{ -clears clipboard (#clear clipboard) -T} -T{ -FenrirKey + Home -T}@T{ -first clipboard (#first clipboard) -T} -T{ -FenrirKey + End -T}@T{ -last clipboard (#last clipboard) -T} -T{ -FenrirKey + PageUp -T}@T{ -previous clipboard (#previous clipboard) -T} -T{ -FenrirKey + PageDown -T}@T{ -next clipboard (#next clipboard) -T} -T{ -FenrirKey + Shift + C -T}@T{ -current clipboard (#read current clipboard) -T} -T{ -FenrirKey + C -T}@T{ -copy marked text to clipboard (#copy marked to clipboard) -T} -T{ -FenrirKey + V -T}@T{ -paste clipboard contents (#paste clipboard) -T} -T{ -FenrirKey + P -T}@T{ -import clipboard from file (#import clipboard from file) -T} -T{ -FenrirKey + Alt + Shift +C -T}@T{ -export clipboard to file (#export clipboard to file) -T} -T{ -FenrirKey + CTRL + Shift + X -T}@T{ -remove marks (#Remove Marks) -T} -T{ -FenrirKey + X -T}@T{ -set mark (#Set mark) -T} -T{ -FenrirKey + Shift + X -T}@T{ -announce marked text (#Get text between marks) -T} -T{ -Linux specific -T}@T{ -T} -T{ -\f[C]\f[] -T}@T{ -export clipboard to X -T} -T{ -FenrirKey + CTRL + Up -T}@T{ -include Alsa volume -T} -T{ -FenrirKey + CTRL + Down -T}@T{ -decrease Alsa volume -T} -.TE -.SS Laptop Layout -.PP -.TS -tab(@); -l l. -T{ -Shortcut -T}@T{ -Command -T} -_ -T{ -FenrirKey + H -T}@T{ -toggle tutorial mode (#Tutorial Mode) -T} -T{ -CTRL -T}@T{ -shut up (interrupts speech) (#shut up) -T} -T{ -FenrirKey + Shift + O -T}@T{ -reviews bottom (#review bottom) -T} -T{ -FenrirKey + Shift + U -T}@T{ -reviews top (#review top) -T} -T{ -FenrirKey + I -T}@T{ -reviews current line (#review current line) -T} -T{ -FenrirKey + U -T}@T{ -reviews previous line (#review previous line) -T} -T{ -FenrirKey + O -T}@T{ -reviews next line (#review next line) -T} -T{ -FenrirKey + Shift + J -T}@T{ -reviews line beginning (#review line beginning) -T} -T{ -FenrirKey + Shift + L -T}@T{ -reviews line ending (#review line ending) -T} -T{ -FenrirKey + CTRL + J -T}@T{ -reviews line first character (#review line first character) -T} -T{ -FenrirKey + CTRL + L -T}@T{ -reviews line last character (#review line last character) -T} -T{ -FenrirKey + Alt + 1 -T}@T{ -presents first line (#present first line) -T} -T{ -FenrirKey + Alt + 2 -T}@T{ -presents last line (#present last line) -T} -T{ -FenrirKey + K -T}@T{ -reviews current word (#review current word) -T} -T{ -FenrirKey + J -T}@T{ -reviews previous word (#review previous word) -T} -T{ -FenrirKey + L -T}@T{ -reviews next word (#review next word) -T} -T{ -FenrirKey + CTRL + ALT + K -T}@T{ -reviews current word phonetic (#review current word phonetic) -T} -T{ -FenrirKey + CTRL + ALT + J -T}@T{ -reviews previous word phonetic (#review previous word phonetic) -T} -T{ -FenrirKey + CTRL + ALT + L -T}@T{ -reviews next word phonetic (#review next word phonetic) -T} -T{ -FenrirKey + comma -T}@T{ -reviews current character (#review current character) -T} -T{ -FenrirKey + M -T}@T{ -reviews previous character (#review previous character) -T} -T{ -FenrirKey + dot -T}@T{ -reviews next character (#review next character) -T} -T{ -FenrirKey + CTRL + ALT + comma -T}@T{ -reviews current character -phonetic (#review current character phonetic) -T} -T{ -FenrirKey + CTRL + ALT + M -T}@T{ -reviews previous character -phonetic (#review previous character phonetic) -T} -T{ -FenrirKey + CTRL + ALT + dot -T}@T{ -reviews next character phonetic (#review next character phonetic) -T} -T{ -FenrirKey + CTRL + I -T}@T{ -reviews up (#review up) -T} -T{ -FenrirKey + CTRL + comma -T}@T{ -reviews down (#review down) -T} -T{ -FenrirKey + Slash -T}@T{ -exit review (#exit review) -T} -T{ -FenrirKey + Shift + dot -T}@T{ -cursor position (#cursor position) -T} -T{ -2 * FenrirKey + I -T}@T{ -indent curr line (#indent current line) -T} -T{ -FenrirKey + Shift + K -T}@T{ -current screen (#current screen) -T} -T{ -FenrirKey + Shift + I -T}@T{ -current screen before cursor (#current screen before cursor) -T} -T{ -FenrirKey + Shift + comma -T}@T{ -current screen after cursor (#current screen after cursor) -T} -T{ -\f[C]\f[] -T}@T{ -cursor read to end of line (#cursor read to end of line) -T} -T{ -\f[C]\f[] -T}@T{ -cursor column (#cursor column) -T} -T{ -\f[C]\f[] -T}@T{ -cursor line number (#cursor line number) -T} -T{ -\f[C]\f[] -T}@T{ -Braille flush (#braille flush) -T} -T{ -\f[C]\f[] -T}@T{ -Braille pan left (#braille pan left) -T} -T{ -\f[C]\f[] -T}@T{ -Braille pan right (#braille pan right) -T} -T{ -\f[C]\f[] -T}@T{ -Braille return to cursor (#braille return to cursor) -T} -T{ -FenrirKey + CTRL + 1 -T}@T{ -clear bookmark 1 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 1 -T}@T{ -set bookmark 1 (#set Bookmark X) -T} -T{ -FenrirKey + 1 -T}@T{ -bookmark 1 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 2 -T}@T{ -clear bookmark 2 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 2 -T}@T{ -set bookmark 2 (#set Bookmark X) -T} -T{ -FenrirKey + 2 -T}@T{ -bookmark 2 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 3 -T}@T{ -clear bookmark 3 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 3 -T}@T{ -set bookmark 3 (#set Bookmark X) -T} -T{ -FenrirKey + 3 -T}@T{ -bookmark 3 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 4 -T}@T{ -clear bookmark 4 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 4 -T}@T{ -set bookmark 4 (#set Bookmark X) -T} -T{ -FenrirKey + 4 -T}@T{ -bookmark 4 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 5 -T}@T{ -clear bookmark 5 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 5 -T}@T{ -set bookmark 5 (#set Bookmark X) -T} -T{ -FenrirKey + 5 -T}@T{ -bookmark 5 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 6 -T}@T{ -clear bookmark 6 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 6 -T}@T{ -set bookmark 6 (#set Bookmark X) -T} -T{ -FenrirKey + 6 -T}@T{ -bookmark 6 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 7 -T}@T{ -clear bookmark 7 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 7 -T}@T{ -set bookmark 7 (#set Bookmark X) -T} -T{ -FenrirKey + 7 -T}@T{ -bookmark 7 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 8 -T}@T{ -clear bookmark 8 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 8 -T}@T{ -set bookmark 8 (#set Bookmark X) -T} -T{ -FenrirKey + 8 -T}@T{ -bookmark 8 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 9 -T}@T{ -clear bookmark 9 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 9 -T}@T{ -set bookmark 9 (#set Bookmark X) -T} -T{ -FenrirKey + 9 -T}@T{ -bookmark 9 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 0 -T}@T{ -clear bookmark 10 (#clear Bookmark X) -T} -T{ -FenrirKey + Shift + 0 -T}@T{ -set bookmark 10 (#set Bookmark X) -T} -T{ -FenrirKey + 0 -T}@T{ -bookmark 10 (#read Bookmark X) -T} -T{ -FenrirKey + CTRL + 8 -T}@T{ -set window application (#Create Window) -T} -T{ -2 * FenrirKey + CTRL + 8 -T}@T{ -clear window application (#Remove Window) -T} -T{ -FenrirKey + Semicolon -T}@T{ -read last incoming (#last incoming) -T} -T{ -FenrirKey + F2 -T}@T{ -toggles braille (#toggle braille) -T} -T{ -FenrirKey + F3 -T}@T{ -toggles sound (#toggle sound) -T} -T{ -FenrirKey + F4 -T}@T{ -toggles speech (#toggle speech) -T} -T{ -FenrirKey + Enter -T}@T{ -temporarily disables speech (#disable speech temporarily) -T} -T{ -FenrirKey + Shift + CTRL + P -T}@T{ -toggles punctuation level (#toggle punctuation level) -T} -T{ -FenrirKey + RightBrace -T}@T{ -toggle auto spell check (#toggle auto spell check) -T} -T{ -FenrirKey + Shift + Enter -T}@T{ -toggles output (#toggle output) -T} -T{ -FenrirKey + Shift + E -T}@T{ -toggles emoticons (#toggle emoticons) -T} -T{ -FenrirKey + Enter -T}@T{ -toggles auto read (#toggle auto read) -T} -T{ -FenrirKey + CTRL + T -T}@T{ -toggles auto time (#toggle auto time) -T} -T{ -FenrirKey + Y -T}@T{ -toggles highlight tracking (#toggle highlight tracking) -T} -T{ -FenrirKey + Q -T}@T{ -quits fenrir (#quit Fenrir) -T} -T{ -FenrirKey + T -T}@T{ -Announce time (#Time) -T} -T{ -2 * FenrirKey + T -T}@T{ -Announce date (#Date) -T} -T{ -FenrirKey + S -T}@T{ -spell check (#spell check) -T} -T{ -2 * FenrirKey + S -T}@T{ -add word to spell check (#add word to spell check) -T} -T{ -FenrirKey + Shift + S -T}@T{ -removes word from spell check (#removes word from spell check) -T} -T{ -FenrirKey + Backspace -T}@T{ -forward keypress (#forward keypress) -T} -T{ -FenrirKey + Up -T}@T{ -increase speech volume (#increase speech volume) -T} -T{ -FenrirKey + Down -T}@T{ -decrease speech volume (#decrease speech volume) -T} -T{ -FenrirKey + Right -T}@T{ -increase speech rate (#increase speech rate) -T} -T{ -FenrirKey + Left -T}@T{ -decrease speech rate (#decrease speech rate) -T} -T{ -FenrirKey + Alt + Right -T}@T{ -increase speech pitch (#increase speech pitch) -T} -T{ -FenrirKey + Alt + Left -T}@T{ -decrease speech pitch (#decrease speech pitch) -T} -T{ -FenrirKey + Alt + Up -T}@T{ -increase sound volume (#increase sound volume) -T} -T{ -FenrirKey + Alt + Down -T}@T{ -decrease sound volume (#decrease sound volume) -T} -T{ -FenrirKey + CTRL + Shift + C -T}@T{ -clears clipboard (#clear clipboard) -T} -T{ -FenrirKey + Home -T}@T{ -first clipboard (#first clipboard) -T} -T{ -FenrirKey + End -T}@T{ -last clipboard (#last clipboard) -T} -T{ -FenrirKey + PageUp -T}@T{ -previous clipboard (#previous clipboard) -T} -T{ -FenrirKey + PageDown -T}@T{ -next clipboard (#next clipboard) -T} -T{ -FenrirKey + Shift + C -T}@T{ -current clipboard (#read current clipboard) -T} -T{ -FenrirKey + C -T}@T{ -copy marked text to clipboard (#copy marked to clipboard) -T} -T{ -FenrirKey + V -T}@T{ -paste clipboard contents (#paste clipboard) -T} -T{ -FenrirKey + F5 -T}@T{ -import clipboard from file (#import clipboard from file) -T} -T{ -FenrirKey + Alt + Shift +C -T}@T{ -export clipboard to file (#export clipboard to file) -T} -T{ -FenrirKey + CTRL + Shift + X -T}@T{ -remove marks (#Remove Marks) -T} -T{ -FenrirKey + X -T}@T{ -set mark (#Set mark) -T} -T{ -FenrirKey + Shift + X -T}@T{ -announce marked text (#Get text between marks) -T} -T{ -Linux specific -T}@T{ -T} -T{ -\f[C]\f[] -T}@T{ -export clipboard to X -T} -T{ -FenrirKey + CTRL + Up -T}@T{ -increases Alsa volume -T} -T{ -FenrirKey + CTRL + Down -T}@T{ -decreases Alsa volume -T} -.TE -.SS General -.SS quit Fenrir -.PP -Just stops fenrir. -#### shut up -.PP -Interrupt the current spoken. -### Review Modes -.PP -Fenrir provides a virtual cursor, with it you can navigate all over the -screen without changing the text cursor. -.PP -Using the review feature will open the review mode automatically. -.PP -The review cursor always starts from the text cursor. -Attention: after using the review mode, the review cursor will stay open -until you use the \[aq]\[aq]exit review\[aq]\[aq] shortcut. -.PP -Think when using clipboard operations and similar. -The review cursor is always prefered over the text cursor. -.PP -Fenrir sounds a bell sound if the used review command jumps to another -line or end of screen. -#### exit review -.PP -You can leave the review mode by pressing the \[aq]\[aq]exit -review\[aq]\[aq] shortcut. -#### review bottom -.PP -Set the review cursor to first column in the last line. -#### review top -.PP -Set the review cursor to the first column in the first line #### review -current line -.PP -Set the review cursor to the beginn of the the current line and review -it. -#### review previous line -.PP -Set the review cursor to the previous line and review it. -#### review next line -.PP -Set the review cursor to the next line and review it. -#### review line beginning -.PP -Set the review cursor to the begin of the current line #### review line -ending -.PP -Set the review cursor to the end of the current line #### review line -first character -.PP -Set the review cursor the first char (that is not space) in the current -line and review it. -#### review line last character -.PP -Set the review cursor the last char (that is not space) in the current -line and review it. -#### review current word -.PP -Sets the review cursor to the beginning of the current word and review -it. -#### review previous word -.PP -Sets the review cursor to the beginning of the previous word and review -it. -#### review next word -.PP -Sets the review cursor to the beginning of the next word and review it. -#### review current word phonetic -.PP -Sets the review cursor to the beginning of the current word and spell it -phonetic. -#### review previous word phonetic -.PP -Sets the review cursor to the beginning of the previous word and spell -it phonetic. -#### review next word phonetic -.PP -Sets the review cursor to the beginning of the next word and spell it -phonetic. -#### review current character -.PP -Does not change the review cursor. -Just announce the current char. -#### review previous character -.PP -Sets review cursor to the previous column and review it #### review next -character -.PP -Sets review cursor to the next column and review it #### review current -character phonetic -.PP -Does not change the review cursor. -Just announce the current char phonetic. -#### review previous character phonetic -.PP -Sets review cursor to the previous column and announce the char -phonetic. -#### review next character phonetic -.PP -Sets review cursor to the next column and announce the char phonetic. -#### review up -.PP -Set the review cursor in the same column one line above the current one -and review it. -#### review down -.PP -Set the review cursor in the same column one line below the current one -and review it. -### Handling marking -.PP -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: -.IP \[bu] 2 -copy to clipboard -.IP \[bu] 2 -set window application -.IP \[bu] 2 -set bookmark 1 \- X #### Set mark -.PP -How to set a mark: 1. -navigate with review or textcursor to the position you want to set the -mark. -Attention: if a review cursor is set, that is the prefered. -If you want to use text cursor, be sure that you are not in review mode. -2. -press shortcut for \[aq]\[aq]set mark\[aq]\[aq] 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 -.PP -To get the text that is currently between your marks press shortcut for -\[aq]\[aq]marked text\[aq]\[aq].\\ #### Remove Marks -.PP -You can remove all current marks by pressing the shortcut for -\[aq]\[aq]remove marks\[aq]\[aq]. -Changing the screen also removes the marks. -### Screen Interaction -.PP -Fenrir provides several methods to interact with the current screen. -#### forward keypress -.PP -This just forwards the next shortcut to the screen Fenrir shortcut or -not. -This is useful if the currently pressed shortcut is also in use by -Fenrir. -#### Clipboard -.PP -Fenrir provides a clipboard with multible items represented by a list. -You navigate throught the list and paste the selected clipboard. -##### copy marked to clipboard -.PP -To copy something 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 the first item on your -clipboard. -##### clear clipboard -.PP -You can remove all items from the current clipboard by \[aq]\[aq]clear -clipboard\[aq]\[aq] functionality. -##### first clipboard -.PP -This moves quick to the first item of the clipboard. -##### last clipboard -.PP -This moves quick to the last item of the clipboard. -##### previous clipboard -.PP -Go to previous item in the clipboard. -##### next clipboard -.PP -Go to next item on the clipboard. -##### read current clipboard -.PP -Read the content of the current item of the clipboard. -##### paste clipboard -.PP -Pass whatever item is currently selected by first, last, prev or next -clipboard commands. -if no special clipboard is selected the (last copied) is used. -##### export clipboard to file -.PP -This allows you to export the current clipboard to a configurable -filepath. -This is useful to share the clipboard with a graphical desktop. -##### import clipboard from file -.PP -Import a clipboard from a configurable file. -This is useful to share the clipboard with a graphical desktop. -### Quick Settings -.PP -Fenrir provides shortcuts to change settings temporarily and on the fly -without the need to permanently change the -\[aq]\[aq]settings.conf\[aq]\[aq] file. -#### toggle braille -.PP -Enables and disables Braille. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### toggle sound -.PP -Enables and disables sound. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### toggle speech -.PP -Enables and disables speech. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### disable speech temporarily -.PP -Disables the speech until next key press. -it might be useful if you want to listen to music or similar. -As soon as a key is pressed it is going to be enabled again. -#### toggle punctuation level -.PP -Cycle between all available punctuation levels. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### toggle auto spell check -.PP -Enables and disables automatic spellchecker (when typing). -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### toggle emoticons -.PP -Enables and disables emoticons. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### toggle output -.PP -Enables and disables all output at once (sound, Braille, speech). -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### toggle auto read -.PP -Enables and disables what is automatically spoken. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### toggle auto time -.PP -Enables and disables auto time functionality. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### toggle highlight tracking -.PP -Enables and disables highlight tracking. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during run time. -#### increase speech volume -.PP -Increase the volume of the speech. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### decrease speech volume -.PP -Decrease the volume of the speech. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### increase speech rate -.PP -Increase the rate of the speech. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### decrease speech rate -.PP -Decrease the rate of the speech. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### increase speech pitch -.PP -Increase the pitch of the speech. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### decrease speech pitch -.PP -Decrease the pitch of the speech. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### increase sound volume -.PP -Increase the volume of the sound. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -#### decrease sound volume -.PP -Decrease the volume of the sound. -This is not persistent stored in your \[aq]\[aq]settings.conf\[aq]\[aq] -but during runtime. -### Window Mode -.PP -Fenrir supports window mode, a window is a partial area of the screen. -#### Create Window -.PP -To create a window you need to do the following: 1. -set a beginning mark (as the start of the window) 2. -set an end mark (where the window should end) 3. -press \[aq]\[aq]set window application\[aq]\[aq] shortcut. -Now Fenrir ignores anything outside of the window.\\ #### Remove Window -.PP -You can remove the window by pressing \[aq]\[aq]the clear window -application\[aq]\[aq] shortcut. -Now Fenrir will read everything on the screen again. -### Tracking Modes -.PP -Different types of tracking are currently supported See section -Focus (#Focus) in \[aq]\[aq]settings.conf\[aq]\[aq] for more -information. -#### Cursor Tracking -.PP -This follows the text cursor. -This is the typical way an application works. -This is used by: -.IP \[bu] 2 -almost any shell such as (Bash, Zsh, sh) -.IP \[bu] 2 -vim -.IP \[bu] 2 -nano -.IP \[bu] 2 -emacs -.IP \[bu] 2 -mutt -.IP \[bu] 2 -tintin++ #### Highlight Tracking -.PP -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 announces these changes for you. -This is used by: -.IP -.nf -\f[C] -*\ wifi\-menu -*\ dialog -*\ alpine -\f[] -.fi -.SS Tutorial Mode -.PP -Fenrir provides a Tutorial mode. -When you enter tutorial mode, screen reader commands are intercepted and -explained instead of executing them. -\[aq]\[aq]Arrow up\[aq]\[aq] and \[aq]\[aq]Arrow Down\[aq]\[aq] let you -navigate through a list of all available commands with shortcuts and -description. -Pressing escape leaves the tutorial mode. -.SS Information -.SS Time -.PP -Announces the current Time. -#### Date -.PP -Announces the current Date. -#### Bookmarks -.PP -Bookmarks provide quick access to part of the screen without the need to -navigate to the area. -By default Fenrir provides 10 bookmarks. -Those can be set and accessed via shortcut. -This is useful for status lines or other information where the position -does not change. -##### set Bookmark X -.PP -You need to set the bookmark first. -For that you have to set one or two lines for use. -1. -Set marks (one or two) 2. -press shortcut for \[aq]\[aq]set bookmark X\[aq]\[aq]. -X represents the number 1 \- 10. -##### read Bookmark X -.PP -If a bookmark is set you can access the area just by pressing the -\[aq]\[aq]bookmark X\[aq]\[aq] shortcut. -X represents the number 1 \- 10. -Bookmarks are dynamic. -That means the content changes with the screen. -##### clear Bookmark X -.PP -to remove a bookmark just press the \[aq]\[aq]clear bookmark X\[aq]\[aq] -shortcut. -X represents the number 1 \- 10. -Afterward the bookmark is no longer available. -#### cursor position -.PP -You can get information about the current cursor and its position by -using the "cursor position" functionality. -#### indent current line -.PP -Announce the current indent level of the current line. -It represents the number of trailing spaces of the line. -#### current screen -.PP -Reads all the current screen from the beginning to the end. -#### current screen before cursor -.PP -Reads current screen from the beginning of the screen to the current -cursor position. -#### current screen after cursor -.PP -Read anything after current cursor position to the end. -#### cursor read to end of line -.PP -Read from the current cursor position to the end of the current line. -#### cursor column -.PP -Read the current X position of a cursor (column of the current line). -#### cursor line number -.PP -Read the current Y position of a cursor (line number). -#### present first line -.PP -Reads just the first line. -this is maybe useful for status information. -#### present last line -.PP -Presets the last line. -This is maybe useful for status information. -#### last incoming -.PP -Repeat the last automatically incoming text. -## Input -.SS Echo -.PP -Fenrir provides different methods of echoing content: -.IP \[bu] 2 -Word: Will speak each word after you push space -.IP \[bu] 2 -Character: speak any letter you type on the screen -.IP \[bu] 2 -Delete Character: speaks the character prior to the cursor when you push -backspace ### Silence on Key press -.SS Spellchecker -.PP -Fenrir has a built\-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\-\f[C]\f[]. -See section General (#General) in \[aq]\[aq]settings.conf\[aq]\[aq] for -more information. -#### spell check -.PP -Invokes the spellcheck on the word that contains the Review or text -cursor. -#### add word to spell check -.PP -Adds the word under the Review or Text cursor to the dictionary. -#### removes word from spell check -.PP -Removes the word under the Review or Text cursor from the dictionary. -## Announcements -.SS Emoticons -.PP -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 a dictionary, please see Emoticon -Dictionary. -See section General (#General) in \[aq]\[aq]settings.conf\[aq]\[aq] to -see how to enable or disable this feature. -.SS Time -.PP -Announce the time at periodical increments, To track the time easily. -You can define 2 different ways of time announcements. -1. -periodic 2. -on fix minutes -.PP -Example periodic, every 20 minutes "delaySec=20": -.IP -.nf -\f[C] -[time] -enabled=True -presentTime=True -presentDate=True -delaySec=20 -onMinutes= -announce=True -interrupt=False\ \ \ \ -\f[] -.fi -.PP -Example on fix minutes in an hour. -example every quarter "delaySec=0" and "onMinutes=00,15,30,45": -.IP -.nf -\f[C] -[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\ \ \ \ \ \ -\f[] -.fi -.SS Promoted List -.PP -Promoted Lists are a nice feature if you are away from your computer or -performing more longer tasks. -you can define a list of words which you want to hear a sound icon for -after a period of inactivity. -Example if the word "Chrys" appears after 120 Seconds of inactivity: -[promote] enabled=True -.PD 0 -.P -.PD -inactiveTimeoutSec=120 list=Chrys See section Promote (#Promote) in -\[aq]\[aq]settings.conf\[aq]\[aq] for more information. -### Punctuation -.PP -Fenrir handles punctuation levels and names for you with several -provided dictionaries. -.PP -See levelDict See punctuationDict ## Braille -.PP -Fenrir provides Braille support in Version >= 2.0. -See section Braille (#Braille) in \[aq]\[aq]settings.conf\[aq]\[aq] for -more information. -### braille flush -.PP -If a message appears on the Braille device you can flush it to get back -to the review\- or system cursor ### Braille pan left -.PP -If a line is longer than your Braille devices you can move the view -(called panning) to the left. -So you can read stuff without the need to move the review\- or system -cursor. -### Braille pan right -.PP -If a line is longer than your Braille devices you can move the view -(called panning) to the right. -So you can read stuff without the need to move the review\- or system -cursor. -### braille return to cursor -.PP -When you have finished reading the line on the Braille device using -panning, the focus can be returned to the current used cursor by using -"return to cursor" command. -## Dictionary -.PP -You can make use of different kinds of built\-in dictionary\[aq]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 -.SS Level -.PP -The punctuation level dict contains lists with "what punctuation is -spoken in what level". -the default one looks like this: [levelDict] none:===: -some:===:.\-$~+*\-/\\\@ most:===:.,:\-$~+*\-/\@!#%^&\f[I]()[]}{\f[C]<>\f[]; -all:===:!"#$%& \[aq]()\f[]+,\-./:;\f[C]<=>\f[]?\@[\\]^_`{|}~ 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 they are recognized. -the default punctuation level is set in settings.conf. -The default is "some". -#### Punctuation -.PP -The punctuation dictionary "[punctDict]" contains how the punctuation is -spoken. -Example: [punctDict] \f[I]:===:line -.PD 0 -.P -.PD -speaks an \f[] as "line". -.PD 0 -.P -.PD -[punctDict] \f[I]:===:underscore speaks an \f[] as underscore. -for question mark an ? -is appended to the word that the TTS system can announce the question -correctly. -.PD 0 -.P -.PD -### Custom -.PP -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. -:) ### Emoticons -.PP -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 perryns not smiles. -# Configuration -.PP -You can configure Fenrir in the following places (ordered by priority): -1. -Commandline Parameters \[aq]\[aq]\-o\[aq]\[aq] see Set settings -coption (#Set settings coption) 2. -/etc/fenrir/settings/settings.conf see Settigns (#Settings) 3. -\f[C]\f[]/config/settings/settings.conf see -Settigns (#Settings) 4. -hard coded defaults ## Commandline Arguments -.SS Set settings option -.PP -You can specify options that overwrite the setting.conf. -This is done with \[aq]\[aq]\-o \f[C]\f[] parameter. -The list of options have the following syntax fenrir \-o -"section#setting=value;section#setting=value" -.PP -For example changing the sound driver to gstreamer and disabling Braille -.PD 0 -.P -.PD -fenrir \-o "sound#driver=gstreamerDriver;braille#enabled=False=False" or -change the debug level to verbose fenrir \-o "general#debugLevel=3" You -can find the available sections and variables here <#Settings> See -Syntax #settings.conf syntax (#settings.conf syntax) ### settings.conf -syntax -.PP -the syntax of the settings.conf (#Settings) is quite simple and similar -to a "*.ini" file, there are 4 different elements. -1. -Sections 2. -Settings 3. -Values 4. -Comments -.PP -A comment starts with a # and is ignored by Fenrir. -# this is a comment To group settings we have sections. -A section can look like this: [Section] A setting looks like this: -settingName=Value -.PP -Example: sound (#sound) # Turn sound on or off: enabled=True # Select -the driver used to play sounds, choices are genericDriver and -gstreamerDriver. -# Sox is default. -driver=genericDriver -.SS Settings -.SS Sound -.PP -The sound is configured in section \[aq]\[aq]sound (#sound)\[aq]\[aq]. -.PP -Turn sound on or off: enabled=True Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.PP -Select the driver used to play sounds. -The genericDriver using Sox is the default. -.IP -.nf -\f[C] -driver=genericDriver -\f[] -.fi -.PP -Available Drivers: -.IP \[bu] 2 -\[aq]\[aq]genericDriver\[aq]\[aq] using the generic driver, for Fenrir -<1.5 just use \[aq]\[aq]generic\[aq]\[aq] -.IP \[bu] 2 -\[aq]\[aq]gstreamerDriver\[aq]\[aq] using the gstreamer, for Fenrir <1.5 -just use \[aq]\[aq]gstreamer\[aq]\[aq] -.PP -These are the pack of sounds used for sound icons. -theme=default By default we ship two sound packs. -1. -\[aq]\[aq]default\[aq]\[aq] opus encoded, for newer Sox versions 2. -\[aq]\[aq]default\-wav\[aq]\[aq] wav encoded, just for compatibility -Sound packs are located at /usr/share/sounds/fenrirscreenreader/ -.PP -Sound volume controls how loud the sounds for your selected sound pack -are. -volume=1.0 Values: \[aq]\[aq]0.0\[aq]\[aq] is quietest, -\[aq]\[aq]1.0\[aq]\[aq] is loudest. -.SS Generic Driver -.PP -The generic sound driver uses shell commands for play sound and -frequencies. -.PP -\[aq]\[aq]genericPlayFileCommand\[aq]\[aq] defines the command that is -used to play a sound file. -genericPlayFileCommand=\f[C]\f[] -\[aq]\[aq]genericFrequencyCommand\[aq]\[aq] defines the command that is -used playing frequencies. -genericFrequencyCommand=\f[C]\f[] -.PP -The following variables are substituted in -\[aq]\[aq]genericPlayFileCommand\[aq]\[aq] and -\[aq]\[aq]genericFrequencyCommand\[aq]\[aq]: -.IP \[bu] 2 -\[aq]\[aq]fenrirVolume\[aq]\[aq] = the current volume setting -.IP \[bu] 2 -\[aq]\[aq]fenrirSoundFile\[aq]\[aq] = the sound file for an sound icon -.IP \[bu] 2 -\[aq]\[aq]fenrirFrequence\[aq]\[aq] = the frequency to play -.IP \[bu] 2 -\[aq]\[aq]fenrirDuration\[aq]\[aq] = the duration of the frequency -.PP -Example genericPlayFileCommand (default) genericPlayFileCommand=play \-q -\-v fenrirVolume fenrirSoundFile Example genericFrequencyCommand -(default) genericFrequencyCommand=play \-q \-v fenrirVolume \-n \-c1 -synth fenrirDuration sine fenrirFrequence ### Speech -.PP -Speech is configured in section \[aq]\[aq][speech]\[aq]\[aq]. -Turn speech on or off: enabled=True Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.SH Select speech driver, options are speechdDriver (default), -genericDriver or espeakDriver: -.PP -driver=speechdDriver #driver=espeakDriver -.SH driver=genericDriver -.PP -Select the driver used to generate speech output. -.IP -.nf -\f[C] -driver=speechdDriver -\f[] -.fi -.PP -Available Drivers: -.IP \[bu] 2 -\[aq]\[aq]genericDriver\[aq]\[aq] using the generic driver, for Fenrir -<1.5 this is not available -.IP \[bu] 2 -\[aq]\[aq]speechdDriver\[aq]\[aq] using speech\-dispatcher, for Fenrir -<1.5 just use \[aq]\[aq]speechd\[aq]\[aq] -.IP \[bu] 2 -\[aq]\[aq]espeakDriver\[aq]\[aq] using the espeak directly, for Fenrir -<1.5 just use \[aq]\[aq]espeak\[aq]\[aq] -.PP -The rate selects how fast Fenrir will speak. -rate=0.65 Values: Range Minimum:\[aq]\[aq]0.0\[aq]\[aq] is slowest, -Maximum:\[aq]\[aq]1.0\[aq]\[aq] is fastest. -.PP -Pitch controls the pitch of the voice. -pitch=0.5 Values: Range Minimum:\[aq]\[aq]0.0\[aq]\[aq] is lowest, -Maximum:\[aq]\[aq]1.0\[aq]\[aq] is highest. -.PP -A Pitch for capital letters can be set. -capitalPitch=0.9 Values: Range Minimum:\[aq]\[aq]0.0\[aq]\[aq] is -lowest, Maximum:\[aq]\[aq]1.0\[aq]\[aq] is highest. -.PP -The Volume controls the loudness of the voice. -volume=1.0 Values: Range Minimum:\[aq]\[aq]0.0\[aq]\[aq] is quietest, -Maximum:\[aq]\[aq]1.0\[aq]\[aq] is loudest. -.PP -Some speech drivers like speechdDriver can support various modules. -these can be set here. -module=espeak Values: Text, Consult speech\-dispatcher\[aq]s -configuration to see what modules are available. -.PP -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. -.PP -Select the language you want Fenrir to use. -language=english\-us Values: Text, see your TTS synths documentation -what is available. -.PP -Read new text as it occurs autoReadIncoming=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.SS Generic Driver -.PP -The generic speech driver uses shell commands for speech synthisus. -.PP -\[aq]\[aq]genericSpeechCommand\[aq]\[aq] defines the command that is -executed for creating speech The following variables are substituted in -\[aq]\[aq]genericSpeechCommand\[aq]\[aq]: -.IP \[bu] 2 -\[aq]\[aq]FenrirText\[aq]\[aq] = is the text that should be spoken -.IP \[bu] 2 -\[aq]\[aq]fenrirModule\[aq]\[aq] = may be the speech module like used in -speech\-dispatcher, not every TTY needs this -.IP \[bu] 2 -\[aq]\[aq]fenrirLanguage\[aq]\[aq] = the language to speak in -.IP \[bu] 2 -\[aq]\[aq]fenrirVoice\[aq]\[aq] = is the current voice that should be -used -.IP \[bu] 2 -\[aq]\[aq]fenrirVolume\[aq]\[aq] = is replaced with the current volume -.IP \[bu] 2 -\[aq]\[aq]fenrirPitch\[aq]\[aq] = is replaced with the current pitch -.IP \[bu] 2 -\[aq]\[aq]fenrirRate\[aq]\[aq] = is replaced with the current speed -(speech rate) -.PP -Example genericSpeechCommand (default): genericSpeechCommand=espeak \-a -fenrirVolume \-s fenrirRate \-p fenrirPitch \-v fenrirVoice "fenrirText" -.PP -These are the minimum and maximum values of the TTS system used in -genericSpeechCommand. -They are needed to calculate the abstract range in volume, rate and -pitch 0.0 \- 1.0. -.IP -.nf -\f[C] -FenrirMinVolume=0 -fenrirMaxVolume=200 -fenrirMinPitch=0 -fenrirMaxPitch=99 -fenrirMinRate=80 -fenrirMaxRate=450 -\f[] -.fi -.PP -The current volume, pitch and rate is calculated like this value = min + -[volume,pitch,rate] * (min \- max ) ### Braille -.PP -Braille is a WIP and not ready yet. -Braille support can be configured in section -\[aq]\[aq][braille]\[aq]\[aq]. -.PP -Turn braille on or off: enabled=False Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Select the driver used for communication with a braille device. -driver=brlapiDriver Values: Text, available Driver Available Drivers: -.IP \[bu] 2 -\[aq]\[aq]brlttyDriver\[aq]\[aq] using brltty for braille communication, -for Fenrir <1.5 just use \[aq]\[aq]brltty\[aq]\[aq] -.PP -The Braille layout can be configured here layout=en Values: Text, see -braille driver for layouts. -.PP -What should the flush timeout relate to flushMode=word Values: Text, an -flushMode Existing flushModes: -.IP \[bu] 2 -\[aq]\[aq]word\[aq]\[aq] = flush after (number of words to display) * -seconds -.IP \[bu] 2 -\[aq]\[aq]char\[aq]\[aq] = flush after (number of chars to display) * -seconds -.IP \[bu] 2 -\[aq]\[aq]fix\[aq]\[aq] = flush after X seconds -.IP \[bu] 2 -\[aq]\[aq]none\[aq]\[aq] = no automatic flush (manual via shortcut) -.PP -Seconds to flush (see flushMode) flushTimeout=3 Values: Integer, in -Seconds or \[aq]\[aq]\-1\[aq]\[aq] = no automatic flush (manual via -shortcut) The total flush time calculates in relation to flushMode. -.PP -How should the Braille cursor focus be tracked? -cursorFocusMode=page Values: Text, an existing cursor focus mode -Available cursor focus modes: -.IP \[bu] 2 -\[aq]\[aq]page\[aq]\[aq] = if the cursor crosses the border move to next -page and start at begin -.IP \[bu] 2 -\[aq]\[aq]fixCell\[aq]\[aq] = ajust the cursor on a special cell where -it is always placed. -the display scroll here more smooth. -.PP -Define the cell on the Braille device where Fenrir should scroll and -keep the cursor fixCursorOnCell=\-1 Values: Integer -.IP \[bu] 2 -\[aq]\[aq]0\[aq]\[aq] = first cell on device, -.IP \[bu] 2 -\[aq]\[aq]\-1\[aq]\[aq] = last cell on device -.IP \[bu] 2 -\[aq]\[aq]>0\[aq]\[aq] = fix cell number -.PP -What cursor should Fenrir show on the Braille device -cursorFollowMode=review Values: Text, an exsiting cursor following mode. -Existing cursor following mode: -.IP \[bu] 2 -\[aq]\[aq]none\[aq]\[aq] = no automatic toggle command used -.IP \[bu] 2 -\[aq]\[aq]review\[aq]\[aq] = priority to review -.IP \[bu] 2 -\[aq]\[aq]last\[aq]\[aq] = follow last used cursor -.PP -number of cells in panning (horizontal). -How many cell should be panned on press the routing key? -panSizeHorizontal=0 Values: Integer, -.IP \[bu] 2 -\[aq]\[aq]0\[aq]\[aq] = display size -.IP \[bu] 2 -\[aq]\[aq]>0\[aq]\[aq] number of cells ### Screen -.PP -The settings for screens, (TTY, PTY) are configured in the -\[aq]\[aq][screen]\[aq]\[aq] section. -.PP -The driver to get the information from the screen: driver=vcsaDriver -Available Drivers: -.IP \[bu] 2 -\[aq]\[aq]vcsaDriver\[aq]\[aq] using the VCSA driver (for TTYs), for -Fenrir <1.5 just use \[aq]\[aq]vcsa\[aq]\[aq] The encoding of the screen -encoding=cp850 Values:\[aq]\[aq]cp850\[aq]\[aq] is used for Western -languages like USA or Europe. -.PP -The driver updates Fenrir with changes on the screen. -screenUpdateDelay=0.05 Values: in Seconds -.PP -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 -\[aq]\[aq],\[aq]\[aq] with: suspendingScreen= Values: Depends on driver: -.IP \[bu] 2 -VCSA: the number of the TTY. -TTY6 is \[aq]\[aq]6\[aq]\[aq]. -Example ignore TTY1 and TTY2: suspendingScreen=1,2 -.PP -There is also the ability to let Fenrir auto detect screens that are -running an X server. -So Screens running an GUI can be ignored. -autodetectSuspendingScreen=True Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.SS Keyboard -.PP -The settings for keyboard and input related configuration is located in -the section \[aq]\[aq]keyboard (#keyboard)\[aq]\[aq] of the -\[aq]\[aq]settings.conf\[aq]\[aq] file. -.PP -Select the driver used for grabbing keybord input and for recieving -shortcuts. -driver=evdevDriver Values: Text, available Driver Available Drivers: -.IP \[bu] 2 -\[aq]\[aq]evdevDriver\[aq]\[aq] uses the evdev input system of linux, -for Fenrir <1.5 just use \[aq]\[aq]evdev\[aq]\[aq] -.PP -You can let Fenrir know about what input devices are to be used. -device=ALL Values: -.IP \[bu] 2 -\[aq]\[aq]ALL\[aq]\[aq] use all devices with key capabilities. -.IP \[bu] 2 -\[aq]\[aq]NOMICE\[aq]\[aq] Exclude mices from handling. -.IP \[bu] 2 -\f[C]\f[] just use the device with the given name. -.PP -Gives Fenrir exclusive access to the keyboard and lets it control -keystrokes. -This is needed to intercept Fenrir related shortcuts. -grabDevices=True Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.PP -The following makes sense if you are using a second screenreader and -want to have some hooked events. -Fenrir ignores all shortcuts then. -ignoreShortcuts=False Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.PP -The current keyboard layout used for shortcuts. -keyboardLayout=desktop Values: An absolute Path to a Keyboard definition -file or a Filename without extension located in -\[aq]\[aq]/etc/fenrir/keyboard\[aq]\[aq] -.PP -Announce characters while typing. -charEcho=False Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.PP -Announce deleted characters charDeleteEcho=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Announce word after pressing space wordEcho=False Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Interrupt speech on any keypress interruptOnKeyPress=False Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -You can filter the keys that speech should interrupt -interruptOnKeyPressFilter= Values: (List) empty = all keys, otherwise -interrupt with specified keys -.PP -The timeout that is used for double tap shortcuts doubleTapTimeout=0.2 -Values: Seconds ### General -.PP -Overall settings can be configured from the section -\[aq]\[aq]general (#general)\[aq]\[aq]. -.PP -Set the current debug level: debugLevel=1 Values: off=0, error=1, -warning=2, info=3 -.PP -the current punctuation and dict file in use: punctuationProfile=default -Values: Text, see available profiles in -\[aq]\[aq]/etc/fenrir/punctuation\[aq]\[aq] or in -\[aq]\[aq]sourceTree/config/punctuation\[aq]\[aq] -.PP -The current punctuation level in use: punctuationLevel=some Values: -Text, See available levels in the used punctuation file. -.PP -Respect pause for punctuations: respectPunctuationPause=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Add a pause on Line break: newLinePause=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Specify the path where the clipboard should be exported to. -See export clipboard to file (#export clipboard to file). -The variable \[aq]\[aq]$user\[aq]\[aq] is replaced by the current logged -username. -clipboardExportPath=/tmp/fenrirClipboard Values: Text, Systemfilepath -.PP -The number of available clipboards: numberOfClipboards=10 Values: -Integer, 1 \- 999 -.PP -Replace emoticons like :) or ;) with text insertions: emoticons=True -Values: on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Define the current Fenrir keys: fenrirKeys=KEY_KP0,KEY_META,KEY_INSERT -Values, Text list, separated by comma. -.PP -Define the current script keys: scriptKey=KEY_COMPOSE Values, Text list, -separated by comma. -.PP -The time format to be used for (time command) output: -timeFormat=%H:%M:%P Values: see python specification for -datetime.strftime (https///docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior) -.PP -The date format to be used for (date command) output: dateFormat=%A, %B -%d, %Y Values: see python specification for -datetime.strftime (https///docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior) -.PP -Enable or Disable spellcheck whilst typing: autoSpellCheck=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -The use of the dictionary with spellcheck: spellCheckLanguage=en_US -Values: Text, see aspell dictionary\[aq]s. -.PP -Folder Path for your scripts "scriptKey" functionality: -scriptPath=/usr/share/fenrirscreenreader/scripts Values: Text, Existing path on file -system. -.PP -Override commands or create new ones without changing the Fenrir -defaults: commandPath=/usr/share/fenrirscreenreader/commands Values: Text, Existing -path on file system. -Subfolders in commandPath are: -.IP \[bu] 2 -\[aq]\[aq]commands\[aq]\[aq] = to create shortcut commands -.IP \[bu] 2 -\[aq]\[aq]onInput\[aq]\[aq] = executed while typing -.IP \[bu] 2 -\[aq]\[aq]onScreenChange\[aq]\[aq] = executed on change the screen -(change from TTY4 to TTY6) -.IP \[bu] 2 -\[aq]\[aq]onScreenUpdate\[aq]\[aq] = executed when the screen is -captured -.SS Focus -.PP -The configuration for basic focus is in the section -\[aq]\[aq]focus (#focus)\[aq]\[aq]. -Follow the text cursor: cursor=True Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.PP -Follow highlighted text changes (Highlight Tracking): highlight=False -Values: on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] ### -Review -.PP -Configurations for the review mode are in the section -\[aq]\[aq][review]\[aq]\[aq]. -.PP -If "next word/ char" or "prev word/char" create a linebreak, announce -it: lineBreak=True Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] -.PP -If "next word/ char" or "prev word/char" cannot be performed because you -reached the end of the screen, announce it: endOfScreen=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Leave the review mode when pressing a key: leaveReviewOnKeypress=False -Values: on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Leave the review mode when changing the screen (From TTY3 to TTY4): -leaveReviewOnScreenChange=True Values: on=\[aq]\[aq]True\[aq]\[aq], -off=\[aq]\[aq]False\[aq]\[aq] ### Promote -.PP -"Promoted Lists" are configured in the section -\[aq]\[aq][promote]\[aq]\[aq]. -Turn Promoted Lists" on or off: enabled=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -The minimum time interval of inactivity to activate promoting. -By default it promotes after 120 Seconds inactivity: -inactiveTimeoutSec=120 Values: in Seconds -.PP -Define a list of promoted words comma seperated: list= Values: text -(comma seperated) Example to promote the word "nickname" or a bash -prompt: list=nickname,$:,#: -.SS Time -.PP -The automated time announcement is configured in the section -\[aq]\[aq]time (#time-2)\[aq]\[aq]. -Time announcement is disabled by default. -Turn time announcement on or off: enabled=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Should the time be announced: presentTime=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Should the date be announced (just on date change): presentDate=True -Values: on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Announce after a given period of seconds: delaySec=0 Value: in Seconds, -0 = Deactivated -.PP -Announce after fixed minutes in an hour. -if delaySec is >0 onMinutes is ignored: onMinutes=00,30 Example every 15 -minutes: onMinutes=00,15,30,45 -.PP -Just play a soundicon, (not interrupting): announce=True Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] -.PP -Interrupt current speech for time announcement: interrupt=False Values: -on=\[aq]\[aq]True\[aq]\[aq], off=\[aq]\[aq]False\[aq]\[aq] # -Customization -.SS Scripting -.PP -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 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 \f[B]\-\f[]. -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__\-__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 parameters from fenrir when it is executed. -So that information is available in your script then. -.SS Parameterlist -.PP -.TS -tab(@); -l l. -T{ -Parameter -T}@T{ -Content -T} -_ -T{ -$1 -T}@T{ -Username of the current logged in user -T} -.TE -.SS Examples -.PP -Script that just speaks the current username when pressing ScriptKey + -H.\\ File: -\[aq]\[aq]/usr/share/fenrirscreenreader/scripts/helloWorld__\-__key_h.sh\[aq]\[aq]: -#!/bin/bash echo $1 -.SS Commands -.PP -You can place your own commands in "/usr/share/fenrirscreenreader/commands" (path is -configurable in settings.conf). -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: -"date.py" (https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/date.py) -(announce the Date), -"shut_up.py" (https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/shut_up.py) -(interrupt output) the basic scheme for a command is as follows: -.IP -.nf -\f[C] -from\ core\ import\ debug +.TH FENRIR 1 "2025" "Fenrir Screen Reader" "User Commands" +.SH NAME +fenrir \- A modern, modular console screen reader for Linux -class\ command(): -\ \ def\ __init__(self): -\ \ \ \ \ \ pass -\ \ def\ initialize(self,\ environment): -\ \ \ \ \ \ self.env\ =\ environment -\ \ def\ shutdown(self): -\ \ \ \ \ \ pass -\ \ def\ getDescription(self): -\ \ \ \ \ \ return\ _(\[aq]No\ description\ found\[aq]) -\ \ def\ run(self): -\ \ \ \ \ \ pass -\ \ def\ setCallback(self,\ callback): -\ \ \ \ \ \ pass -\f[] -.fi +.SH SYNOPSIS +.B fenrir +.RB [ \-h ] +.RB [ \-v ] +.RB [ \-f ] +.RB [ \-s +.IR SETTING-FILE ] +.RB [ \-o +.IR SECTION#SETTING=VALUE;.. ] +.RB [ \-d ] +.RB [ \-p ] +.RB [ \-e ] +.RB [ \-E ] +.RB [ \-F ] + +.SH DESCRIPTION +Fenrir is a modern, modular, flexible and fast console screen reader written in Python 3. +It provides spoken feedback for Linux console applications and supports multiple interface types including TTY, terminal emulators, and desktop environments. + +Fenrir features a modular driver architecture supporting multiple speech synthesizers, sound systems, input methods, and screen reading techniques. It includes advanced features like review mode, multiple clipboards, spell checking, bookmarks, and configurable key bindings. + +.SH OPTIONS +.TP +.BR \-h ", " \-\-help +Show help message and exit. + +.TP +.BR \-v ", " \-\-version +Show version information and exit. + +.TP +.BR \-f ", " \-\-foreground +Run Fenrir in the foreground instead of as a daemon. Useful for debugging and testing. + +.TP +.BR \-s ", " \-\-setting " " \fISETTING-FILE\fR +Path to a custom settings file. Default is /etc/fenrir/settings/settings.conf. + +.TP +.BR \-o ", " \-\-options " " \fISECTION#SETTING=VALUE;..\fR +Override settings file options. Format: SECTION#SETTING=VALUE;... (case sensitive). +Multiple settings can be separated by semicolons. + +.TP +.BR \-d ", " \-\-debug +Enable debug mode. Debug information will be logged to /var/log/fenrir.log. + +.TP +.BR \-p ", " \-\-print +Print debug messages to screen in addition to logging them. + +.TP +.BR \-e ", " \-\-emulated-pty +Use PTY emulation with escape sequences for input. This enables usage in desktop/X11/Wayland environments and terminal emulators. + +.TP +.BR \-E ", " \-\-emulated-evdev +Use PTY emulation with evdev for input (single instance mode). + +.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. + +.SH KEY CONCEPTS + +.SS Fenrir Key +The Fenrir Key is used to invoke screen reader commands. By default, the following keys act as Fenrir Keys: .IP \[bu] 2 -Template lives -here (https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/command_template.py) +Insert .IP \[bu] 2 -The class needs to have the name "command". +Keypad Insert .IP \[bu] 2 -"initialize" is running once whilst loading the command. +Meta (Super/Windows key) + +.SS Keyboard Layouts +Fenrir supports two main keyboard layouts: .IP \[bu] 2 -"shutdown" is running on unload like the command (quit fenrir) +.B Desktop Layout +\- Uses numeric keypad for navigation (recommended for desktop users) .IP \[bu] 2 -"getDescriptsion" just returns an string. -That String is used in Tutorial Mode. +.B Laptop Layout +\- Alternative bindings for keyboards without numeric keypad + +.SS Review Mode +Fenrir provides a virtual cursor that allows navigation around the screen without changing the text cursor position. This is essential for reviewing content without disrupting your work. + +.SH BASIC COMMANDS + +.SS Essential Navigation +.TP +.B Ctrl +Stop speech (shut up) + +.TP +.B Fenrir + H +Toggle tutorial mode (interactive help system) + +.TP +.B Fenrir + Q +Quit Fenrir + +.TP +.B Fenrir + Keypad 5 +Read current screen + +.TP +.B Keypad 8 +Read current line + +.TP +.B Keypad 5 +Read current word + +.TP +.B Keypad 2 +Read current character + +.TP +.B Fenrir + T +Announce current time + +.TP +.B Fenrir + S +Spell check current word + +.SS Review Commands (Desktop Layout) +.TP +.B Keypad 7 +Review previous line + +.TP +.B Keypad 9 +Review next line + +.TP +.B Keypad 4 +Review previous word + +.TP +.B Keypad 6 +Review next word + +.TP +.B Keypad 1 +Review previous character + +.TP +.B Keypad 3 +Review next character + +.TP +.B Fenrir + Keypad dot +Exit review mode + +.SS Clipboard Operations +.TP +.B Fenrir + C +Copy marked text to clipboard + +.TP +.B Fenrir + V +Paste clipboard contents + +.TP +.B Fenrir + Shift + C +Read current clipboard + +.TP +.B Fenrir + X +Set mark (for text selection) + +.TP +.B Fenrir + Shift + X +Announce marked text + +.SH CONFIGURATION + +.SS Settings File +The main configuration file is located at: .IP \[bu] 2 -"run" is executed when the command is invoked. -(shortcut is pressed, or trigger isn\[aq]t running) +.B /etc/fenrir/settings/settings.conf +(system-wide installation) +.IP \[bu] 2 +.B config/settings/settings.conf +(development/git version) + +.SS Key Sections +.TP +.B [speech] +Configure speech synthesis (rate, pitch, volume, driver) + +.TP +.B [sound] +Configure sound output and sound icons + +.TP +.B [keyboard] +Configure input driver and keyboard layout + +.TP +.B [screen] +Configure screen reading driver and ignored screens + +.TP +.B [general] +General settings like punctuation, clipboard, and debug levels + +.SS Driver Configuration +Fenrir uses a modular driver system: + +.TP +.B Speech Drivers: +.IP \[bu] 4 +speechdDriver - Speech-dispatcher (recommended) +.IP \[bu] 4 +genericDriver - Command-line TTS (espeak, etc.) +.IP \[bu] 4 +debugDriver - Debug/testing + +.TP +.B Sound Drivers: +.IP \[bu] 4 +genericDriver - Sox-based (default) +.IP \[bu] 4 +gstreamerDriver - GStreamer-based +.IP \[bu] 4 +debugDriver - Debug/testing + +.TP +.B Input Drivers: +.IP \[bu] 4 +evdevDriver - Linux evdev (recommended for Linux) +.IP \[bu] 4 +ptyDriver - Terminal emulation (cross-platform) +.IP \[bu] 4 +atspiDriver - AT-SPI for desktop environments + +.TP +.B Screen Drivers: +.IP \[bu] 4 +vcsaDriver - Linux VCSA devices (TTY) +.IP \[bu] 4 +ptyDriver - Terminal emulation + +.TP +.B Remote Drivers: +.IP \[bu] 4 +unixDriver - Unix socket remote control (recommended) +.IP \[bu] 4 +tcpDriver - TCP socket remote control (localhost only) + +.SH EXAMPLES + +.TP +.B fenrir +Start Fenrir as a daemon with default settings. + +.TP +.B fenrir -f -d +Run Fenrir in foreground with debug output. + +.TP +.B fenrir -e +Run Fenrir with PTY emulation for desktop/terminal use. + +.TP +.B fenrir -o "speech#rate=0.8;sound#volume=0.5" +Override speech rate and sound volume settings. + +.TP +.B fenrir -F +Force Fenrir to work on all screens, ignoring ignoreScreen settings. + +.TP +.B fenrir -s /home/user/my-fenrir.conf +Use a custom configuration file. + +.SH REMOTE CONTROL + +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: + +.EX +[remote] +enable=True +driver=unixDriver +enableSettingsRemote=True +enableCommandRemote=True +.EE + +.SS Using socat with Unix Sockets + +.TP +.B Basic Speech Control: +.EX +# Interrupt current speech +echo "command interrupt" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Speak custom text +echo "command say Hello, this is a test" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Temporarily disable speech +echo "command tempdisablespeech" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +.EE + +.TP +.B Settings Control: +.EX +# Enable highlight tracking +echo "setting set focus#highlight=True" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Change speech rate +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 + +# 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 + +# Reset all settings +echo "setting reset" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +.EE + +.TP +.B Clipboard Operations: +.EX +# Add text to clipboard +echo "command clipboard Text to copy" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Export clipboard to file +echo "command exportclipboard" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +.EE + +.SS Command Reference + +.TP +.B Speech Commands: .IP \[bu] 2 -setCAllback is currently not used. -and has no functionality yet. -.SH Troubleshooting -.SS Fenrir does not start -.IP " 1." 4 -Have you installed all the dependencies Support and -Requirements (#Support and Requirements) -.IP " 2." 4 -Try using master, a lot of changes take place there to make Fenrir -compatible with more systems ## Fenrir does not utilize the shortcuts -.IP " 3." 4 -Make sure you have python3\-evdev installed -.IP " 4." 4 -Use the latest Fenrir version -.IP " 5." 4 -Make sure that Fenrir has permission to /dev/input/* and /dev/uinput (or -run it as root) ## No sound at all -.IP " 6." 4 -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 \[aq]\[aq]tools/configure_pulse.sh\[aq]\[aq] -.IP " 7." 4 -Use ALSA -.IP " 8." 4 -Configure Pulse system -wide (https///www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/) -(Not recommended) -.IP " 9." 4 -Use gstreamerDriver: change \[aq]\[aq]settings.conf\[aq]\[aq] in the -section \[aq]\[aq]sound\[aq]\[aq] the line -\[aq]\[aq]driver=genericDriver\[aq]\[aq] to -\[aq]\[aq]driver=gstreamerDriver\[aq]\[aq] -.IP "10." 4 -Use wave sound\-icons: change \[aq]\[aq]settings.conf\[aq]\[aq] in the -section \[aq]\[aq]sound\[aq]\[aq] the line -\[aq]\[aq]theme=default\[aq]\[aq] to -\[aq]\[aq]theme=default\-wav\[aq]\[aq] -.IP "11." 4 -Use most current version of sox (http://sox.sourceforge.net/) with opus -support -.IP "12." 4 -Try apulse (https///github.com/i-rinat/apulse) (not tested by myself but -might work). -Please give me feedback if you try it out. -## You get sound\-icons but no speech -.IP "13." 4 -If you are using speech\-dispatcher run "spd\-conf" once as user and as -root. -.IP "14." 4 -You can test if speech\-dispatcher works by invoking it as root\\ -\[aq]\[aq]sudo spd\-say "hello world"\[aq]\[aq] ## Bugreports and -feature requests +command say - Speak the specified text +.IP \[bu] 2 +command interrupt - Stop current speech +.IP \[bu] 2 +command tempdisablespeech - Disable speech until next key press + +.TP +.B Settings Commands: +.IP \[bu] 2 +setting set
#= - Set configuration value +.IP \[bu] 2 +setting reset - Reset all settings to defaults +.IP \[bu] 2 +setting save [path] - Save current settings + +.TP +.B Other Commands: +.IP \[bu] 2 +command clipboard - Add text to clipboard +.IP \[bu] 2 +command window - Define window area +.IP \[bu] 2 +command resetwindow - Reset to full screen +.IP \[bu] 2 +command vmenu - Set virtual menu +.IP \[bu] 2 +command resetvmenu - Reset virtual menu +.IP \[bu] 2 +command quitapplication - Quit Fenrir + +.SS Important Controllable Settings + +.TP +.B Speech Control: +.IP \[bu] 2 +general#punctuationLevel=none/some/most/all - Punctuation verbosity +.IP \[bu] 2 +speech#rate=0.1-1.0 - Speech rate +.IP \[bu] 2 +speech#pitch=0.1-1.0 - Speech pitch +.IP \[bu] 2 +speech#volume=0.1-1.0 - Speech volume +.IP \[bu] 2 +speech#voice=voice_name - Voice selection +.IP \[bu] 2 +speech#module=module_name - TTS module + +.TP +.B Screen Control: +.IP \[bu] 2 +screen#ignoreScreen=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 +.IP \[bu] 2 +keyboard#wordEcho=True/False - Word echo + +.SH FILES +.TP +.B /etc/fenrir/settings/settings.conf +Main configuration file + +.TP +.B /etc/fenrir/keyboard/ +Keyboard layout definitions + +.TP +.B /etc/fenrir/punctuation/ +Punctuation level definitions + +.TP +.B /usr/share/sounds/fenrirscreenreader/ +System sound themes + +.TP +.B ~/.local/share/fenrirscreenreader/sounds/ +User sound themes + +.TP +.B /var/log/fenrir.log +Debug log file + +.TP +.B /run/fenrir.pid +Process ID file when running as daemon + +.SH ENVIRONMENT +Fenrir respects standard Linux permissions and requires appropriate access to: +.IP \[bu] 2 +/dev/input/* (for evdev input driver) +.IP \[bu] 2 +/dev/uinput (for key injection) +.IP \[bu] 2 +/dev/vcsa* (for VCSA screen driver) +.IP \[bu] 2 +DBus system bus (for screen change detection) + +.SH DEPENDENCIES +.SS Required +.IP \[bu] 2 +Python 3.6 or later +.IP \[bu] 2 +python3-evdev (for evdev input driver) +.IP \[bu] 2 +python3-pyudev (for device detection) + +.SS Recommended +.IP \[bu] 2 +speech-dispatcher and python3-speechd (for speech) +.IP \[bu] 2 +sox with opus support (for sound) +.IP \[bu] 2 +espeak-ng (for speech synthesis) + +.SS Optional +.IP \[bu] 2 +python3-pyenchant and aspell-* (for spell checking) +.IP \[bu] 2 +python3-daemonize (for daemon mode) +.IP \[bu] 2 +pyalsaaudio (for ALSA volume control) + +.SH SIGNALS +.TP +.B SIGTERM, SIGINT +Gracefully shut down Fenrir + +.SH EXIT STATUS +.TP +.B 0 +Success + +.TP +.B 1 +General error (configuration, permission, etc.) + +.SH BUGS +Report bugs to the project maintainer or via the project repository. + +.SH AUTHORS +.B Current maintainer: +Storm Dragon + +.B Previous developer: +Chrys + +.B Contributors: +Jeremiah and others + +.SH COPYRIGHT +This software is licensed under the LGPL v3. + +.SH SEE ALSO +.BR speechd (1), +.BR espeak (1), +.BR espeak-ng (1), +.BR sox (1) + .PP -Please report Bugs and feature requests to: -https://github.com/chrys87/fenrir/issues (https///github.com/chrys87/fenrir/issues) +Full documentation: https://git.stormux.org/storm/fenrir/wiki + .PP -for bugs please provide a debug (#Howto create a debug file) -file that shows the issue. -### How\-to create a debug file -.IP "1." 3 -Delete old debug stuff\\ \[aq]\[aq]sudo rm /var/log/fenrir.log\[aq]\[aq] -.IP "2." 3 -Start fenrir in debug mode\\ \[aq]\[aq]sudo fenrir \-d\[aq]\[aq] -.IP "3." 3 -Do your stuff to reproduce the problem -.IP "4." 3 -Stop fenrir (\[aq]\[aq]fenrirKey + q\[aq]\[aq]) the debug file is -located in \[aq]\[aq]/var/log/fenrir.log\[aq]\[aq] -.PP -Please be as precise as possible to make it easy to solve the problem. +Support: stormux+subscribe@groups.io \ No newline at end of file diff --git a/docs/fenrir.adoc b/docs/fenrir.adoc index 0b0eb592..80a419da 100644 --- a/docs/fenrir.adoc +++ b/docs/fenrir.adoc @@ -1202,6 +1202,44 @@ link:#Settings[Settings] === Commandline Arguments +Fenrir supports several command-line options: + +.... +fenrir [OPTIONS] +.... + +==== Available Options + +`+-h, --help+`:: +Show help message and exit. + +`+-v, --version+`:: +Show version information and exit. + +`+-f, --foreground+`:: +Run Fenrir in the foreground instead of as a daemon. + +`+-s, --setting SETTING-FILE+`:: +Path to a custom settings file. + +`+-o, --options SECTION#SETTING=VALUE;..+`:: +Override settings file options (see below for details). + +`+-d, --debug+`:: +Enable debug mode. Debug information will be logged. + +`+-p, --print+`:: +Print debug messages to screen in addition to logging them. + +`+-e, --emulated-pty+`:: +Use PTY emulation with escape sequences for input. This enables usage in desktop/X11/Wayland environments and terminal emulators. + +`+-E, --emulated-evdev+`:: +Use PTY emulation with evdev for input (single instance mode). + +`+-F, --force-all-screens+`:: +Force Fenrir to respond on all screens, ignoring the ignoreScreen setting. This temporarily overrides screen filtering for the current session. + ==== Set settings options You can specify options that overwrite the setting.conf. This is done @@ -1224,9 +1262,154 @@ or change the debug level to verbose fenrir -o "general#debugLevel=3" .... +Example using force all screens option: + +.... +fenrir -F +.... + You can find the available sections and variables here #Settings See Syntax link:#settings.conf syntax[#settings.conf syntax] +=== Remote Control + +Fenrir includes a powerful remote control system that allows external applications and scripts to control Fenrir through Unix sockets or TCP connections. + +==== Configuration + +Enable remote control in settings.conf: + +.... +[remote] +enable=True +driver=unixDriver +enableSettingsRemote=True +enableCommandRemote=True +.... + +==== Using socat with Unix Sockets + +The `+socat+` command provides the easiest way to send commands to Fenrir: + +===== Basic Speech Control + +.... +# Interrupt current speech +echo "command interrupt" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Speak custom text +echo "command say Hello, this is a test message" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Temporarily disable speech (until next keystroke) +echo "command tempdisablespeech" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +.... + +===== Settings Control + +.... +# Enable highlight tracking mode +echo "setting set focus#highlight=True" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Change speech rate +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 + +# 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 + +# Reset all settings to defaults +echo "setting reset" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +.... + +===== Clipboard Operations + +.... +# Place text into clipboard +echo "command clipboard This text will be copied to clipboard" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Export clipboard to file +echo "command exportclipboard" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +.... + +===== Application Control + +.... +# Quit Fenrir +echo "command quitapplication" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +.... + +==== Command Reference + +===== Available Commands + +*Speech Commands:* + +* `+command say +` - Speak the specified text +* `+command interrupt+` - Stop current speech +* `+command tempdisablespeech+` - Disable speech until next key press + +*Clipboard Commands:* + +* `+command clipboard +` - Add text to clipboard +* `+command exportclipboard+` - Export clipboard to file + +*Window Commands:* + +* `+command window +` - Define window area +* `+command resetwindow+` - Reset to full screen + +*VMenu Commands:* + +* `+command vmenu +` - Set virtual menu context +* `+command resetvmenu+` - Reset virtual menu + +*Application Commands:* + +* `+command quitapplication+` - Quit Fenrir + +===== Available Settings + +*Settings Commands:* + +* `+setting set
#=+` - Set configuration value +* `+setting reset+` - Reset all settings to defaults +* `+setting save [path]+` - Save current settings + +*Key Settings You Can Control:* + +*Speech Settings:* +* `+speech#enabled=True/False+` - Enable/disable speech +* `+speech#rate=0.1-1.0+` - Speech rate (speed) +* `+speech#pitch=0.1-1.0+` - Speech pitch (tone) +* `+speech#volume=0.1-1.0+` - Speech volume +* `+speech#voice=voice_name+` - Voice selection (e.g., "en-us+f3") +* `+speech#module=module_name+` - TTS module (e.g., "espeak-ng") + +*General Settings:* +* `+general#punctuationLevel=none/some/most/all+` - Punctuation verbosity +* `+general#autoSpellCheck=True/False+` - Automatic spell checking +* `+general#emoticons=True/False+` - Enable emoticon replacement + +*Sound Settings:* +* `+sound#enabled=True/False+` - Enable/disable sound +* `+sound#volume=0.1-1.0+` - Sound volume + +*Focus Settings:* +* `+focus#cursor=True/False+` - Follow text cursor +* `+focus#highlight=True/False+` - Follow text highlighting + +*Keyboard Settings:* +* `+keyboard#charEchoMode=0-2+` - Character echo (0=none, 1=always, 2=capslock only) +* `+keyboard#wordEcho=True/False+` - Echo complete words + +*Screen Settings:* +* `+screen#ignoreScreen=1,2,3+` - TTY screens to ignore + ==== settings.conf syntax the syntax of the link:#Settings[settings.conf] is quite simple and diff --git a/docs/user.md b/docs/user.md index a789dd2d..e1e9a04d 100644 --- a/docs/user.md +++ b/docs/user.md @@ -1,1590 +1,335 @@ # Fenrir User Manual -Fenrir is a modern command line screen reader written in Python3. +Fenrir is a modern command line screen reader written in Python 3. -It has a modular structure, a flexible based driver model, is highly configurable and easy to customize and extend ([see Developer Manual](fenrir_development_manual)). - -Please see the following pages for the [current](fenrir_current_version) and [Git](fenrir_git_version) version of Fenrir. - - -# Support and Requirements - - -Fenrir requires several drivers to interact with the operating system. - -## Speech Drivers - - -A speech driver is for communication with the text to speech system like [Speech-Dispatcher](#SpeechDispatcher) or [Espeak](http://espeak.sourceforge.net). \\ -See section [Speech](#Speech) in ''settings.conf'' for more information. - - -### SpeechDispatcher - - -This driver is used by default. -It uses Speech-dispatcher as its backend. - -Dependencies: - - -* Speech-dispatcher (installed and configured, [Documentation](https///devel.freebsoft.org/speechd#sec2)) - -* Python-speechd - -### Espeak - - -Uses Espeak via Python bindings. - -Dependencies: - -* Espeak or Espeak-ng - -* [python-espeak](https///launchpad.net/python-espeak) - -### Generic - - -This invokes speech via a sub-process. This is almost the same as using the commandline. The performance depends on the overhead of the speech synthesis application but it is really flexible. - -Dependencies: - -* Espeak or Espeak-ng - -The Requirements are flexible, they depend on the configuration in settings.conf. - -### Dummy - - -this is just for debugging, logs are output to the screen and logged as well. - -## Sound Drivers - - -To play sound icons and similar.\\ -See section [Sound](#Sound) in ''settings.conf'' for more information. - -### Generic - - -This driver is used by default. - -Dependencies: - - -* [Sox](http://sox.sourceforge.net/) with opus support -The Requirements are flexible, they depend on the configuration in settings.conf. - -### Gstreamer - -if you prefer to use Gstreamer for sound output. - -Dependencies: - -* Gstreamer >= 1.x - -* Glibc - -### Dummy - - -this is just for debugging, logs are output to the screen and logged as well. - -## Input Drivers - - -Input drivers are to capture keyboard shortcuts issued to the screen reader \ -See section [Keyboard](#Keyboard) in ''settings.conf'' for more information. - -### Evdev - - -This driver is used by default. - -Evdev is the low level input device framework for Linux. - -Dependencies: - - -* python-evdev >=0.6.3 - -* pyudev - -* loaded uinput kernel module - -* exclusive access to the input devices -Read permission to the following files and services: - -* /dev/input - -* /dev/uinput - -## Screen Drivers - - -The job of a screen driver is to get the information of current screen content.\\ -See section [Screen](#Screen) in ''settings.conf'' for more information. - -### VCSA - - -This driver is used by default. -For Linux VCSA devices. These exist on any current standard installation of Linux. - -Dependencie -s: - - -* python-dbus -Read permission to the following files and services (or run as root): - -* /sys/devices/virtual/tty/tty0/active - -* /dev/tty[1 - 64] - -* /dev/vcsa[1 - 64] ([VCSA manpage](https///linux.die.net/man/4/vcsa)) - -* read Logind DBUS - -## Braille Drivers - -This is for Braille support. -Braille is currently a work in progress and is planned for the Fenrir 2.0 release.\\ -See section [Braille](#Braille) in ''settings.conf'' for more information. - - -### BRLTTY - - -This driver is used by default. -It uses [BrlTTY](brltty) to communicate with with a Braille device. - -Dependencies: - - -* BrlTTY (configured and running, [Documentation](http://mielke.cc/brltty/doc/Manual-BRLTTY/English/BRLTTY.html)) - -* python-brlapi (configured, [Documentation](http://mielke.cc/brltty/doc/Manual-BrlAPI/English/BrlAPI.html)) -## Currently supported platforms - - -Currently Fenrir completely supports the following Platforms: - -* Linux TTY -Support for further Systems are planned. - -# Installation - - -Fenrir can run without installation. It just requires the dependencies are installed first. - -We recommend to try it out before installation to be sure everything works and prevent yourself from experiencing a non-talking environment. - -## Try Out - -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, used by systemd for autostart) - -## Install it - -### Documented operating systems - - -### Arch Linux - - -For Arch there are PKGBUILDs in the AUR: - -* [fenrir](https///aur.archlinux.org/packages/fenrir/) - -* [fenrir-git](https///aur.archlinux.org/packages/fenrir-git/) - -### Manual - - - 1. Download the latest stable version from the [Fenrir-Project](https///linux-a11y.org/index.php?page=fenrir-screenreader) site. - 2. Unpack the archive - 3. Check the needed Dependencys by running [check-dependencys.py](https///github.com/chrys87/fenrir/blob/master/check-dependencies.py) script - 4. install the missing dependencies an standard installation requires the following: - - * python3 >= 3.3 (and all the following is needed for python3 ) - * python3-speechd (screen) - * python3-dbus (screen) - * python3-evdev >= 0.6.4(input) - * python3-daemonize (background service) - * python3-brlapi (braille) - * python3-pyenchant (spellchecker) - * your language for aspell (aspell-``) (spellchecker) - * sox (sound) - * For an individual installation see [Support and Requirements](#Support and Requirements) or consult the [Readme](https///github.com/chrys87/fenrir/blob/master/README.md)) - 5. run "install.sh" as root - -this installs Fenrir as the following - - * Application:''/opt/fenrir'' - * Settings:''/etc/fenrir'' - * Sound Icons:''/usr/share/fenrirscreenreader/'' - -to remove Fenrir just run uninstall.sh as root - -### Git - - -if you want to get the latest code you can use git to get a development snapshot: - - git clone https://github.com/chrys87/fenrir.git - -## Auto Start - - -To start Fenrir once: - systemctl start fenrir - -To enable auto start on system boot: - systemctl enable fenrir - -# First Steps - - -If you are using Fenrir for the first time you may want to take a look at these resources: - -* [Keybindings](#Keybindings) - -* [Tutorial Mode](#Tutorial Mode) - -# Features - - -## Commands - - -### Keybindings - - -Normal commands can be invoked in two ways: - 1. Using a Metakey ([FenrirKey](#Fenrir Key)) - 2. Shortcuts with a single key - -See section [Keyboard](#Keyboard) in ''settings.conf'' for more information. -#### Fenrir Key - -The Fenrir Key is for invoking screen reader commands. Fenrir can utilize more than one FenrirKey at the same time. -By default the following keys are used: - 1. Insert - 2. KeyPad Insert - 3. Meta (Super, Windows) - -#### Script Key - -To invoke "Scripts" the Script Key is mandatory. The shortcut is encoded in the filename of the script. See [Scripting](#Scripting) -#### Desktop Layout - - | Shortcut | Command | - | -------- | ------- | - | FenrirKey + H | [toggle tutorial mode](#Tutorial Mode) | - | CTRL | [shut up (interrupts speech)](#shut up) | - | FenrirKey + KeyPad 9 | [reviews bottom](#review bottom) | - | FenrirKey + KeyPad 7 | [reviews top](#review top) | - | KeyPad 8 | [reviews current line](#review current line) | - | KeyPad 7 | [reviews previous line](#review previous line) | - | KeyPad 9 | [reviews next line](#review next line) | - | FenrirKey + KeyPad 4 | [reviews line beginning](#review line beginning) | - | FenrirKey + KeyPad 6 | [reviews line ending](#review line ending) | - | FenrirKey + KeyPad 1 | [reviews line first character](#review line first character) | - | FenrirKey + KeyPad 3 | [reviews line last character](#review line last character) | - | FenrirKey + Alt + 1 | [presents first line](#present first line) | - | FenrirKey + Alt + 2 | [presents last line](#present last line) | - | KeyPad 5 | [reviews current word](#review current word) | - | KeyPad 4 | [reviews previous word](#review previous word) | - | KeyPad 6 | [reviews next word](#review next word) | - | FenrirKey + Shift + KeyPad 5 | [reviews current word phonetic](#review current word phonetic) | - | FenrirKey + Shift + KeyPad 4 | [reviews previous word phonetic](#review previous word phonetic) | - | FenrirKey + Shift + KeyPad 6 | [reviews next word phonetic](#review next word phonetic) | - | KeyPad 2 | [reviews current char](#review current character) | - | KeyPad 1 | [reviews previous char](#review previous character) | - | KeyPad 3 | [reviews next char](#review next character) | - | FenrirKey + Shift + KeyPad 2 | [reviews current character phonetic](#review current character phonetic) | - | FenrirKey + Shift + KeyPad 1 | [reviews previous character phonetic](#review previous character phonetic) | - | FenrirKey + Shift + KeyPad 3 | [reviews next character phonetic](#review next character phonetic) | - | FenrirKey + CTRL + KeyPad 8 | [reviews up](#review up) | - | FenrirKey + CTRL + KeyPad 2 | [reviews down](#review down) | - | FenrirKey + KeyPad dot | [exit review](#exit review) | - | KeyPad dot | [cursor position](#cursor position) | - | FenrirKey + I | [indent curr line](#indent current line) | - | FenrirKey + KeyPad 5 | [current screen](#current screen) | - | FenrirKey + KeyPad 8 | [current screen before cursor](#current screen before cursor) | - | FenrirKey + KeyPad 2 | [current screen after cursor](#current screen after cursor) | - | `` | [cursor read to end of line](#cursor read to end of line) | - | `` | [cursor column](#cursor column) | - | `` | [cursor line number](#cursor line number) | - | `` | [Braille flush](#braille flush) | - | `` | [Braille pan left](#braille pan left) | - | `` | [Braille pan right](#braille pan right) | - | `` | [Braille return to cursor](#braille return to cursor) | - | FenrirKey + CTRL + 1 | [clear bookmark 1](#clear Bookmark X) | - | FenrirKey + Shift + 1 | [set bookmark 1](#set Bookmark X) | - | FenrirKey + 1 | [bookmark 1](#read Bookmark X) | - | FenrirKey + CTRL + 2 | [clear bookmark 2](#clear Bookmark X) | - | FenrirKey + Shift + 2 | [set bookmark 2](#set Bookmark X) | - | FenrirKey + 2 | [bookmark 2](#read Bookmark X) | - | FenrirKey + CTRL + 3 | [clear bookmark 3](#clear Bookmark X) | - | FenrirKey + Shift + 3 | [set bookmark 3](#set Bookmark X) | - | FenrirKey + 3 | [bookmark 3](#read Bookmark X) | - | FenrirKey + CTRL + 4 | [clear bookmark 4](#clear Bookmark X) | - | FenrirKey + Shift + 4 | [set bookmark 4](#set Bookmark X) | - | FenrirKey + 4 | [bookmark 4](#read Bookmark X) | - | FenrirKey + CTRL + 5 | [clear bookmark 5](#clear Bookmark X) | - | FenrirKey + Shift + 5 | [set bookmark 5](#set Bookmark X) | - | FenrirKey + 5 | [bookmark 5](#read Bookmark X) | - | FenrirKey + CTRL + 6 | [clear bookmark 6](#clear Bookmark X) | - | FenrirKey + Shift + 6 | [set bookmark 6](#set Bookmark X) | - | FenrirKey + 6 | [bookmark 6](#read Bookmark X) | - | FenrirKey + CTRL + 7 | [clear bookmark 7](#clear Bookmark X) | - | FenrirKey + Shift + 7 | [set bookmark 7](#set Bookmark X) | - | FenrirKey + 7 | [bookmark 7](#read Bookmark X) | - | FenrirKey + CTRL + 8 | [clear bookmark 8](#clear Bookmark X) | - | FenrirKey + Shift + 8 | [set bookmark 8](#set Bookmark X) | - | FenrirKey + 8 | [bookmark 8](#read Bookmark X) | - | FenrirKey + CTRL + 9 | [clear bookmark 9](#clear Bookmark X) | - | FenrirKey + Shift + 9 | [set bookmark 9](#set Bookmark X) | - | FenrirKey + 9 | [bookmark 9](#read Bookmark X) | - | FenrirKey + CTRL + 0 | [clear bookmark 10](#clear Bookmark X) | - | FenrirKey + Shift + 0 | [set bookmark 10](#set Bookmark X) | - | FenrirKey + 0 | [bookmark 10](#read Bookmark X) | - | FenrirKey + KeyPad Slash | [set window application](#Create Window) | - | 2 * FenrirKey + KeyPad Slash | [clear window application](#Remove Window) | - | KeyPad Plus | [read last incoming](#last incoming) | - | FenrirKey + F2 | [toggles braille](#toggle braille) | - | FenrirKey + F3 | [toggles sound](#toggle sound) | - | FenrirKey + F4 | [toggles speech](#toggle speech) | - | KeyPad Enter | [temporarily disables speech](#disable speech temporarily) | - | FenrirKey + CTRL + P | [toggles punctuation level](#toggle punctuation level) | - | FenrirKey + RightBrace | [toggle auto spell check](#toggle auto spell check) | - | FenrirKey + Backslash | [toggles output](#toggle output) | - | FenrirKey + CTRL + E | [toggles emoticons](#toggle emoticons) | - | FenrirKey + KeyPad Enter | [toggles auto read](#toggle auto read) | - | FenrirKey + CTRL + T | [toggles auto time](#toggle auto time) | - | FenrirKey + KeyPad ASTERISK | [toggles highlight tracking](#toggle highlight tracking) | - | FenrirKey + Q | [quits fenrir](#quit Fenrir) | - | FenrirKey + T | [Announce time](#Time) | - | 2 * FenrirKey + T | [Announce date](#Date) | - | FenrirKey + S | [spell check](#spell check) | - | 2 * FenrirKey + S | [add word to spell check](#add word to spell check) | - | FenrirKey + Shift + S | [removes word from spell check](#removes word from spell check) | - | FenrirKey + Backspace | [forward keypress](#forward keypress) | - | FenrirKey + Up | [increase speech volume](#increase speech volume) | - | FenrirKey + Down | [decrease speech volume](#decrease speech volume) | - | FenrirKey + Right | [increase speech rate](#increase speech rate) | - | FenrirKey + Left | [decrease speech rate](#decrease speech rate) | - | FenrirKey + Alt + Right | [increase speech pitch](#increase speech pitch) | - | FenrirKey + Alt + Left | [decrease speech pitch](#decrease speech pitch) | - | FenrirKey + Alt + Up | [increase sound volume](#increase sound volume) | - | FenrirKey + Alt + Down | [decrease sound volume](#decrease sound volume) | - | FenrirKey + CTRL + Shift + C | [clears clipboard](#clear clipboard) | - | FenrirKey + Home | [first clipboard](#first clipboard) | - | FenrirKey + End | [last clipboard](#last clipboard) | - | FenrirKey + PageUp | [previous clipboard](#previous clipboard) | - | FenrirKey + PageDown | [next clipboard](#next clipboard) | - | FenrirKey + Shift + C | [current clipboard](#read current clipboard) | - | FenrirKey + C | [copy marked text to clipboard](#copy marked to clipboard) | - | FenrirKey + V | [paste clipboard contents](#paste clipboard) | - | FenrirKey + P | [import clipboard from file](#import clipboard from file) | - | FenrirKey + Alt + Shift +C | [export clipboard to file](#export clipboard to file) | - | FenrirKey + CTRL + Shift + X | [remove marks](#Remove Marks) | - | FenrirKey + X | [set mark](#Set mark) | - | FenrirKey + Shift + X | [announce marked text](#Get text between marks) | - | Linux specific | - | `` | export clipboard to X | - | FenrirKey + CTRL + Up | include Alsa volume | - | FenrirKey + CTRL + Down | decrease Alsa volume | - -#### Laptop Layout - - | Shortcut | Command | - | -------- | ------- | - | FenrirKey + H | [toggle tutorial mode](#Tutorial Mode) | - | CTRL | [shut up (interrupts speech)](#shut up) | - | FenrirKey + Shift + O | [reviews bottom](#review bottom) | - | FenrirKey + Shift + U | [reviews top](#review top) | - | FenrirKey + I | [reviews current line](#review current line) | - | FenrirKey + U | [reviews previous line](#review previous line) | - | FenrirKey + O | [reviews next line](#review next line) | - | FenrirKey + Shift + J | [reviews line beginning](#review line beginning) | - | FenrirKey + Shift + L | [reviews line ending](#review line ending) | - | FenrirKey + CTRL + J | [reviews line first character](#review line first character) | - | FenrirKey + CTRL + L | [reviews line last character](#review line last character) | - | FenrirKey + Alt + 1 | [presents first line](#present first line) | - | FenrirKey + Alt + 2 | [presents last line](#present last line) | - | FenrirKey + K | [reviews current word](#review current word) | - | FenrirKey + J | [reviews previous word](#review previous word) | - | FenrirKey + L | [reviews next word](#review next word) | - | FenrirKey + CTRL + ALT + K | [reviews current word phonetic](#review current word phonetic) | - | FenrirKey + CTRL + ALT + J | [reviews previous word phonetic](#review previous word phonetic) | - | FenrirKey + CTRL + ALT + L | [reviews next word phonetic](#review next word phonetic) | - | FenrirKey + comma | [reviews current character](#review current character) | - | FenrirKey + M | [reviews previous character](#review previous character) | - | FenrirKey + dot | [reviews next character](#review next character) | - | FenrirKey + CTRL + ALT + comma | [reviews current character phonetic](#review current character phonetic) | - | FenrirKey + CTRL + ALT + M | [reviews previous character phonetic](#review previous character phonetic) | - | FenrirKey + CTRL + ALT + dot | [reviews next character phonetic](#review next character phonetic) | - | FenrirKey + CTRL + I | [reviews up](#review up) | - | FenrirKey + CTRL + comma | [reviews down](#review down) | - | FenrirKey + Slash | [exit review](#exit review) | - | FenrirKey + Shift + dot | [cursor position](#cursor position) | - | 2 * FenrirKey + I | [indent curr line](#indent current line) | - | FenrirKey + Shift + K | [current screen](#current screen) | - | FenrirKey + Shift + I | [current screen before cursor](#current screen before cursor) | - | FenrirKey + Shift + comma | [current screen after cursor](#current screen after cursor) | - | `` | [cursor read to end of line](#cursor read to end of line) | - | `` | [cursor column](#cursor column) | - | `` | [cursor line number](#cursor line number) | - | `` | [Braille flush](#braille flush) | - | `` | [Braille pan left](#braille pan left) | - | `` | [Braille pan right](#braille pan right) | - | `` | [Braille return to cursor](#braille return to cursor) | - | FenrirKey + CTRL + 1 | [clear bookmark 1](#clear Bookmark X) | - | FenrirKey + Shift + 1 | [set bookmark 1](#set Bookmark X) | - | FenrirKey + 1 | [bookmark 1](#read Bookmark X) | - | FenrirKey + CTRL + 2 | [clear bookmark 2](#clear Bookmark X) | - | FenrirKey + Shift + 2 | [set bookmark 2](#set Bookmark X) | - | FenrirKey + 2 | [bookmark 2](#read Bookmark X) | - | FenrirKey + CTRL + 3 | [clear bookmark 3](#clear Bookmark X) | - | FenrirKey + Shift + 3 | [set bookmark 3](#set Bookmark X) | - | FenrirKey + 3 | [bookmark 3](#read Bookmark X) | - | FenrirKey + CTRL + 4 | [clear bookmark 4](#clear Bookmark X) | - | FenrirKey + Shift + 4 | [set bookmark 4](#set Bookmark X) | - | FenrirKey + 4 | [bookmark 4](#read Bookmark X) | - | FenrirKey + CTRL + 5 | [clear bookmark 5](#clear Bookmark X) | - | FenrirKey + Shift + 5 | [set bookmark 5](#set Bookmark X) | - | FenrirKey + 5 | [bookmark 5](#read Bookmark X) | - | FenrirKey + CTRL + 6 | [clear bookmark 6](#clear Bookmark X) | - | FenrirKey + Shift + 6 | [set bookmark 6](#set Bookmark X) | - | FenrirKey + 6 | [bookmark 6](#read Bookmark X) | - | FenrirKey + CTRL + 7 | [clear bookmark 7](#clear Bookmark X) | - | FenrirKey + Shift + 7 | [set bookmark 7](#set Bookmark X) | - | FenrirKey + 7 | [bookmark 7](#read Bookmark X) | - | FenrirKey + CTRL + 8 | [clear bookmark 8](#clear Bookmark X) | - | FenrirKey + Shift + 8 | [set bookmark 8](#set Bookmark X) | - | FenrirKey + 8 | [bookmark 8](#read Bookmark X) | - | FenrirKey + CTRL + 9 | [clear bookmark 9](#clear Bookmark X) | - | FenrirKey + Shift + 9 | [set bookmark 9](#set Bookmark X) | - | FenrirKey + 9 | [bookmark 9](#read Bookmark X) | - | FenrirKey + CTRL + 0 | [clear bookmark 10](#clear Bookmark X) | - | FenrirKey + Shift + 0 | [set bookmark 10](#set Bookmark X) | - | FenrirKey + 0 | [bookmark 10](#read Bookmark X) | - | FenrirKey + CTRL + 8 | [set window application](#Create Window) | - | 2 * FenrirKey + CTRL + 8 | [clear window application](#Remove Window) | - | FenrirKey + Semicolon | [read last incoming](#last incoming) | - | FenrirKey + F2 | [toggles braille](#toggle braille) | - | FenrirKey + F3 | [toggles sound](#toggle sound) | - | FenrirKey + F4 | [toggles speech](#toggle speech) | - | FenrirKey + Enter | [temporarily disables speech](#disable speech temporarily) | - | FenrirKey + Shift + CTRL + P | [toggles punctuation level](#toggle punctuation level) | - | FenrirKey + RightBrace | [toggle auto spell check](#toggle auto spell check) | - | FenrirKey + Shift + Enter | [toggles output](#toggle output) | - | FenrirKey + Shift + E | [toggles emoticons](#toggle emoticons) | - | FenrirKey + Enter | [toggles auto read](#toggle auto read) | - | FenrirKey + CTRL + T | [toggles auto time](#toggle auto time) | - | FenrirKey + Y | [toggles highlight tracking](#toggle highlight tracking) | - | FenrirKey + Q | [quits fenrir](#quit Fenrir) | - | FenrirKey + T | [Announce time](#Time) | - | 2 * FenrirKey + T | [Announce date](#Date) | - | FenrirKey + S | [spell check](#spell check) | - | 2 * FenrirKey + S | [add word to spell check](#add word to spell check) | - | FenrirKey + Shift + S | [removes word from spell check](#removes word from spell check) | - | FenrirKey + Backspace | [forward keypress](#forward keypress) | - | FenrirKey + Up | [increase speech volume](#increase speech volume) | - | FenrirKey + Down | [decrease speech volume](#decrease speech volume) | - | FenrirKey + Right | [increase speech rate](#increase speech rate) | - | FenrirKey + Left | [decrease speech rate](#decrease speech rate) | - | FenrirKey + Alt + Right | [increase speech pitch](#increase speech pitch) | - | FenrirKey + Alt + Left | [decrease speech pitch](#decrease speech pitch) | - | FenrirKey + Alt + Up | [increase sound volume](#increase sound volume) | - | FenrirKey + Alt + Down | [decrease sound volume](#decrease sound volume) | - | FenrirKey + CTRL + Shift + C | [clears clipboard](#clear clipboard) | - | FenrirKey + Home | [first clipboard](#first clipboard) | - | FenrirKey + End | [last clipboard](#last clipboard) | - | FenrirKey + PageUp | [previous clipboard](#previous clipboard) | - | FenrirKey + PageDown | [next clipboard](#next clipboard) | - | FenrirKey + Shift + C | [current clipboard](#read current clipboard) | - | FenrirKey + C | [copy marked text to clipboard](#copy marked to clipboard) | - | FenrirKey + V | [paste clipboard contents](#paste clipboard) | - | FenrirKey + F5 | [import clipboard from file](#import clipboard from file) | - | FenrirKey + Alt + Shift +C | [export clipboard to file](#export clipboard to file) | - | FenrirKey + CTRL + Shift + X | [remove marks](#Remove Marks) | - | FenrirKey + X | [set mark](#Set mark) | - | FenrirKey + Shift + X | [announce marked text](#Get text between marks) | - | Linux specific | - | `` | 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 from the text cursor. Attention: after using the review mode, the review cursor will stay open until you use the ''exit review'' shortcut. - -Think when using clipboard operations and similar. The review cursor is always prefered over the text cursor. - -Fenrir sounds a bell sound if the used review command jumps to another line or end of 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 a mark: - 1. navigate with review or textcursor to the position you want to set the mark. Attention: if a review cursor is set, that is the prefered. If you want to use text cursor, be sure that you are not in review mode. - 2. 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 methods to interact with the current screen. -#### forward keypress - -This just forwards the next shortcut to the screen Fenrir shortcut or not. This is useful if the currently pressed shortcut is also in use by Fenrir. -#### Clipboard - -Fenrir provides a clipboard with multible items represented by a list. You navigate throught the list and paste the selected clipboard. -##### copy marked to clipboard - -To copy something 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 the first item on your clipboard. -##### clear clipboard - -You can remove all items from the current clipboard by ''clear clipboard'' functionality. -##### first clipboard - -This moves quick to the first item of the clipboard. -##### last clipboard - -This moves quick to the last item of the clipboard. -##### previous clipboard - -Go to previous item in the clipboard. -##### next clipboard - -Go to next item on the clipboard. -##### read current clipboard - -Read the content of the current item of the clipboard. -##### paste clipboard - -Pass whatever item is currently selected by first, last, prev or next clipboard commands. -if no special clipboard is selected the (last copied) is used. -##### export clipboard to file - -This allows you to export the current clipboard to a configurable filepath. This is useful to share the clipboard with a graphical desktop. -##### import clipboard from file - -Import a clipboard from a configurable file. This is useful to share the clipboard with a graphical desktop. -### Quick Settings - -Fenrir provides shortcuts to change settings temporarily and on the fly without the 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 a 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 what is automatically 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: - 1. set a beginning mark (as the start of the window) - 2. set an end mark (where the window should end) - 3. 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 +It has a modular structure, a flexible driver-based architecture, is highly configurable and easy to customize and extend. -Different types of tracking are currently supported -See section [Focus](#Focus) in ''settings.conf'' for more information. -#### Cursor Tracking +**Current maintainer:** Storm Dragon +**Previous developer:** Chrys -This follows the text cursor. This is the typical way an application works. This is used by: +## Quick Start -* almost any shell such as (Bash, Zsh, sh) +1. **Installation**: See the [README.md](../README.md) for installation instructions +2. **First run**: `sudo fenrir` (or `sudo systemctl start fenrir` if installed) +3. **Tutorial mode**: Press `Fenrir + H` to learn all commands interactively +4. **Basic navigation**: Use numeric keypad for review (desktop layout) +5. **Stop speech**: Press `Ctrl` at any time +6. **Quit**: Press `Fenrir + Q` -* vim +## Key Concepts -* nano +### Fenrir Key +The Fenrir Key is used to invoke screen reader commands. By default: +- Insert +- Keypad Insert +- Meta (Super/Windows key) -* emacs +You can configure multiple Fenrir keys to suit your preference. -* mutt +### Keyboard Layouts +- **Desktop Layout**: Uses numeric keypad (recommended for desktop users) +- **Laptop Layout**: Alternative bindings for keyboards without numeric keypad -* tintin++ -#### Highlight Tracking +### Review Mode +Navigate the screen without moving the text cursor. Essential for examining content without disrupting your workflow. -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 announces these changes for you. This is used by: +## Essential Commands - * wifi-menu - * dialog - * alpine -### Tutorial Mode +### Navigation (Desktop Layout) +- `Ctrl` - Stop speech (shut up) +- `Fenrir + H` - Tutorial mode +- `Fenrir + Q` - Quit Fenrir +- `Fenrir + Keypad 5` - Read current screen +- `Keypad 8` - Read current line +- `Keypad 5` - Read current word +- `Keypad 2` - Read current character -Fenrir provides a Tutorial mode. -When you enter tutorial mode, screen reader commands are intercepted and explained instead of executing them. ''Arrow up'' and ''Arrow Down'' let you navigate through a list of all available commands with shortcuts and description. Pressing escape leaves the tutorial mode. +### Review Commands +- `Keypad 7/9` - Previous/next line +- `Keypad 4/6` - Previous/next word +- `Keypad 1/3` - Previous/next character +- `Fenrir + Keypad dot` - Exit review mode ### 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 the area. -By default Fenrir provides 10 bookmarks. Those can be set and accessed via shortcut. -This is useful for status lines or other information where 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. - 1. Set marks (one or two) - 2. 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 indent 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 position 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 position of a cursor (column of the current line). -#### cursor line number - -Read the current Y position of a 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 automatically incoming 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 built-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-``. -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 a 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 at periodical increments, To track the time easily. -You can define 2 different ways of time announcements. - 1. periodic - 2. 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 performing more longer tasks. -you can define a list of words which you want to hear a sound icon for after a 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 with several provided dictionaries. - -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 a message appears on the Braille device you can flush it to get back to the review- or system cursor -### Braille pan left - -If a line is longer than your Braille devices you can move the view (called panning) to the left. -So you can read stuff without the need to move the review- or system cursor. -### Braille pan right - -If a line is longer than your Braille devices you can move the view (called panning) to the right. -So you can read stuff without the need to move the review- or system cursor. -### braille return to cursor - -When you have finished reading the line on the 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 built-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 they are recognized. the default punctuation level is set in settings.conf. The 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. -### Custom - -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. :) -### Emoticons - -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 perryns not smiles. -# Configuration - -You can configure Fenrir in the following places (ordered by priority): - 1. Commandline Parameters ''-o'' see [Set settings coption](#Set settings coption) - 2. /etc/fenrir/settings/settings.conf see [Settigns](#Settings) - 3. ``/config/settings/settings.conf see [Settigns](#Settings) - 4. hard coded defaults -## Commandline Arguments - -### Set settings option -You can specify options that overwrite the setting.conf. -This is done with ''-o `` parameter. -The list of options have the following syntax - fenrir -o "section#setting=value;section#setting=value" - -For example changing the sound driver to gstreamer and disabling Braille - fenrir -o "sound#driver=gstreamerDriver;braille#enabled=False=False" -or change the debug level to verbose - fenrir -o "general#debugLevel=3" -You can find the available sections and variables here [#Settings](#Settings) -See Syntax [#settings.conf syntax](#settings.conf syntax) -### settings.conf syntax - -the syntax of the [settings.conf](#Settings) is quite simple and similar to a "*.ini" file, there are 4 different elements. - 1. Sections - 2. Settings - 3. Values - 4. Comments - -A comment starts with a # and is ignored by Fenrir. - # this is a comment -To group settings we have sections. -A section can look like this: - [Section] -A setting looks like this: - settingName=Value - -Example: - [sound] - # Turn sound on or off: - enabled=True - # Select the driver used to play sounds, choices are genericDriver and gstreamerDriver. - # Sox is default. - driver=genericDriver - -## Settings - -### Sound -The sound is configured in section ''[sound]''. - -Turn sound on or off: - enabled=True -Values: on=''True'', off=''False'' - -Select the driver used to play sounds. -The genericDriver using Sox is the default. - - driver=genericDriver - -Available Drivers: - -* ''genericDriver'' using the generic driver, for Fenrir <1.5 just use ''generic'' - -* ''gstreamerDriver'' using the gstreamer, for Fenrir <1.5 just use ''gstreamer'' - -These are the pack of sounds used for sound icons. - theme=default -By default we ship two sound packs. - 1. ''default'' opus encoded, for newer Sox versions - 2. ''default-wav'' wav encoded, just for compatibility -Sound packs are located at /usr/share/sounds/fenrirscreenreader/ - -Sound volume controls how loud the sounds for your selected sound pack are. - volume=1.0 -Values: ''0.0'' is quietest, ''1.0'' is loudest. - -#### Generic Driver - -The generic sound driver uses shell commands for play sound and frequencies. - -''genericPlayFileCommand'' defines the command that is used to play a sound file. - genericPlayFileCommand=`` -''genericFrequencyCommand'' defines the command that is used playing frequencies. - genericFrequencyCommand=`` - -The following variables are substituted in ''genericPlayFileCommand'' and ''genericFrequencyCommand'': - -* ''fenrirVolume'' = the current volume setting - -* ''fenrirSoundFile'' = the sound file for an sound icon - -* ''fenrirFrequence'' = the frequency to play - -* ''fenrirDuration'' = the duration of the frequency - -Example genericPlayFileCommand (default) - genericPlayFileCommand=play -q -v fenrirVolume fenrirSoundFile -Example genericFrequencyCommand (default) - genericFrequencyCommand=play -q -v fenrirVolume -n -c1 synth fenrirDuration sine fenrirFrequence -### Speech - -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: - +- `Fenrir + T` - Announce time +- `Fenrir + T T` - Announce date +- `Keypad dot` - Cursor position + +### Clipboard +- `Fenrir + X` - Set mark +- `Fenrir + C` - Copy marked text +- `Fenrir + V` - Paste clipboard +- `Fenrir + Shift + C` - Read current clipboard + +### Settings (Runtime Changes) +- `Fenrir + F3` - Toggle sound +- `Fenrir + F4` - Toggle speech +- `Fenrir + Up/Down` - Speech volume +- `Fenrir + Right/Left` - Speech rate +- `Fenrir + Ctrl + P` - Punctuation level + +## Configuration + +### Settings File +Main configuration: `/etc/fenrir/settings/settings.conf` + +### Key Sections +- `[speech]` - Speech synthesis settings +- `[sound]` - Sound output and icons +- `[keyboard]` - Input and key bindings +- `[screen]` - Screen reading configuration +- `[general]` - General settings + +### Common Settings +```ini +[speech] +enabled=True 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" - -These are the minimum and maximum values of the TTS system 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 a 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. - -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 focus be tracked? - cursorFocusMode=page -Values: Text, an existing cursor focus mode -Available cursor focus modes: - -* ''page'' = if the cursor crosses the border move to next page and start at begin - -* ''fixCell'' = ajust the cursor on a 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 the 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? - panSizeHorizontal=0 -Values: Integer, - -* ''0'' = display size - -* ''>0'' number of cells -### Screen - -The settings for screens, (TTY, PTY) are configured in the ''[screen]'' section. - -The driver to get the information from the screen: - driver=vcsaDriver -Available Drivers: - -* ''vcsaDriver'' using the VCSA driver (for TTYs), for Fenrir <1.5 just use ''vcsa'' -The encoding of the screen - encoding=cp850 -Values:''cp850'' is used for Western languages like USA or Europe. - -The driver updates Fenrir with changes on the screen. - screenUpdateDelay=0.05 -Values: in Seconds - -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: - suspendingScreen= -Values: Depends on driver: - -* VCSA: the number of the TTY. TTY6 is ''6''. -Example ignore TTY1 and TTY2: - suspendingScreen=1,2 - -There is also the ability to let Fenrir auto detect screens that are running an X server. So Screens running an GUI can be ignored. - autodetectSuspendingScreen=True -Values: on=''True'', off=''False'' - -### Keyboard - -The settings for keyboard and input related configuration is located in the section ''[keyboard]'' of the ''settings.conf'' file. - -Select the driver used for grabbing keybord input and for recieving shortcuts. - driver=evdevDriver -Values: Text, available Driver -Available Drivers: - -* ''evdevDriver'' uses the evdev input system of linux, for Fenrir <1.5 just use ''evdev'' - -You can let Fenrir know about what input devices are to be used. - device=ALL -Values: - -* ''ALL'' use all devices with key capabilities. - -* ''NOMICE'' Exclude mices from handling. - -* `` just use the device with the given name. - -Gives Fenrir exclusive access to the keyboard and lets it control keystrokes. This is needed to intercept Fenrir related shortcuts. - grabDevices=True -Values: on=''True'', off=''False'' - -The following makes sense if you are using a second screenreader and want to have some hooked events. Fenrir ignores all shortcuts then. - ignoreShortcuts=False -Values: on=''True'', off=''False'' - -The current keyboard layout used for shortcuts. - keyboardLayout=desktop - Values: An absolute Path to a Keyboard definition file or a Filename without extension located in ''/etc/fenrir/keyboard'' - -Announce characters while typing. - charEcho=False -Values: on=''True'', off=''False'' - -Announce deleted characters - charDeleteEcho=True -Values: on=''True'', off=''False'' - -Announce word after pressing space - wordEcho=False -Values: on=''True'', off=''False'' - -Interrupt speech on any keypress - interruptOnKeyPress=False -Values: on=''True'', off=''False'' - -You can filter the keys that speech should interrupt - interruptOnKeyPressFilter= -Values: (List) empty = all keys, otherwise interrupt with specified keys - -The timeout that is used for double tap shortcuts - doubleTapTimeout=0.2 -Values: Seconds -### General - -Overall settings can be configured from the section ''[general]''. - -Set the current debug level: - debugLevel=1 -Values: off=0, error=1, warning=2, info=3 - -the current punctuation and dict file in use: - punctuationProfile=default -Values: Text, see available profiles in ''/etc/fenrir/punctuation'' or in ''sourceTree/config/punctuation'' - -The current punctuation level in use: - punctuationLevel=some -Values: Text, See available levels in the used punctuation file. - -Respect pause for punctuations: - respectPunctuationPause=True -Values: on=''True'', off=''False'' - -Add a pause on Line break: - newLinePause=True -Values: on=''True'', off=''False'' - -Specify the path where the clipboard should be exported to. -See [export clipboard to file](#export clipboard to file). -The variable ''$user'' is replaced by the current logged username. - clipboardExportPath=/tmp/fenrirClipboard -Values: Text, Systemfilepath - -The number of available clipboards: - numberOfClipboards=10 -Values: Integer, 1 - 999 - -Replace emoticons like :) or ;) with text insertions: - emoticons=True -Values: on=''True'', off=''False'' - -Define the current Fenrir keys: - fenrirKeys=KEY_KP0,KEY_META,KEY_INSERT -Values, Text list, separated by comma. - -Define the current script keys: - scriptKey=KEY_COMPOSE -Values, Text list, separated by comma. - -The time format to be used for (time command) output: - timeFormat=%H:%M:%P -Values: see python specification for [datetime.strftime](https///docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior) - -The date format to be used for (date command) output: - dateFormat=%A, %B %d, %Y -Values: see python specification for [datetime.strftime](https///docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior) - -Enable or Disable spellcheck whilst typing: - autoSpellCheck=True -Values: on=''True'', off=''False'' - -The use of the dictionary with spellcheck: - spellCheckLanguage=en_US -Values: Text, see aspell dictionary's. - -Folder Path for your scripts "scriptKey" functionality: - scriptPath=/usr/share/fenrirscreenreader/scripts -Values: Text, Existing path on file system. - -Override commands or create new ones without changing the Fenrir defaults: - commandPath=/usr/share/fenrirscreenreader/commands -Values: Text, Existing path on file system. -Subfolders in commandPath are: - -* ''commands'' = to create shortcut commands - -* ''onInput'' = executed while typing - -* ''onScreenChange'' = executed on change the screen (change from TTY4 to TTY6) - -* ''onScreenUpdate'' = executed when the screen is captured - -### Focus - -The configuration for basic focus is in the section ''[focus]''. -Follow the text cursor: - cursor=True -Values: on=''True'', off=''False'' - -Follow highlighted text changes (Highlight Tracking): - highlight=False -Values: on=''True'', off=''False'' -### Review - -Configurations for the review mode are in the section ''[review]''. - -If "next word/ char" or "prev word/char" create a linebreak, announce it: - lineBreak=True -Values: on=''True'', off=''False'' - -If "next word/ char" or "prev word/char" cannot be performed because you reached the end of the screen, announce it: - endOfScreen=True -Values: on=''True'', off=''False'' - -Leave the review mode when pressing a key: - leaveReviewOnKeypress=False -Values: on=''True'', off=''False'' - -Leave the review mode when changing the screen (From TTY3 to TTY4): - leaveReviewOnScreenChange=True -Values: on=''True'', off=''False'' -### Promote - -"Promoted Lists" are configured in the section ''[promote]''. -Turn Promoted Lists" on or off: - enabled=True -Values: on=''True'', off=''False'' - -The minimum time interval of inactivity to activate promoting. -By default it promotes after 120 Seconds inactivity: - inactiveTimeoutSec=120 -Values: in Seconds - -Define a list of promoted words comma seperated: - list= -Values: text (comma seperated) -Example to promote the word "nickname" or a bash prompt: - list=nickname,$:,#: - -### Time - -The automated time announcement is configured in the section ''[time]''. -Time announcement is disabled by default. -Turn time announcement on or off: - enabled=True -Values: on=''True'', off=''False'' - -Should the time be announced: - presentTime=True -Values: on=''True'', off=''False'' - -Should the date be announced (just on date change): - presentDate=True -Values: on=''True'', off=''False'' - -Announce after a given period of seconds: - delaySec=0 -Value: in Seconds, 0 = Deactivated - -Announce after fixed minutes in an hour. if delaySec is >0 onMinutes is ignored: - onMinutes=00,30 -Example every 15 minutes: - onMinutes=00,15,30,45 - -Just play a soundicon, (not interrupting): - announce=True -Values: on=''True'', off=''False'' - -Interrupt current speech for time announcement: - interrupt=False -Values: on=''True'', off=''False'' -# Customization - -## 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 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/fenrirscreenreader/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. -The script gets some parameters from fenrir when it is executed. So that information is available in your script then. - -### Parameterlist - - | Parameter | Content | - | --------- | ------- | - | $1 | Username of the current logged in user | - -### Examples - -Script that just speaks the current username when pressing ScriptKey + H.\\ -File: ''/usr/share/fenrirscreenreader/scripts/helloWorld__-__key_h.sh'': - #!/bin/bash - echo $1 - - -## Commands - -You can place your own commands in "/usr/share/fenrirscreenreader/commands" (path is configurable in settings.conf). -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: ["date.py"](https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/date.py) (announce the Date), ["shut_up.py"](https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/commands/shut_up.py) (interrupt output) -the basic scheme for a command is as follows: - - from core import debug - - class command(): - def __init__(self): - pass - def initialize(self, environment): - self.env = environment - def shutdown(self): - pass - def getDescription(self): - return _('No description found') - def run(self): - pass - def setCallback(self, callback): - pass - - -* [Template lives here](https///github.com/chrys87/fenrir/blob/master/src/fenrir/commands/command_template.py) - -* The class needs to have the name "command". - -* "initialize" is running once whilst loading the command. - -* "shutdown" is running on unload like the command (quit fenrir) - -* "getDescriptsion" just returns an string. That String is used in Tutorial Mode. - -* "run" is executed when the command is invoked. (shortcut is pressed, or trigger isn't running) - -* setCAllback is currently not used. and has no functionality yet. - - -# Troubleshooting - -## Fenrir does not start - 1. Have you installed all the dependencies [Support and Requirements](#Support and Requirements) - 2. Try using master, a lot of changes take place there to make Fenrir compatible with more systems -## Fenrir does not utilize the shortcuts - - 1. Make sure you have python3-evdev installed - 2. Use the latest Fenrir version - 3. Make sure that Fenrir has permission to /dev/input/* and /dev/uinput (or run it as root) -## No sound at all - - 1. 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'' - 2. Use ALSA - 3. [Configure Pulse system wide](https///www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/) (Not recommended) - 4. Use gstreamerDriver: change ''settings.conf'' in the section ''sound'' the line ''driver=genericDriver'' to ''driver=gstreamerDriver'' - 5. Use wave sound-icons: change ''settings.conf'' in the section ''sound'' the line ''theme=default'' to ''theme=default-wav'' - 6. Use most current version of [sox](http://sox.sourceforge.net/) with opus support - 7. Try [apulse](https///github.com/i-rinat/apulse) (not tested by myself but might work). Please give me feedback if you try it out. -## You get sound-icons but no speech - - 1. If you are using speech-dispatcher run "spd-conf" once as user and as root. - 2. You can test if speech-dispatcher works by invoking it as root\\ ''sudo spd-say "hello world"'' -## Bugreports and feature requests - -Please report Bugs and feature requests to: -[https://github.com/chrys87/fenrir/issues](https///github.com/chrys87/fenrir/issues) - -for bugs please provide a [debug](#Howto create a debug file) file that shows the issue. -### How-to create a debug file - - 1. Delete old debug stuff\\ ''sudo rm /var/log/fenrir.log'' - 2. Start fenrir in debug mode\\ ''sudo fenrir -d'' - 3. Do your stuff to reproduce the problem - 4. Stop fenrir (''fenrirKey + q'') -the debug file is located in ''/var/log/fenrir.log'' - -Please be as precise as possible to make it easy to solve the problem. - +rate=0.5 +pitch=0.5 +volume=1.0 + +[sound] +enabled=True +driver=genericDriver +volume=0.7 + +[keyboard] +driver=evdevDriver +keyboardLayout=desktop + +[screen] +driver=vcsaDriver +ignoreScreen= + +[remote] +enable=True +driver=unixDriver +enableSettingsRemote=True +enableCommandRemote=True +``` + +## Remote Control + +Fenrir includes a powerful remote control system for automation and integration with external applications. + +### Configuration +Enable remote control in settings: +```ini +[remote] +enable=True +driver=unixDriver # or tcpDriver +port=22447 # for TCP driver +enableSettingsRemote=True # allow settings changes +enableCommandRemote=True # allow command execution +``` + +### Basic Usage with socat + +#### Speech Control +```bash +# Interrupt current speech +echo "command interrupt" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Speak custom text +echo "command say Hello, this is a test" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Temporarily disable speech +echo "command tempdisablespeech" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### Settings Control +```bash +# Enable highlight tracking +echo "setting set focus#highlight=True" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Change speech parameters +echo "setting set speech#rate=0.8" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set speech#pitch=0.6" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set speech#volume=0.9" | 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 + +# Voice and TTS control +echo "setting set speech#voice=en-us+f3" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting set speech#module=espeak-ng" | 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 + +# Reset all settings +echo "setting reset" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Save settings +echo "setting save" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +echo "setting saveas /tmp/my-settings.conf" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### Clipboard Operations +```bash +# Add text to clipboard +echo "command clipboard Text to copy" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock + +# Export clipboard to file +echo "command exportclipboard" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +#### Application Control +```bash +# Quit Fenrir +echo "command quitapplication" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +``` + +### Command Reference + +**Speech Commands:** +- `command say ` - Speak text +- `command interrupt` - Stop speech +- `command tempdisablespeech` - Disable until next key + +**Settings Commands:** +- `setting set
#=` - Change setting +- `setting reset` - Reset to defaults +- `setting save` - Save current settings + +**Other Commands:** +- `command clipboard ` - Add to clipboard +- `command exportclipboard` - Export clipboard to file +- `command window ` - Define window +- `command resetwindow` - Reset window +- `command vmenu ` - Set virtual menu +- `command resetvmenu` - Reset virtual menu + +**Key Settings You Can Change:** +- Punctuation level: `setting set general#punctuationLevel=all` +- Speech parameters: `setting set speech#rate=0.8;speech#pitch=0.6` +- Voice selection: `setting set speech#voice=en-us+f3` +- Character echo: `setting set keyboard#charEchoMode=1` +- Screen ignore: `setting set screen#ignoreScreen=1,2,3` + +### Scripting Integration + +#### Bash Helper Function +```bash +fenrir_say() { + echo "command say $1" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock +} + +# Usage +fenrir_say "Build completed" +``` + +#### Python Integration +```python +import socket +import os + +def send_fenrir_command(command): + socket_path = "/tmp/fenrirscreenreader-deamon.sock" + if os.path.exists(socket_path): + sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + try: + sock.connect(socket_path) + sock.send(command.encode('utf-8')) + finally: + sock.close() + +send_fenrir_command("command say Process complete") +``` + +## Advanced Features + +### Spell Checking +- `Fenrir + S` - Spell check current word +- `Fenrir + S S` - Add word to dictionary +- `Fenrir + Shift + S` - Remove word from dictionary + +### Bookmarks (1-10) +- `Fenrir + Shift + [1-0]` - Set bookmark +- `Fenrir + [1-0]` - Go to bookmark +- `Fenrir + Ctrl + [1-0]` - Clear bookmark + +### Multiple Clipboards +- `Fenrir + Home/End` - First/last clipboard +- `Fenrir + PageUp/PageDown` - Previous/next clipboard + +### Window Mode +1. Set marks to define window area +2. `Fenrir + Keypad /` - Set window +3. `Fenrir + Keypad / /` - Clear window + +## Drivers + +### Speech Drivers +- **speechdDriver** - Speech-dispatcher (recommended) +- **genericDriver** - Command-line TTS (espeak, etc.) + +### Sound Drivers +- **genericDriver** - Sox-based (default) +- **gstreamerDriver** - GStreamer-based + +### Input Drivers +- **evdevDriver** - Linux evdev (recommended for Linux) +- **ptyDriver** - Terminal emulation (cross-platform) + +### Screen Drivers +- **vcsaDriver** - Linux VCSA devices (TTY) +- **ptyDriver** - Terminal emulation + +### Remote Drivers +- **unixDriver** - Unix socket remote control (recommended) +- **tcpDriver** - TCP socket remote control (localhost only) + +## Command Line Options + +``` +fenrir [OPTIONS] +``` + +- `-h, --help` - Show help +- `-v, --version` - Show version +- `-f, --foreground` - Run in foreground +- `-s, --setting FILE` - Custom settings file +- `-o, --options SECTION#SETTING=VALUE;..` - Override settings +- `-d, --debug` - Enable debug mode +- `-p, --print` - Print debug to screen +- `-e, --emulated-pty` - PTY emulation for desktop use +- `-E, --emulated-evdev` - PTY + evdev emulation +- `-F, --force-all-screens` - Ignore ignoreScreen setting + +## Troubleshooting + +### No Speech +1. Test speech-dispatcher: `sudo spd-say "hello"` +2. Check driver setting in configuration +3. Verify speech-dispatcher is running + +### No Sound +1. Run audio configuration script: `configure_pulse.sh` or `configure_pipewire.sh` +2. Check sound driver setting +3. Verify sox installation + +### No Input Response +1. Check permissions: `/dev/input/*` and `/dev/uinput` +2. Verify evdev driver setting +3. Run as root for testing + +### Debug Mode +```bash +sudo fenrir -f -d +# Debug output goes to /var/log/fenrir.log +``` + +## Getting Help + +- **Tutorial Mode**: `Fenrir + H` (interactive help) +- **Wiki**: https://git.stormux.org/storm/fenrir/wiki +- **Email**: stormux+subscribe@groups.io +- **IRC**: irc.stormux.org #stormux + +## See Also + +- [README.md](../README.md) - Installation and basic setup +- [settings.conf](../config/settings/settings.conf) - Configuration reference +- `man fenrir` - Manual page \ No newline at end of file diff --git a/src/fenrir b/src/fenrir index 04281eba..02fb6347 100755 --- a/src/fenrir +++ b/src/fenrir @@ -67,6 +67,11 @@ def create_argument_parser(): action='store_true', help='Use PTY emulation with evdev for input (single instance)' ) + argumentParser.add_argument( + '-F', '--force-all-screens', + action='store_true', + help='Force Fenrir to respond on all screens, ignoring ignoreScreen setting' + ) return argumentParser def validate_arguments(cliArgs): diff --git a/src/fenrirscreenreader/commands/onByteInput/10000-shut_up.py b/src/fenrirscreenreader/commands/onByteInput/10000-shut_up.py index 8828ffab..522ab94a 100644 --- a/src/fenrirscreenreader/commands/onByteInput/10000-shut_up.py +++ b/src/fenrirscreenreader/commands/onByteInput/10000-shut_up.py @@ -18,15 +18,19 @@ class command(): def run(self): if not self.env['runtime']['settingsManager'].getSettingAsBool('keyboard', 'interruptOnKeyPress'): + return + if self.env['runtime']['inputManager'].noKeyPressed(): return if self.env['runtime']['screenManager'].isScreenChange(): return + if len(self.env['input']['currInput']) <= len(self.env['input']['prevInput']): + return # if the filter is set - #if self.env['runtime']['settingsManager'].getSetting('keyboard', 'interruptOnKeyPressFilter').strip() != '': - # filterList = self.env['runtime']['settingsManager'].getSetting('keyboard', 'interruptOnKeyPressFilter').split(',') - # for currInput in self.env['input']['currInput']: - # if not currInput in filterList: - # return + if self.env['runtime']['settingsManager'].getSetting('keyboard', 'interruptOnKeyPressFilter').strip() != '': + filterList = self.env['runtime']['settingsManager'].getSetting('keyboard', 'interruptOnKeyPressFilter').split(',') + for currInput in self.env['input']['currInput']: + if not currInput in filterList: + return self.env['runtime']['outputManager'].interruptOutput() def setCallback(self, callback): diff --git a/src/fenrirscreenreader/core/screenManager.py b/src/fenrirscreenreader/core/screenManager.py index 3f7afe98..04f6418f 100644 --- a/src/fenrirscreenreader/core/screenManager.py +++ b/src/fenrirscreenreader/core/screenManager.py @@ -177,6 +177,9 @@ class screenManager(): def isIgnoredScreen(self, screen = None): if screen == None: screen = self.env['screen']['newTTY'] + # Check if force all screens flag is set + if self.env['runtime'].get('force_all_screens', False): + return False ignoreScreens = [] fixIgnoreScreens = self.env['runtime']['settingsManager'].getSetting('screen', 'ignoreScreen') if fixIgnoreScreens != '': diff --git a/src/fenrirscreenreader/core/settingsManager.py b/src/fenrirscreenreader/core/settingsManager.py index 93bec064..83227365 100644 --- a/src/fenrirscreenreader/core/settingsManager.py +++ b/src/fenrirscreenreader/core/settingsManager.py @@ -317,6 +317,9 @@ class settingsManager(): environment['runtime']['debug'] = debugManager.debugManager(self.env['runtime']['settingsManager'].getSetting('general','debugFile')) environment['runtime']['debug'].initialize(environment) + + if cliArgs.force_all_screens: + environment['runtime']['force_all_screens'] = True if not os.path.exists(self.getSetting('sound','theme') + '/soundicons.conf'): if os.path.exists(soundRoot + self.getSetting('sound','theme')): diff --git a/src/fenrirscreenreader/fenrirVersion.py b/src/fenrirscreenreader/fenrirVersion.py index 8c854f01..01b1fbc0 100644 --- a/src/fenrirscreenreader/fenrirVersion.py +++ b/src/fenrirscreenreader/fenrirVersion.py @@ -4,5 +4,5 @@ # Fenrir TTY screen reader # By Chrys, Storm Dragon, and contributers. -version = "2025.06.04" +version = "2025.06.06" codeName = "testing"