Skip to content

Improve formatting of Linux documentation #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juanruitina wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improve formatting of Linux documentation #48

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d483c5
Provide command for Linux
juanruitina Jul 1, 2025
81ffbc1
Update linux.md
juanruitina Jul 1, 2025
042ae82
Add headings to linux.md
juanruitina Jul 1, 2025
32733d3
Update linux.md
juanruitina Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions content/en/linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ title: "Using RHVoice on Linux"

There are three possible options of installing RHVoice on Linux:

* 1. An up-to-date package distributed through the Snap Store. Below we describe how to install it.
* 2. One of the packages built for specific Linux distributions. Not all of them will be up-to-date and provide all the voices. See [this page](https://github.com/RHVoice/RHVoice/blob/master/doc/en/Packaging-status.md) for more information.
* 3. Compiling from source: visit [RHVoice source repository](https://github.com/RHVoice/RHVoice) to learn more.
1. An up-to-date package distributed through the Snap Store. Below we describe how to install it.
2. One of the packages built for specific Linux distributions. Not all of them will be up-to-date and provide all the voices. See [this page](https://github.com/RHVoice/RHVoice/blob/master/doc/en/Packaging-status.md) for more information.
3. Compiling from source: visit [RHVoice source repository](https://github.com/RHVoice/RHVoice) to learn more.

Distribution through the Snap packaging system is preferred by the developers of the core RHVoice engine, as it allows us to easily publish a single up-to-date binary. If you are not familiar with snaps, please visit [this website](https://snapcraft.io/) to learn about them. Your preferred Linux distribution may already have this system preinstalled, or it may be available as a package in its repository.

## Install RHVoice snap

The snap only installs the RHVoice TTS engine itself, including the module connecting RHVoice to Speech Dispatcher. Voices need to be installed via the newly implemented built-in command-line voice manager.

Most of the commands described below need to be run as root. We will assume you use the sudo command.
Expand Down Expand Up @@ -41,12 +43,18 @@ Now let's test if it speaks:
echo hello|rhvoice.test
```

## Use RHVoice with Orca

If you use the Orca screen reader, you will need to manually connect RHVoice to Speech Dispatcher, which is the software Orca relies on to work with TTS engines. Unfortunately, we are not aware of any way we could register RHVoice with Speech Dispatcher automatically.

The method described below has been tested on Ubuntu. If it doesn't work on your Linux distribution, please let us know.
Orca is the default screen reader in Linux distributions such as Ubuntu, Fedora and Debian. The method described below has been tested on Ubuntu. If it doesn't work on your Linux distribution, please let us know.

1. Open the terminal and change directory to `/usr/lib/speech-dispatcher-modules`.
2. Create a symbolic link to RHVoice's module for Speech Dispatcher:
1. Install the RHVoice snap and at least one voice as explained in the previous section.
2. Open the terminal and change to the directory that contains the Speech Dispatcher modules:
```
cd /usr/lib/speech-dispatcher-modules
```
3. Create a symbolic link to RHVoice's module for Speech Dispatcher:
```
sudo ln -s /snap/rhvoice/current/bin/sd_rhvoice
```
Expand Down