				The Basics

LOADSPK and DUMPSPK are programs to interact with the Speakup package.  They
allow customization of the way Speakup talks, in the same manner as loadkeys.


Usage: loadspk [OPTIONS] [file]
Loads configuration from [file] into speakup.  If [file] is not specified,
input is read from stdin
OPTIONS:
	-h	this help listing
	-v	verbose output



Usage: dumpspk [OPTIONS] [file]
Dumps configuration from speakup into [file].  If [file] is not specified,
config. info is written to stdout.
OPTIONS:
	-h    this help listing
	-v    verbose output

---

			Details, details, details

The heart of loadspk is the config file.  Each line takes the form:

	<command> = [settings]

where <command> is one of:

General Commands
----------------
	pitch		(default pitch)
	rate		(default rate)
	tone		(default tone)
	volume		(speaker volume)
	line_wrap_bleep (toggle bleeping on line wraps)
	attribute_bleep (toggle bleeping when character attribute changes)
	bleep_time	(length of bleeps in milliseconds)
	spell_delay	(delay between characters 1-5.  Due to hardware
			inconsistencies, the DoubleTalk's '1' is about as
			fast as it's '3' value.)
	punc_level	(speakup's punctutation level,
			0=none, 1=some, 2=most, 3=all)
	caps_start	(changes when spelling words with caps)
	caps_stop	(back to normal)
	punc_some	(characters in the punctuation set for "some")
	punc_most	(characters in the punctuation set for "most")
			(see punctuation sets below)
	say_control	(toggle to pronounce shift/control/alt/altgr)
	no_interrupt	(toggle to disable keyboard speech interruption)

Some of the synths have additional commands we've made available.
They're listed below:

Additional DoubleTalk/LiteTalk Commands
---------------------------------------
	voice		(default voice)
	ffreq		(formant frequency)
	punct		(hardware punctuation filter - obsolete, not used)

Additional Speakout Commands
----------------------------
	punct		(hardware punctuation filter - obsolete, not used)

Additional Audapter Commands
----------------------------
	punct		(hardware punctuation filter - obsolete, not used)

Additional Apollo Commands
--------------------------
	language	(selects a language.  valid values: 1-4)

Additional Dectalk External/Express Commands
--------------------------------------------
	voice		(selects a voice.  values:  p,h,f,d,b,u,r,w,k,v)
	punct		(hardware punctuation filter - obsolete, not used)

Non-user definable strings:
---------------------------
flush		-  empty synthesizer buffer.  aka 'shut up'


Punctuation Sets:
-----------------
punc_none	-  the punctuation symbols in the 'none' set.  Currently empty.
punc_some	-  characters in the punctuation set for "some"
punc_most	-  characters in the punctuation set for "most"
punc_all	-  the punctuation symbols in the 'all' set.   Set to:
			!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~

The punctuation sets, as with all settings in loadspk, use C-style quoting,
so one may use \x32 (hex 32h), \065 (octal 065), or \n (newline) style
special character sequences.  As a result, the '\' character must itself be
quoted, using "\\", if it is to be included in the set.

The [settings] are quite flexible.  They may either be straight words, in which
case, the synth will say them.

 	eg.  caps_start = caps
 		will say the word 'CAPS' whenever it encounters a capital
 		letter in spell mode.

You may also use quoted hex values to send to the card.
 	eg.  caps_start = \x1bP5
 		will send 1bh (esc) P5 (pitch 5 for the Accent) to the synth.

But, I think you'll agree that using hex values is a pain in the neck, so you
can also use aliased commands:
 	artic(0-9)		Articulation
 	punct(0-15)		Punctuation Filter
 	cmode(0-31)		Character Mode/Delay
 	phoneme()		Phoneme Mode
 	expr(0-9)		Expression
 	ffreq(0-9)		Formant Frequency
 	protocol(0-63)		Protocol Options
 	monotone()		Monotone
 	voice(0-4)		Voice
 	pitch(0-99)		Pitch
 	reverb(0-9)		Reverberation
 	rate(0-9)		Rate/Speed
 	tmode(0-15)		Text Mode/Delay
	volume(0-9)		Volume
 	tone(0-2)		Tone
 	timeout(0-15)		Timeout Delay
 NOTE:  These are only supported for the DoubleTalk card at present.  'Cause
   I'm lazy.  They are simple aliases that translate down to the hardware
   equivalent.  Check out symbols_*.h to see how they're done... a clue: think
   'fill in the blank'

 NOTE2: Shut Up is not in the list.  That must still be referenced using \x18.

If you do not specify a value for settings, Speakup/loadspk will reset the
value to the default setting.  If you wish to force a blank setting, use:

	'<command> = \ '  (without the quotes, but the space is important)

You may also use comments in the config files.  A commented line has the first
character of each line as a '#'.  The rest of the line is ignored. 

Happy hacking!
		-- Andy
