Command Line

Documentation / CySpeak

• Overview of CySpeak
  • What It Does
  • What It Is Not
• Using CySpeak
  • The Reading Face
  • Speak Selection Order
  • Hotkeys Via Cykeys
  • Engines
• Command Line
  • One-Shot Actions
  • Conf And Hotkeys
• Copyright

Command Line

cyspeak [options] [file]

With no one-shot flag, opens the Motif reading face (singleton raise). A plain-text file argument loads into the buffer.

Standard: -h/--help, -V/--version, --selftest, --log SPEC, -v/--verbose, -q/--quiet.

One-Shot Actions

These do not claim the GUI singleton; they run and exit.

• --speak-selection -- speak PRIMARY and/or CLIPBOARD per conf (speak_primary / speak_clipboard); exit. Non-zero when nothing to speak, sources disabled, or no engine
• --stop -- cancel speech (spd-say -C or kill the engine job); exit 0
• --list-engines -- print detected TTS engines, one per line

Conf And Hotkeys

Prefs: ~/.cyanotype/cyspeak.conf (override: CYSPEAK_CONF).

Global hotkeys are not grabbed by cyspeak. Bind in cykeys; cywm is the sole grabber:

exec.cyspeak.speak_sel  ...  cyspeak --speak-selection
exec.cyspeak.stop       ...  cyspeak --stop

No stock chords ship for those ids; choose your own in cykeys. Day-to-day selection order and the reading face are in Using CySpeak.

Examples

cyspeak
cyspeak ~/notes/readme.txt
cyspeak --speak-selection
cyspeak --stop
cyspeak --list-engines

See Also

• Using CySpeak
• Overview of CySpeak