spd-conf

spd-conf [-e|-d] [-t] [-s] [-u USER] [-h] ARGUMENT

-e
    Enables support for the specified client application or speech module. This is typically followed by the name of the client or module.

-d
    Disables support for the specified client application or speech module. This is also followed by the name of the client or module.

-t
    Activates test mode. In this mode, spd-conf will simulate the configuration changes without actually writing anything to the disk. Useful for dry runs.

-s
    Enables silent mode. No output will be printed to the console during execution, useful for scripting or automated tasks.

-u USER
    Specifies a different user for whom the configuration should be applied, instead of the current user. This is particularly useful for system-wide configurations or managing other user accounts.

-h
    Displays a brief help message and usage instructions for the spd-conf command.

ARGUMENT
    The name of the client application (e.g., 'firefox', 'orca') or the speech module (e.g., 'espeak', 'rhvoice', 'festival') to be enabled or disabled. This argument is mandatory when using -e or -d.

spd-conf is a utility script designed to simplify the configuration of the Speech Dispatcher system. Speech Dispatcher is an interface that provides a common API for various speech synthesis (text-to-speech) systems, allowing applications to speak without needing to directly interact with different synthesizers.

The primary function of spd-conf is to enable or disable support for specific client applications (e.g., screen readers like Orca, or browsers like Firefox with accessibility features) and speech synthesis modules (e.g., eSpeak, RHVoice, Festival) within the Speech Dispatcher framework. It automates the modification of relevant configuration files, which are typically located in the user's home directory (e.g., ~/.config/speech-dispatcher/) or system-wide (e.g., /etc/speech-dispatcher/). This tool helps users and administrators manage which applications can utilize Speech Dispatcher and which speech engines are available and active, streamlining the setup and customization process for accessibility and vocal feedback.

spd-conf requires the Speech Dispatcher service to be installed and running to be effective. It primarily modifies user-specific configuration files (e.g., in ~/.config/speech-dispatcher/). For system-wide changes or modifications for other users (using -u), appropriate permissions (e.g., sudo) may be required. Incorrect use of arguments or attempting to configure non-existent clients/modules may not always result in clear error messages. Always verify configuration changes after running the command.

When spd-conf is executed, it modifies configuration files that dictate how Speech Dispatcher behaves. For individual users, these files are typically found in ~/.config/speech-dispatcher/. For system-wide settings, the relevant files reside in /etc/speech-dispatcher/. These include settings for enabled modules, client access, and other Speech Dispatcher preferences. The tool intelligently determines which files to adjust based on the specified user or system context.

The core functionality of spd-conf lies in toggling support. When you enable a client (e.g., with spd-conf -e firefox), it ensures that Firefox can communicate with and use the Speech Dispatcher service for text-to-speech output. When disabling a module (e.g., with spd-conf -d espeak), it instructs Speech Dispatcher to no longer use eSpeak as a available speech synthesizer, which can be useful for troubleshooting or managing resources.

spd-conf is a component of the broader Speech Dispatcher project, which began development in the early 2000s to provide a standard abstraction layer for speech synthesis. As the project matured, utilities like spd-conf were introduced to simplify the often complex task of configuring different speech synthesizers and client applications. Its development has focused on making the Speech Dispatcher framework more user-friendly and accessible, reducing the need for manual editing of configuration files.

speech-dispatcher(1), speechd(1), speechd.conf(5), sd_open(3)