Overview of CySpeak

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

Overview of CySpeak

CySpeak is the Blueprint reading assistant. It speaks a text buffer, a plain-text file, or the X selection through classic portable TTS engines.

Open this book from Help Books as "CySpeak", or:

cyhelp --book CySpeak --topic overview

The Applications page lists it as: Reading assistant.

What It Does

Open the Motif face to edit a buffer, paste, open a file, pick rate and engine, and Speak or Stop. One-shot CLI forms speak the selection or stop speech without claiming the GUI window.

Engine preference when engine=auto: eSpeak NG, eSpeak, Flite, Festival, then spd-say (speech-dispatcher cold start is slow). Neural / cloud voices are out of scope.

Session hotkeys for speak-selection and stop are bound in cykeys; cywm is the sole root grabber. CySpeak never grabs keys itself.

What It Is Not

• Not a screen reader (no AT-SPI, braille, or browser DOM)
• Not a neural cloud TTS service
• Not a second keyboard grabber beside cywm

In This Book

• Using CySpeak -- buffer, selection, cykeys chords
• Command Line -- GUI and one-shot flags
• Copyright