1059 lines
23 KiB
HTML
1059 lines
23 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of BRLTTY</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>BRLTTY</H1>
|
|
Section: BRLTTY User's Manual (1)<BR>Updated: 2019-02-22<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
brltty - refreshable braille display driver for Linux/Unix
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>brltty </B>[<I>option</I> ...]
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>brltty</B>
|
|
|
|
is a background process (daemon)
|
|
which provides access to the console screen (when in text mode)
|
|
for a blind person using a refreshable braille display.
|
|
It drives the braille display,
|
|
and provides complete screen review functionality.
|
|
Some speech capability has also been incorporated.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
Options can be passed to
|
|
<B>brltty</B>
|
|
|
|
in a number of ways.
|
|
From most to least influential, these are:
|
|
<DL COMPACT>
|
|
<DT id="1">1.<DD>
|
|
Command Line Options
|
|
<DT id="2">2.<DD>
|
|
Boot Parameters
|
|
<DT id="3">3.<DD>
|
|
Environment Variables
|
|
(if the
|
|
<B>-E</B>
|
|
|
|
(<B>--environment-variables</B>)
|
|
|
|
option is in effect)
|
|
<DT id="4">4.<DD>
|
|
The Configuration File
|
|
<DT id="5">5.<DD>
|
|
Built-in Defaults
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H3>Command Line Options</H3>
|
|
|
|
The options are processed sequentially from left to right.
|
|
If an option is specified more than once,
|
|
or in case of a conflict,
|
|
the rightmost specification takes precedence.
|
|
<P>
|
|
|
|
The following options are supported:
|
|
<DL COMPACT>
|
|
<DT id="6"><B>-a </B><I>table</I> (<B>--attributes-table=</B>)<DD>
|
|
The path to the attributes table.
|
|
Relative paths are anchored at
|
|
<B>/etc/brltty/Attributes</B>.
|
|
|
|
The
|
|
<B>.atb</B>
|
|
|
|
extension is optional.
|
|
The built-in default is
|
|
<B>left_right.atb</B>.
|
|
|
|
<DT id="7"><B>-b </B><I>driver</I><B>,</B>...|<B>auto</B> (<B>--braille-driver=</B>)<DD>
|
|
The driver for the braille display
|
|
(see Driver Specification).
|
|
The built-in default is <B>auto</B>.
|
|
<DT id="8"><B>-c </B><I>table</I> (<B>--contraction-table=</B>)<DD>
|
|
The path to the contraction table.
|
|
Relative paths are anchored at
|
|
<B>/etc/brltty/Contraction</B>.
|
|
|
|
The
|
|
<B>.ctb</B>
|
|
|
|
extension is optional.
|
|
<DT id="9"><B>-d </B><I>device</I><B>,</B>... (<B>--braille-device=</B>)<DD>
|
|
The device to which the braille display is connected.
|
|
The built-in default is <B>usb:,bluetooth:</B>.
|
|
<DL COMPACT><DT id="10"><DD>
|
|
<P>
|
|
|
|
The general form of a braille device specification is
|
|
<I>qualifier</I><B>:</B><I>data</I>.
|
|
For backward compatibility with earlier releases,
|
|
if the qualifier is omitted then
|
|
<B>serial:</B>
|
|
|
|
is assumed.
|
|
The following device types are supported:
|
|
<DL COMPACT>
|
|
<DT id="11"><B>Bluetooth</B>
|
|
|
|
<DD>
|
|
For a bluetooth device, specify <B>bluetooth:</B><I>address</I>.
|
|
The address must be six two-digit hexadecimal numbers separated by colons, e.g.
|
|
<B>01:23:45:67:89:AB</B>.
|
|
|
|
<DT id="12"><B>Serial</B>
|
|
|
|
<DD>
|
|
For a serial device, specify <B>serial:</B><I>device</I>.
|
|
The
|
|
<B>serial:</B>
|
|
|
|
qualifier is optional (for backward compatibility).
|
|
If a relative path is given then it's anchored at
|
|
<B>/dev/</B>
|
|
|
|
(the usual location where devices are defined on a Unix-like system).
|
|
The following device specifications all refer
|
|
to the primary serial device on Linux:
|
|
<B>serial:ttyS0</B>,
|
|
|
|
<B>serial:/dev/ttyS0</B>,
|
|
|
|
<B>ttyS0</B>,
|
|
|
|
<B>/dev/ttyS0</B>.
|
|
|
|
<DT id="13"><B>USB</B>
|
|
|
|
<DD>
|
|
For a USB device, specify <B>usb:</B>.
|
|
<B>brltty</B>
|
|
|
|
will search for the first USB device which
|
|
matches the braille display driver being used.
|
|
If this is inadequate,
|
|
e.g. if you have more than one USB braille display which requires the same driver,
|
|
then you can refine the device specification
|
|
by appending the serial number of the display to it, e.g.
|
|
<B>usb:12345</B>.
|
|
|
|
N.B.:
|
|
The "identification by serial number" feature doesn't work for some models
|
|
because some manufacturers
|
|
either don't set the USB serial number descriptor at all
|
|
or do set it but not to a unique value.
|
|
</DL>
|
|
<P>
|
|
|
|
A comma-delimited list of braille devices may be specified.
|
|
If this is done then autodetection is performed on each listed device in sequence.
|
|
This feature is particularly useful if you have
|
|
a braille display with more than one interface,
|
|
e.g. both a serial and a USB port.
|
|
</DL>
|
|
|
|
<DT id="14"><B>-e</B> (<B>--standard-error</B>)<DD>
|
|
Write logs to standard error rather than to the system log (useful for debugging).
|
|
<DT id="15"><B>-f </B><I>file</I> (<B>--configuration-file=</B>)<DD>
|
|
The path to the configuration file.
|
|
Relative paths are anchored at the current working directory.
|
|
The built-in default is
|
|
<B>/etc/brltty.conf</B>.
|
|
|
|
<DT id="16"><B>-h</B> (<B>--help</B>)<DD>
|
|
Print a command line usage summary (commonly used options only),
|
|
and then exit.
|
|
<DT id="17"><B>-i </B><I>name</I> (<B>--speech-input=</B>)<DD>
|
|
The file system object
|
|
(FIFO, named pipe, named socket, etc)
|
|
which gives other applications access to
|
|
<B>brltty</B>'s
|
|
|
|
speech driver for text-to-speech conversion.
|
|
It's created at start-up and removed at termination.
|
|
Relative paths are anchored at the current working directory.
|
|
The built-in default is
|
|
that the file system object is not created.
|
|
<DT id="18"><B>-k </B><I>table</I> (<B>--keyboard-table=</B>)<DD>
|
|
The path to the keyboard table.
|
|
Relative paths are anchored at
|
|
<B>/etc/brltty/Keyboard</B>.
|
|
|
|
The
|
|
<B>.ktb</B>
|
|
|
|
extension is optional.
|
|
<DT id="19"><B>-l </B><I>level</I> (<B>--log-level=</B>)<DD>
|
|
The minimum severity level for messages written to the log.
|
|
Any of the following numbers,
|
|
or any abbreviation of their corresponding names,
|
|
may be specified:
|
|
<DL COMPACT><DT id="20"><DD>
|
|
<DL COMPACT>
|
|
<DT id="21"><B>0</B>
|
|
|
|
<DD>
|
|
<B>emergency</B>
|
|
|
|
<DT id="22"><B>1</B>
|
|
|
|
<DD>
|
|
<B>alert</B>
|
|
|
|
<DT id="23"><B>2</B>
|
|
|
|
<DD>
|
|
<B>critical</B>
|
|
|
|
<DT id="24"><B>3</B>
|
|
|
|
<DD>
|
|
<B>error</B>
|
|
|
|
<DT id="25"><B>4</B>
|
|
|
|
<DD>
|
|
<B>warning</B>
|
|
|
|
<DT id="26"><B>5</B>
|
|
|
|
<DD>
|
|
<B>notice</B>
|
|
|
|
<DT id="27"><B>6</B>
|
|
|
|
<DD>
|
|
<B>information</B>
|
|
|
|
<DT id="28"><B>7</B>
|
|
|
|
<DD>
|
|
<B>debug</B>
|
|
|
|
</DL>
|
|
</DL>
|
|
|
|
</DL>
|
|
<P>
|
|
|
|
The built-in default is
|
|
<B>notice</B>.
|
|
|
|
<DL COMPACT>
|
|
<DT id="29"><B>-m </B><I>device</I> (<B>--midi-device=</B>)<DD>
|
|
The device to use for the Musical Instrument Digital Interface.
|
|
For ALSA it's <I>client</I><B>:</B><I>port</I>,
|
|
where each may be either a number or a case-sensitive substring of its name.
|
|
For other interfaces it's the full path to an appropriate system device.
|
|
The built-in default is:
|
|
<DL COMPACT><DT id="30"><DD>
|
|
<DL COMPACT>
|
|
<DT id="31">Linux/ALSA<DD>
|
|
the first available MIDI output port
|
|
<DT id="32">Linux/OSS<DD>
|
|
<B>/dev/sequencer</B>
|
|
|
|
</DL>
|
|
</DL>
|
|
|
|
<DT id="33"><B>-n</B> (<B>--no-daemon</B>)<DD>
|
|
Remain in the foreground (useful for debugging).
|
|
<DT id="34"><B>-p </B><I>device</I> (<B>--pcm-device=</B>)<DD>
|
|
The device to use for digital audio.
|
|
For ALSA it's <I>name</I>[<B>:</B><I>argument</I><B>,</B>...].
|
|
For other interfaces it's the full path to an appropriate system device.
|
|
The built-in default is:
|
|
<DL COMPACT><DT id="35"><DD>
|
|
<DL COMPACT>
|
|
<DT id="36">FreeBSD<DD>
|
|
<B>/dev/dsp</B>
|
|
|
|
<DT id="37">Linux/ALSA<DD>
|
|
<B>hw:0,0</B>
|
|
|
|
<DT id="38">Linux/OSS<DD>
|
|
<B>/dev/dsp</B>
|
|
|
|
<DT id="39">NetBSD<DD>
|
|
<B>/dev/audio</B>
|
|
|
|
<DT id="40">OpenBSD<DD>
|
|
<B>/dev/audio</B>
|
|
|
|
<DT id="41">Qnx<DD>
|
|
the preferred PCM output device
|
|
<DT id="42">Solaris<DD>
|
|
<B>/dev/audio</B>
|
|
|
|
</DL>
|
|
</DL>
|
|
|
|
<DT id="43"><B>-q</B> (<B>--quiet</B>)<DD>
|
|
Suppress the start-up messages.
|
|
This is done by reducing the default log level
|
|
(see the
|
|
<B>-l</B>
|
|
|
|
(<B>--log-level=</B>)
|
|
|
|
option)
|
|
to
|
|
<B>warning</B>
|
|
|
|
(<B>information</B>
|
|
|
|
if either
|
|
<B>-v</B>
|
|
|
|
(<B>--verify</B>)
|
|
|
|
or
|
|
<B>-V</B>
|
|
|
|
(<B>--version</B>)
|
|
|
|
is also specified).
|
|
<DT id="44"><B>-r</B> (<B>--release-device</B>)<DD>
|
|
Release the device to which the braille display is connected
|
|
when the current screen or window can't be read.
|
|
<DT id="45"><B>-s </B><I>driver</I><B>,</B>...|<B>auto</B> (<B>--speech-driver=</B>)<DD>
|
|
The driver for the speech synthesizer
|
|
(see Driver Specification).
|
|
The built-in default is <B>auto</B>.
|
|
<DT id="46"><B>-t </B><I>table</I> (<B>--text-table=</B>)<DD>
|
|
The path to the text table.
|
|
Relative paths are anchored at
|
|
<B>/etc/brltty/Text</B>.
|
|
|
|
The
|
|
<B>.ttb</B>
|
|
|
|
extension is optional.
|
|
The built-in default is
|
|
<B>en-nabcc.ttb</B>
|
|
|
|
(the North American Braille Computer Code).
|
|
<DT id="47"><B>-v</B> (<B>--verify</B>)<DD>
|
|
Print the start-up messages and then exit.
|
|
This always includes the versions of
|
|
<B>brltty</B>
|
|
|
|
itself,
|
|
the server side of its application programming interface,
|
|
and each of the selected braille and speech drivers.
|
|
If the
|
|
<B>-q</B>
|
|
|
|
(<B>--quiet</B>)
|
|
|
|
option isn't also specified
|
|
then it also includes the values of the options after all sources have been considered.
|
|
If more than one braille driver and/or more than one braille device
|
|
has been specified then braille display autodetection is performed.
|
|
If more than one speech driver
|
|
has been specified then speech synthesizer autodetection is performed.
|
|
<DT id="48"><B>-x </B><I>driver</I> (<B>--screen-driver=</B>)<DD>
|
|
The screen driver.
|
|
The built-in default is operating system appropriate.
|
|
<DT id="49"><B>-A </B><I>name</I><B>=</B><I>value</I><B>,</B>... (<B>--api-parameters=</B>)<DD>
|
|
Parameters for the application programming interface.
|
|
If the same parameter is specified more than once
|
|
then the rightmost specification is used.
|
|
Parameter names may be abbreviated.
|
|
<DT id="50"><B>-B </B>[<I>driver</I><B>:</B>]<I>name</I><B>=</B><I>value</I><B>,</B>... (<B>--braille-parameters=</B>)<DD>
|
|
Parameters for the braille display driver.
|
|
If the same parameter is specified more than once
|
|
then the rightmost specification is used.
|
|
Parameter names may be abbreviated.
|
|
If a parameter assignment is qualified with a driver identification code
|
|
then it's only processed if that braille display driver is being used.
|
|
<DT id="51"><B>-D </B><I>directory</I> (<B>--drivers-directory=</B>)<DD>
|
|
The path to the directory which contains
|
|
the dynamically loadable driver objects.
|
|
The built-in default is
|
|
/lib/brltty<B>.</B>
|
|
|
|
<DT id="52"><B>-E</B> (<B>--environment-variables</B>)<DD>
|
|
Recognize environment variables.
|
|
<DT id="53"><B>-F </B><I>file</I> (<B>--preferences-file=</B>)<DD>
|
|
The path to the preferences file.
|
|
Relative paths are anchored at
|
|
<B>/var/lib/brltty</B>.
|
|
|
|
The built-in default is
|
|
<B>brltty.prefs</B>.
|
|
|
|
<DT id="54"><B>-H</B> (<B>--full-help</B>)<DD>
|
|
Print a command line usage summary (all options),
|
|
and then exit.
|
|
<DT id="55"><B>-I</B> (<B>--install-service</B>)<DD>
|
|
(Windows only)
|
|
Install
|
|
<B>brltty</B>
|
|
|
|
as the
|
|
<B>BrlAPI</B>
|
|
|
|
service so that it will be automatically started when the system is booted,
|
|
and so that applications can know that a
|
|
<B>BrlAPI</B>
|
|
|
|
server is running.
|
|
<DT id="56"><B>-K </B><I>arg</I> (<B>--keyboard-properties=</B>)<DD>
|
|
Properties of the keyboard.
|
|
<DT id="57"><B>-L </B><I>file</I> (<B>--log-file=</B>)<DD>
|
|
The file to which log messages are written.
|
|
Relative paths are anchored at the current working directory.
|
|
The default is to send log messages to the system log.
|
|
<DT id="58"><B>-M </B><I>csecs</I> (<B>--message-delay=</B>)<DD>
|
|
The message hold time in hundredths of a second.
|
|
The built-in default is
|
|
<B>400</B>
|
|
|
|
(4 seconds).
|
|
<DT id="59"><B>-N</B> (<B>--no-api</B>)<DD>
|
|
Don't start the application programming interface.
|
|
<DT id="60"><B>-P </B><I>file</I> (<B>--pid-file=</B>)<DD>
|
|
The full path to the process identifier file.
|
|
If this option is supplied,
|
|
<B>brltty</B>
|
|
|
|
writes its process identifier (pid) into the specified file at start-up.
|
|
The file is removed when
|
|
<B>brltty</B>
|
|
|
|
terminates.
|
|
<DT id="61"><B>-R</B> (<B>--remove-service</B>)<DD>
|
|
(Windows only)
|
|
Remove the
|
|
<B>BrlAPI</B>
|
|
|
|
service so that
|
|
<B>brltty</B>
|
|
|
|
will not be automatically started when the system is booted,
|
|
and so that applications can know that no
|
|
<B>BrlAPI</B>
|
|
|
|
server is running.
|
|
<DT id="62"><B>-S </B>[<I>driver</I><B>:</B>]<I>name</I><B>=</B><I>value</I><B>,</B>... (<B>--speech-parameters=</B>)<DD>
|
|
Parameters for the speech synthesizer driver.
|
|
If the same parameter is specified more than once
|
|
then the rightmost specification is used.
|
|
Parameter names may be abbreviated.
|
|
If a parameter assignment is qualified with a driver identification code
|
|
then it's only processed if that speech synthesizer driver is being used.
|
|
<DT id="63"><B>-T </B><I>directory</I> (<B>--tables-directory=</B>)<DD>
|
|
The path to the directory which contains
|
|
the text, attributes, contraction, keyboard, and input tables.
|
|
The built-in default is
|
|
/etc/brltty<B>.</B>
|
|
|
|
<DT id="64"><B>-U </B><I>directory</I> (<B>--updatable-directory=</B>)<DD>
|
|
The path to a directory which contains files that can be updated.
|
|
The built-in default is
|
|
/var/lib/brltty<B>.</B>
|
|
|
|
<DT id="65"><B>-V</B> (<B>--version</B>)<DD>
|
|
Print the versions of
|
|
<B>brltty</B>
|
|
|
|
itself,
|
|
the server side of its application programming interface,
|
|
and those drivers which were configured in at build-time,
|
|
and then exit.
|
|
If the
|
|
<B>-q</B>
|
|
|
|
(<B>--quiet</B>)
|
|
|
|
option isn't also specified
|
|
then also print copyright information.
|
|
<DT id="66"><B>-W </B><I>directory</I> (<B>--writable-directory=</B>)<DD>
|
|
The path to a directory which can be written to.
|
|
The built-in default is
|
|
/var/run/brltty<B>.</B>
|
|
|
|
<DT id="67"><B>-X </B><I>name</I><B>=</B><I>value</I><B>,</B>... (<B>--screen-parameters=</B>)<DD>
|
|
Parameters for the screen driver.
|
|
If the same parameter is specified more than once
|
|
then the rightmost specification is used.
|
|
Parameter names may be abbreviated.
|
|
<DT id="68"><B>-Y </B><I>text</I> (<B>--start-message=</B>)<DD>
|
|
The text to be shown when the braille driver starts
|
|
and to be spoken when the speech driver starts.
|
|
The built-in default is
|
|
BRLTTY 6.0<B>.</B>
|
|
|
|
<DT id="69"><B>-Z </B><I>text</I> (<B>--stop-message=</B>)<DD>
|
|
The text to be shown when the braille driver stops.
|
|
The built-in default is
|
|
BRLTTY stopped<B>.</B>
|
|
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H3>Environment Variables</H3>
|
|
|
|
The following environment variables are recognized if the
|
|
<B>-E</B>
|
|
|
|
(<B>--environment-variables</B>)
|
|
|
|
option is specified:
|
|
<DL COMPACT>
|
|
<DT id="70"><B>BRLTTY_API_PARAMETERS=</B><I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the application programming interface.
|
|
See the
|
|
<B>-A</B>
|
|
|
|
(<B>--api-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="71"><B>BRLTTY_ATTRIBUTES_TABLE=</B><I>table</I><DD>
|
|
The attributes table.
|
|
See the
|
|
<B>-a</B>
|
|
|
|
(<B>--attributes-table=</B>)
|
|
|
|
option for details.
|
|
<DT id="72"><B>BRLTTY_BRAILLE_DEVICE=</B><I>device</I><B>,</B>...<DD>
|
|
The device to which the braille display is connected.
|
|
See the
|
|
<B>-d</B>
|
|
|
|
(<B>--braille-device=</B>)
|
|
|
|
option for details.
|
|
<DT id="73"><B>BRLTTY_BRAILLE_DRIVER=</B><I>driver</I><B>,</B>...|<B>auto</B><DD>
|
|
The driver for the braille display.
|
|
See the
|
|
<B>-b</B>
|
|
|
|
(<B>--braille-driver=</B>)
|
|
|
|
option for details.
|
|
<DT id="74"><B>BRLTTY_BRAILLE_PARAMETERS=</B>[<I>driver</I><B>:</B>]<I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the braille display driver.
|
|
See the
|
|
<B>-B</B>
|
|
|
|
(<B>--braille-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="75"><B>BRLTTY_CONFIGURATION_FILE=</B><I>file</I><DD>
|
|
The configuration file.
|
|
See the
|
|
<B>-f</B>
|
|
|
|
(<B>--configuration-file=</B>)
|
|
|
|
option for details.
|
|
<DT id="76"><B>BRLTTY_CONTRACTION_TABLE=</B><I>table</I><DD>
|
|
The contraction table.
|
|
See the
|
|
<B>-c</B>
|
|
|
|
(<B>--contraction-table=</B>)
|
|
|
|
option for details.
|
|
<DT id="77"><B>BRLTTY_MIDI_DEVICE=</B><I>device</I><DD>
|
|
The device to use for the Musical Instrument Digital Interface.
|
|
See the
|
|
<B>-m</B>
|
|
|
|
(<B>--midi-device=</B>)
|
|
|
|
option for details.
|
|
<DT id="78"><B>BRLTTY_PCM_DEVICE=</B><I>device</I><DD>
|
|
The device to use for digital audio.
|
|
See the
|
|
<B>-p</B>
|
|
|
|
(<B>--pcm-device=</B>)
|
|
|
|
option for details.
|
|
<DT id="79"><B>BRLTTY_PREFERENCES_FILE=</B><I>file</I><DD>
|
|
The preferences file.
|
|
See the
|
|
<B>-F</B>
|
|
|
|
(<B>--preferences-file=</B>)
|
|
|
|
option for details.
|
|
<DT id="80"><B>BRLTTY_RELEASE_DEVICE=on</B>|<B>off</B><DD>
|
|
Release the device to which the braille display is connected
|
|
when the current screen or window can't be read.
|
|
See the
|
|
<B>-r</B>
|
|
|
|
(<B>--release-device</B>)
|
|
|
|
option for details.
|
|
<DT id="81"><B>BRLTTY_SCREEN_DRIVER=</B><I>driver</I><DD>
|
|
The screen driver.
|
|
See the
|
|
<B>-x</B>
|
|
|
|
(<B>--screen-driver=</B>)
|
|
|
|
option for details.
|
|
<DT id="82"><B>BRLTTY_SCREEN_PARAMETERS=</B><I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the screen driver.
|
|
See the
|
|
<B>-X</B>
|
|
|
|
(<B>--screen-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="83"><B>BRLTTY_SPEECH_DRIVER=</B><I>driver</I><B>,</B>...|<B>auto</B><DD>
|
|
The driver for the speech synthesizer.
|
|
See the
|
|
<B>-s</B>
|
|
|
|
(<B>--speech-driver=</B>)
|
|
|
|
option for details.
|
|
<DT id="84"><B>BRLTTY_SPEECH_INPUT=</B><I>name</I><DD>
|
|
The file system object which gives other applications access to
|
|
<B>brltty</B>'s
|
|
|
|
speech driver for text-to-speech conversion.
|
|
See the
|
|
<B>-i</B>
|
|
|
|
(<B>--speech-input=</B>)
|
|
|
|
option for details.
|
|
<DT id="85"><B>BRLTTY_SPEECH_PARAMETERS=</B>[<I>driver</I><B>:</B>]<I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the speech synthesizer driver.
|
|
See the
|
|
<B>-S</B>
|
|
|
|
(<B>--speech-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="86"><B>BRLTTY_TEXT_TABLE=</B><I>table</I><DD>
|
|
The text table.
|
|
See the
|
|
<B>-t</B>
|
|
|
|
(<B>--text-table=</B>)
|
|
|
|
option for details.
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H3>The Configuration File</H3>
|
|
|
|
Blank lines are ignored.
|
|
If the character
|
|
<B>#</B>
|
|
|
|
occurs on any line then
|
|
all characters from it to the end of that line are treated as a comment.
|
|
<P>
|
|
|
|
The following configuration directives are supported:
|
|
<DL COMPACT>
|
|
<DT id="87"><B>api-parameters </B><I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the application programming interface.
|
|
See the
|
|
<B>-A</B>
|
|
|
|
(<B>--api-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="88"><B>attributes-table </B><I>table</I><DD>
|
|
The attributes table.
|
|
See the
|
|
<B>-a</B>
|
|
|
|
(<B>--attributes-table=</B>)
|
|
|
|
option for details.
|
|
<DT id="89"><B>braille-device </B><I>device</I><B>,</B>...<DD>
|
|
The device to which the braille display is connected.
|
|
See the
|
|
<B>-d</B>
|
|
|
|
(<B>--braille-device=</B>)
|
|
|
|
option for details.
|
|
<DT id="90"><B>braille-driver </B><I>driver</I><B>,</B>...|<B>auto</B><DD>
|
|
The driver for the braille display.
|
|
See the
|
|
<B>-b</B>
|
|
|
|
(<B>--braille-driver=</B>)
|
|
|
|
option for details.
|
|
<DT id="91"><B>braille-parameters </B>[<I>driver</I><B>:</B>]<I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the braille display driver.
|
|
See the
|
|
<B>-B</B>
|
|
|
|
(<B>--braille-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="92"><B>contraction-table </B><I>table</I><DD>
|
|
The contraction table.
|
|
See the
|
|
<B>-c</B>
|
|
|
|
(<B>--contraction-table=</B>)
|
|
|
|
option for details.
|
|
<DT id="93"><B>midi-device </B><I>device</I><DD>
|
|
The device to use for the Musical Instrument Digital Interface.
|
|
See the
|
|
<B>-m</B>
|
|
|
|
(<B>--midi-device=</B>)
|
|
|
|
option for details.
|
|
<DT id="94"><B>pcm-device </B><I>device</I><DD>
|
|
The device to use for digital audio.
|
|
See the
|
|
<B>-p</B>
|
|
|
|
(<B>--pcm-device=</B>)
|
|
|
|
option for details.
|
|
<DT id="95"><B>preferences-file </B><I>file</I><DD>
|
|
The preferences file.
|
|
See the
|
|
<B>-F</B>
|
|
|
|
(<B>--preferences-file=</B>)
|
|
|
|
option for details.
|
|
<DT id="96"><B>release-device on</B>|<B>off</B><DD>
|
|
Release the device to which the braille display is connected
|
|
when the current screen or window can't be read.
|
|
See the
|
|
<B>-r</B>
|
|
|
|
(<B>--release-device</B>)
|
|
|
|
option for details.
|
|
<DT id="97"><B>screen-driver </B><I>driver</I><DD>
|
|
The screen driver.
|
|
See the
|
|
<B>-x</B>
|
|
|
|
(<B>--screen-driver=</B>)
|
|
|
|
option for details.
|
|
<DT id="98"><B>screen-parameters </B><I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the screen driver.
|
|
See the
|
|
<B>-X</B>
|
|
|
|
(<B>--screen-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="99"><B>speech-driver </B><I>driver</I><B>,</B>...|<B>auto</B><DD>
|
|
The driver for the speech synthesizer.
|
|
See the
|
|
<B>-s</B>
|
|
|
|
(<B>--speech-driver=</B>)
|
|
|
|
option for details.
|
|
<DT id="100"><B>speech-input me</B><DD>
|
|
The file system object which gives other applications access to
|
|
<B>brltty</B>'s
|
|
|
|
speech driver for text-to-speech conversion.
|
|
See the
|
|
<B>-i</B>
|
|
|
|
(<B>--speech-input=</B>)
|
|
|
|
option for details.
|
|
<DT id="101"><B>speech-parameters </B>[<I>driver</I><B>:</B>]<I>name</I><B>=</B><I>value</I><B>,</B>...<DD>
|
|
Parameters for the speech synthesizer driver.
|
|
See the
|
|
<B>-S</B>
|
|
|
|
(<B>--speech-parameters=</B>)
|
|
|
|
option for details.
|
|
<DT id="102"><B>text-table </B><I>table</I><DD>
|
|
The text table.
|
|
See the
|
|
<B>-t</B>
|
|
|
|
(<B>--text-table=</B>)
|
|
|
|
option for details.
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H3>Driver Specification</H3>
|
|
|
|
A braille display or speech synthesizer driver
|
|
must be specified via its identification code:
|
|
<DL COMPACT><DT id="103"><DD>
|
|
<DL COMPACT>
|
|
<DT id="104"><B>al</B>
|
|
|
|
<DD>
|
|
Alva
|
|
<DT id="105"><B>an</B>
|
|
|
|
<DD>
|
|
Android
|
|
<DT id="106"><B>at</B>
|
|
|
|
<DD>
|
|
Albatross
|
|
<DT id="107"><B>ba</B>
|
|
|
|
<DD>
|
|
BrlAPI
|
|
<DT id="108"><B>bc</B>
|
|
|
|
<DD>
|
|
BrailComm
|
|
<DT id="109"><B>bd</B>
|
|
|
|
<DD>
|
|
Braudi
|
|
<DT id="110"><B>bg</B>
|
|
|
|
<DD>
|
|
B2G
|
|
<DT id="111"><B>bl</B>
|
|
|
|
<DD>
|
|
BrailleLite
|
|
<DT id="112"><B>bm</B>
|
|
|
|
<DD>
|
|
Baum
|
|
<DT id="113"><B>bn</B>
|
|
|
|
<DD>
|
|
BrailleNote
|
|
<DT id="114"><B>cb</B>
|
|
|
|
<DD>
|
|
CombiBraille
|
|
<DT id="115"><B>ec</B>
|
|
|
|
<DD>
|
|
EcoBraille
|
|
<DT id="116"><B>en</B>
|
|
|
|
<DD>
|
|
eSpeak-NG
|
|
<DT id="117"><B>es</B>
|
|
|
|
<DD>
|
|
eSpeak
|
|
<DT id="118"><B>eu</B>
|
|
|
|
<DD>
|
|
EuroBraille
|
|
<DT id="119"><B>fl</B>
|
|
|
|
<DD>
|
|
FestivalLite
|
|
<DT id="120"><B>fs</B>
|
|
|
|
<DD>
|
|
FreedomScientific
|
|
<DT id="121"><B>fv</B>
|
|
|
|
<DD>
|
|
Festival
|
|
<DT id="122"><B>gs</B>
|
|
|
|
<DD>
|
|
GenericSay
|
|
<DT id="123"><B>hd</B>
|
|
|
|
<DD>
|
|
Hedo
|
|
<DT id="124"><B>hm</B>
|
|
|
|
<DD>
|
|
HIMS
|
|
<DT id="125"><B>ht</B>
|
|
|
|
<DD>
|
|
HandyTech
|
|
<DT id="126"><B>hw</B>
|
|
|
|
<DD>
|
|
HumanWare
|
|
<DT id="127"><B>ir</B>
|
|
|
|
<DD>
|
|
Iris
|
|
<DT id="128"><B>ic</B>
|
|
|
|
<DD>
|
|
Inceptor
|
|
<DT id="129"><B>lb</B>
|
|
|
|
<DD>
|
|
Libbraille
|
|
<DT id="130"><B>lt</B>
|
|
|
|
<DD>
|
|
LogText
|
|
<DT id="131"><B>mb</B>
|
|
|
|
<DD>
|
|
MultiBraille
|
|
<DT id="132"><B>md</B>
|
|
|
|
<DD>
|
|
MDV
|
|
<DT id="133"><B>mm</B>
|
|
|
|
<DD>
|
|
BrailleMemo
|
|
<DT id="134"><B>mn</B>
|
|
|
|
<DD>
|
|
MiniBraille
|
|
<DT id="135"><B>mp</B>
|
|
|
|
<DD>
|
|
Mikropuhe
|
|
<DT id="136"><B>mt</B>
|
|
|
|
<DD>
|
|
Metec
|
|
<DT id="137"><B>no</B>
|
|
|
|
<DD>
|
|
no driver
|
|
<DT id="138"><B>np</B>
|
|
|
|
<DD>
|
|
NinePoint
|
|
<DT id="139"><B>pg</B>
|
|
|
|
<DD>
|
|
Pegasus
|
|
<DT id="140"><B>pm</B>
|
|
|
|
<DD>
|
|
Papenmeier
|
|
<DT id="141"><B>sd</B>
|
|
|
|
<DD>
|
|
SpeechDispatcher
|
|
<DT id="142"><B>sk</B>
|
|
|
|
<DD>
|
|
Seika
|
|
<DT id="143"><B>sw</B>
|
|
|
|
<DD>
|
|
Swift
|
|
<DT id="144"><B>th</B>
|
|
|
|
<DD>
|
|
Theta
|
|
<DT id="145"><B>tn</B>
|
|
|
|
<DD>
|
|
TechniBraille Systems Inc.
|
|
<DT id="146"><B>ts</B>
|
|
|
|
<DD>
|
|
Telesensory Systems Inc.
|
|
<DT id="147"><B>tt</B>
|
|
|
|
<DD>
|
|
TTY
|
|
<DT id="148"><B>vd</B>
|
|
|
|
<DD>
|
|
VideoBraille
|
|
<DT id="149"><B>vo</B>
|
|
|
|
<DD>
|
|
Voyager, Part232 (serial adapter), BraillePen/EasyLink
|
|
<DT id="150"><B>vr</B>
|
|
|
|
<DD>
|
|
Virtual
|
|
<DT id="151"><B>vs</B>
|
|
|
|
<DD>
|
|
VisioBraille
|
|
<DT id="152"><B>vv</B>
|
|
|
|
<DD>
|
|
ViaVoice
|
|
<DT id="153"><B>xs</B>
|
|
|
|
<DD>
|
|
ExternalSpeech
|
|
<DT id="154"><B>xw</B>
|
|
|
|
<DD>
|
|
XWindow
|
|
</DL>
|
|
<P>
|
|
|
|
A comma-delimited list of drivers may be specified.
|
|
If this is done then autodetection is performed using each listed driver in sequence.
|
|
You may need to experiment in order to determine the most reliable order
|
|
since some drivers autodetect better than others.
|
|
<P>
|
|
|
|
If the single word
|
|
<B>auto</B>
|
|
|
|
is specified then autodetection is performed
|
|
using only those drivers which are known to be reliable for this purpose.
|
|
</DL>
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
For full documentation, see
|
|
<B>brltty</B>'s
|
|
|
|
on-line manual at
|
|
[<B><A HREF="http://brltty.app/documentation.html">http://brltty.app/documentation.html</A></B>].
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="155"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="156"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="157"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="158"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DL>
|
|
<DT id="159"><A HREF="#lbAF">Command Line Options</A><DD>
|
|
<DT id="160"><A HREF="#lbAG">Environment Variables</A><DD>
|
|
<DT id="161"><A HREF="#lbAH">The Configuration File</A><DD>
|
|
<DT id="162"><A HREF="#lbAI">Driver Specification</A><DD>
|
|
</DL>
|
|
<DT id="163"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:08 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|