# This is a configuration file template for the BRLTTY application. 
# Uncomment those entries which apply to your personal needs and system
# requirements.

# BRLTTY expects to find its configuration file in "@CONFIGURATION_DIRECTORY@/@configuration_file@"
# (can be overridden with the -f [--configuration-file=] option).
# If it doesn't exist, then BRLTTY silently continues but may require
# that certain command line options be explicitly supplied.

# Blank lines are ignored. The character '#', anywhere on a line,
# initiates a comment; all characters from it to the end of that line
# are ignored.

# Each configuration entry consists of a keyword followed by its operand.
# An arbitrary amount of white space, (blanks and/or tabs), may occur
# before the keyword, as well as before and after the operand. Keyword
# processing is not case sensitive. Examples of valid entries are:
#
#	Braille-Driver	pm	# Papenmeier braille displays.
#	braille-device	ttyS0	# The first Linux serial device.
#	SPEECH-DRIVER	fv	# The Festival Text to Speech System.

# The default settings given within the following descriptions assume no
# special build options (see "./configure --help" in the top-level
# directory of the source tree.


############################
# Generic Braille Settings #
############################

# The braille-driver directive specifies the two-letter driver
# identification code of the driver for the braille display.
# (can be overridden with the -b [--braille-driver=] option)
#braille-driver	al	# Alva
#braille-driver	bl	# BrailleLite
#braille-driver	bn	# BrailleNote
#braille-driver	cb	# CombiBraille
#braille-driver	ec	# EcoBraille
#braille-driver	eu	# EuroBraille
#braille-driver	ht	# HandyTech
#braille-driver	lt	# LogText
#braille-driver	mb	# MultiBraille
#braille-driver	md	# MDV (protocol 5)
#braille-driver	mn	# MiniBraille
#braille-driver	pm	# Papenmeier
#braille-driver	ts	# TSI
#braille-driver	tt	# TTY
#braille-driver	va	# Vario/RBT (emulation 1)
#braille-driver	vd	# VideoBraille
#braille-driver	vh	# Vario/RBT (emulation 2)
#braille-driver	vo	# Voyager
#braille-driver	vr	# Virtual
#braille-driver	vs	# VisioBraille
#braille-driver	xw	# XWindow

# The braille-device directive specifies the device to which the braille
# display is connected. Relative paths are anchored at "/dev". If not
# specified, "@braille_device@" will be used.
# (can be overridden with the -d [--braille-device=] option)
#braille-device	serial:@first_serial_device@	# First serial device.
#braille-device	usb:		# First USB device matching braille driver.
#braille-device	usb:nnnnn	# Specific USB device by serial number.
#braille-device	bluez:xx:xx:xx:xx:xx:xx	# Specific bluetooth device by address.

# The text-table directive specifies which text translation table to
# use. Relative paths are anchored at "@DATA_DIRECTORY@". If not specified,
# "@text_table@" will be used.
# (can be overridden with the -t [--text-table=] option)
#text-table	cz	# Czech (iso-8859-2)
#text-table	da	# Danish
#text-table	de	# German
#text-table	es	# Spanish
#text-table	fr	# French
#text-table	fr-cbifs	# French (Code Braille Informatique Français Standard)
#text-table	it	# Italian
#text-table	nabcc	# North American Braille Computer Code
#text-table	no-h	# Norwegian and German
#text-table	no-p	# Norwegian
#text-table	pl	# Polish (iso-8859-2)
#text-table	ru	# Russian (koi8-r)
#text-table	se1	# Swedish
#text-table	se2	# Swedish
#text-table	uk	# United Kingdom English
#text-table	us	# American English
#text-table	vni	# Vietnamese

# The attributes-table directive specifies which attributes translation
# table to use. Relative paths are anchored at "@DATA_DIRECTORY@". If not
# specified, "@attributes_table@" will be used.
# (can be overridden with the -a [--attributes-table=] option)
#attributes-table	attributes.tbl	#
#attributes-table	attrib.tbl	#

# The contraction-table directive specifies which braille contraction
# table to use. Relative paths are anchored at "@DATA_DIRECTORY@". If not
# specified, no contraction table will be available.
# (can be overridden with the -c [--contraction-table=] option)
#contraction-table	big5		# Chinese
#contraction-table	compress	# Remove excess white space.
#contraction-table	en-us-g2	# Grade 2 American English
#contraction-table	fr-abrege	# Contracted French
#contraction-table	fr-integral	# Uncontracted French


#############################
# Braille Driver Parameters #
#############################

# The braille-parameters directive passes non-generic parameters through
# to the braille driver.
# (can be overridden with the -B [--braille-parameters=] option)
#braille-parameters driver:parameter=setting,...

# BrailleLite Braille Driver Parameters
#braille-parameters bl:BaudRate=9600 # [300,600,1200,2400,4800,9600,19200,38400]
#braille-parameters bl:KbEmu=yes # [yes,no]

# BrailleNote Braille Driver Parameters
#braille-parameters bn:StatusCells=0

# FreedomScientific Braille Driver Parameters
#braille-parameters fs:DebugPackets=no # [no,yes]
#braille-parameters fs:StatusCells= # [0,n,-n]

# HandyTech Braille Driver Parameters
#braille-parameters ht:InputMode=no # [no,yes]

# Papenmeier Braille Driver Parameters
#braille-parameters pm:ConfigFile=@DATA_DIRECTORY@/brltty-pm.conf
#braille-parameters pm:DebugKeys=no # [no,yes]
#braille-parameters pm:DebugReads=no # [no,yes]
#braille-parameters pm:DebugWrites=no # [no,yes]

# TTY Braille Driver Parameters
#braille-parameters tt:Baud=9600 # 
#braille-parameters tt:CharSet=ISO8859-1 # 
#braille-parameters tt:Height=1 # [1-3]
#braille-parameters tt:Locale= # 
#braille-parameters tt:Term=vt100 # [terminfo]
#braille-parameters tt:Width=40 # [1-80]

# VisioBraille Braille Driver Parameters
#braille-parameters vs:DisplaySize=40 # [20-40]

# Voyager Braille Driver Parameters
#braille-parameters vo:InputMode=no # [no,yes]
#braille-parameters vo:StatusCells=3 # [0,n,-n]

# XWindow Braille Driver Parameters
#braille-parameters xw:Cols=40 # [1-80]
#braille-parameters xw:Lines=1 # [1-3]
#braille-parameters xw:Model=bare # [bare]
#braille-parameters xw:XtParms= # 


###########################
# Generic Speech Settings #
###########################

# The speech-driver directive specifies the two-letter driver
# identification code of the driver for the speech synthesizer.
# (can be overridden with the -s [--speech-driver=] option)
#speech-driver	al	# Alva
#speech-driver	bl	# BrailleLite
#speech-driver	cb	# CombiBraille
#speech-driver	es	# ExternalSpeech (executes /usr/local/bin/externalspeech)
#speech-driver	fl	# FestivalLite (text to speech engine)
#speech-driver	fv	# Festival (text to speech engine)
#speech-driver	gs	# GenericSay (pipes to /usr/local/bin/say)
#speech-driver	mp	# Mikropuhe (text to speech engine)
#speech-driver	th	# Theta (text to speech engine)
#speech-driver	vv	# ViaVoice (text to speech engine)

# The speech-fifo directive specifies the path to the FIFO used by the speech
# pass-through facility. Relative paths are anchored at "@DATA_DIRECTORY@".
# If not specified, the speech pass-through facility isn't enabled.
# (can be overridden with the -F [--speech-fifo=] option)
#speech-fifo	spk


############################
# Speech Driver Parameters #
############################

# The speech-parameters directive passes non-generic parameters through
# to the speech driver.
# (can be overridden with the -S [--speech-parameters=] option)
#speech-parameters driver:parameter=setting,...

# ExternalSpeech Speech Driver Parameters
#speech-parameters es:Program=/usr/local/bin/externalspeech
#speech-parameters es:Uid=65534
#speech-parameters es:Gid=65534

# Festival Speech Driver Parameters
#speech-parameters fv:Command=festival # [/path/to/command]
#speech-parameters fv:Name= # [kevin,kal]

# FestivalLite Speech Driver Parameters
#speech-parameters fl:Pitch=100 # [50-200]

# GenericSay Speech Driver Parameters
#speech-parameters gs:Command=/usr/local/bin/say

# Mikropuhe Speech Driver Parameters
#speech-parameters mp:Name= # [/path/to/mikropuhe/name.pu5]
#speech-parameters mp:Pitch=0 # [-10-10]

# Theta Speech Driver Parameters
#speech-parameters th:Age= # [1-99,-1--99]
#speech-parameters th:Gender= # [male,female,neuter]
#speech-parameters th:Language= # [two-letter language code]
#speech-parameters th:Name= # [voice,/path/to/voice]
#speech-parameters th:Pitch=0.0 # [-2.0-2.0]

# ViaVoice Speech Driver Parameters
#speech-parameters vv:IniFile=/usr/lib/ViaVoiceTTS/eci.ini
#speech-parameters vv:SampleRate= # [8000,11025,22050]
#speech-parameters vv:AbbreviationMode= # [on,off]
#speech-parameters vv:NumberMode= # [word,year]
#speech-parameters vv:SynthMode= # [sentence,none]
#speech-parameters vv:TextMode= # [talk,spell,literal,phonetic]
#speech-parameters vv:Language= # [AmericanEnglish,BritishEnglish,CastilianSpanish,MexicanSpanish,StandardFrench,CanadianFrench,StandardGerman,StandardItalian,SimplifiedChinese,BrazilianPortuguese]
#speech-parameters vv:Voice= # [AdultMale,AdultFemale,Child,ElderlyFemale,ElderlyMale]
#speech-parameters vv:VocalTract= # [male,female]
#speech-parameters vv:Breathiness= # [0-100]
#speech-parameters vv:HeadSize= # [0-100]
#speech-parameters vv:PitchBaseline= # [0-100]
#speech-parameters vv:PitchFluctuation= # [0-100]
#speech-parameters vv:Roughness= # [0-100]


##################
# Sound Settings #
##################

# The pcm-device directive specifies the device to use for soundcard
# digital audio. If not specified, a method- and system-dependent
# default will be used.
# (can be overridden with the -p [--pcm-device=] option)
#pcm-device	/path/to/device	# most methods
#pcm-device	pcm-handle-id	# ALSA (see second parameter of snd_pcm_open)

# The pcm-device directive specifies the device to use for the Musical
# Instrument Digital Interface. If not specified, a method- and
# system-dependent default will be used.
# (can be overridden with the -m [--midi-device=] option)
#midi-device	/path/to/device	# most methods
#midi-device	client:port	# ALSA (may use number or case-sensitive substring of name)


##########################
# Miscellaneous Settings #
##########################

# The library-directory directive specifies the absolute path to the
# directory which contains the dynamically loadable drivers. If not
# specified, @LIBRARY_DIRECTORY@ will be used.
# (can be overridden with the -L [--library-directory=] option)
#library-directory @LIBRARY_DIRECTORY@

# The data-directory directive specifies the absolute path to the directory
# which contains driver data files (help files, configuration files, etc.). If
# not specified, "@DATA_DIRECTORY@" will be used.
# (can be overridden with the -D [--data-directory=] option)
#data-directory @DATA_DIRECTORY@

# The tables-directory directive specifies the absolute path to the directory
# which contains the text and attributes tables. If not specified,
# "@DATA_DIRECTORY@" will be used.
# (can be overridden with the -T [--tables-directory=] option)
#tables-directory @DATA_DIRECTORY@

# The contractions-directory directive specifies the absolute path to the
# directory which contains the contraction tables. If not specified,
# "@DATA_DIRECTORY@" will be used.
# (can be overridden with the -C [--contractions-directory=] option)
#contractions-directory @DATA_DIRECTORY@


################################################
# Application Programming Interface Parameters #
################################################

# The api-parameters directive passes parameters to the Application
# Programming Interface.
# (can be overridden with the -A [--api-parameters=] option)
#api-parameters parameter=setting,...

#api-parameters Host=
#api-parameters Port=35751
#api-parameters KeyFile=@CONFIGURATION_DIRECTORY@/@api_keyfile@


############################
# Screen Driver Parameters #
############################

# The screen-parameters directive passes non-generic parameters through
# to the screen driver.
# (can be overridden with the -X [--screen-parameters=] option)
#screen-parameters parameter=setting,...

# Linux Screen Driver Parameters
#screen-parameters Acm=auto # [auto,iso01,vt100,cp437,user]
#screen-parameters DebugAcm=no # [no,yes]
#screen-parameters DebugSfm=no # [no,yes]
#screen-parameters DebugCtt=no # [no,yes]


