  BRLTTY
  Access to the Linux/Unix Console for Blind Persons using
  Refreshable Braille Displays
  Nikhil Nair <nn201@cus.cam.ac.uk>

  Nicolas Pitre <nico@cam.org>

  Stéphane Doyon <s.doyon@videotron.ca>

  Dave Mielke <dave@mielke.cc>

  Version 3.6, October 2004

  Copyright © 1995-2004 by The BRLTTY Team - All Rights Reserved.
  BRLTTY is free software, and comes with ABSOLUTELY NO WARRANTY.  It is
  placed under the terms of version 2 or later of [1mThe GNU General Public[0m
  [1mLicense [22mas published by [1mThe Free Software Foundation[22m.

  ______________________________________________________________________

  Table of Contents



  1. Formalities
     1.1 License
     1.2 Disclaimer
     1.3 Contact Information

  2. Introduction
     2.1 Feature Summary
     2.2 System Requirements

  3. The Build Procedure
     3.1 Installed File Hierarchy
     3.2 Installing from a TAR Ball
        3.2.1 Build Options
           3.2.1.1 System Defaults
           3.2.1.2 Directory Specification
           3.2.1.3 Build Features
           3.2.1.4 Miscellaneous Options
        3.2.2 Make File Targets
     3.3 Testing BRLTTY
     3.4 Starting BRLTTY
     3.5 Security Considerations
     3.6 Build and Run-Time Restrictions
     3.7 Installing from an RPM File
     3.8 Other Utilities
        3.8.1 brltty-config
        3.8.2 brltty-install
        3.8.3 brltest
        3.8.4 spktest
        3.8.5 scrtest
        3.8.6 tbltest
        3.8.7 ctbtest
        3.8.8 tunetest

  4. Using BRLTTY
     4.1 Commands
        4.1.1 Vertical Motion
        4.1.2 Horizontal Motion
        4.1.3 Implicit Motion
        4.1.4 Feature Activation
        4.1.5 Mode Selection
        4.1.6 Preference Maintenance
        4.1.7 Menu Navigation
        4.1.8 Speech Controls
        4.1.9 Virtual Terminal Switching
        4.1.10 Other Commands
        4.1.11 Routing Keys
     4.2 The Configuration File
     4.3 Command Line Options

  5. Feature Descriptions
     5.1 Cursor Routing
     5.2 Cut and Paste
     5.3 Pointer (Mouse) Support via GPM
     5.4 Alert Tunes
     5.5 Preferences Settings
        5.5.1 The Preferences Menu
           5.5.1.1 Navigating the Menu
           5.5.1.2 The Menu Items
     5.6 The Status Display
        5.6.1 Displays with 21 Cells or More
        5.6.2 Displays with 20 Cells or Less
     5.7 Command Learn Mode

  6. Translation Tables
     6.1 Text Translation
     6.2 Attributes Translation
     6.3 Table Format

  7. Contracted Braille
     7.1 File Format
     7.2 Opcodes
        7.2.1 Table Administration
        7.2.2 Special Symbol Definition
        7.2.3 Character Translation
        7.2.4 Character Classes

  8. Advanced Topics
     8.1 Installing Multiple Versions
     8.2 Installation/Rescue Root Disks for Linux
     8.3 Future Enhancements
     8.4 Known Bugs

  A. Supported Braille Displays
  B. Supported Speech Synthesizers
  C. Driver Identification Codes
  D. Operand Syntax
     D.1 Driver Specificationn
     D.2 Braille Device Specificationn
     D.3 PCM Device Specificationn
     D.4 MIDI Device Specificationn

  E. Standard Braille Dot Numbering Convention
  F. North American Braille Computer Code
  G. MIDI Instrument Table


  ______________________________________________________________________

  [1m1.  Formalities[0m



  [1m1.1.  License[0m

  This program is free software.  You may redistribute it and/or modify
  it under the terms of The GNU General Public License as published by
  The Free Software Foundation.  Version 2 (or any later version) of the
  license may be used.

  You should have received a copy of the license along with this
  program.  It should be in the file COPYING in the top-level directory.
  If not, write to the Free Software Foundation Inc., 675 Mass Ave,
  Cambridge, MA 02139, USA.


  [1m1.2.  Disclaimer[0m

  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY - not even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the [1mGNU[0m
  [1mGeneral Public License [22mfor more details.


  [1m1.3.  Contact Information[0m

  BRLTTY represents the work of a team.  For up-to-date information, see
  BRLTTY's web page at [http://mielke.cc/brltty/].  As of this writing,
  the team includes:

  ·  Dave Mielke <dave@mielke.cc> (current maintainer, active developer)


  ·  Nicolas Pitre <nico@cam.org> (active developer)

  ·  Stéphane Doyon <s.doyon@videotron.ca> (active developer)

  ·  Nikhil Nair <nn201@cus.cam.ac.uk> (original author, no longer
     active)

  Comments, suggestions, criticisms, and contributions are all welcome.
  We'll try to respond promptly to all (sensible) mail, but give no
  guarantee.  In general, we recommend that you send e-mail messages to
  all active developers.  If you have a question about a particular type
  of display supported by BRLTTY, you may wish to contact the author of
  its driver (see the README file in its subdirectory for details).


  [1m2.  Introduction[0m

  BRLTTY gives a braille user access to the text consoles of a
  Linux/Unix system.  It runs as a background process (daemon) which
  operates a refreshable braille display, and can be started very early
  in the system boot sequence.  It enables a braille user, therefore, to
  easily independently handle aspects of system administration such as
  single user mode entry, file system recovery, and boot problem
  analysis.  It even greatly eases such routine tasks as logging in.

  BRLTTY reproduces a rectangular portion of the screen (referred to
  within this document as `the window') as braille text on the display.
  Controls on the display can be used to move the window around on the
  screen, to enable and disable various viewing options, and to perform
  special functions.


  [1m2.1.  Feature Summary[0m

  BRLTTY provides the following capabilities:

  ·  Full implementation of the usual screen review facilities.

  ·  Choice between block, underline, or no cursor.

  ·  Optional underline to indicate specially highlighted text.

  ·  Optional use of blinking (rates individually settable) for cursor,
     special highlighting underline, and/or capital letters.

  ·  Screen freezing for leisurely review.

  ·  Intelligent cursor routing, allowing easy fetching of cursor within
     text editors, web browsers, etc., without moving ones hands from
     the braille display.

  ·  A cut-and-paste function (linear or rectangular) which is
     particularly useful for copying long file names, copying text
     between virtual terminals, entering complicated commands, etc.

  ·  Table driven in-line contracted braille (english grade 2 provided).

  ·  Support for multiple braille codes.

  ·  Ability to identify an unknown character.

  ·  Ability to inspect character highlighting.

  ·  An on-line help facility for braille display commands.


  ·  A preferences menu.

  ·  Basic speech support.

  ·  Modular design allowing relatively easy addition of drivers for
     other braille displays and speech synthesizers.

  ·  An Application Programming Interface.


  [1m2.2.  System Requirements[0m

  To date, BRLTTY runs under Linux, Solaris, OpenBSD, FreeBSD, and
  NetBSD.  While ports to other Unix-like operating systems aren't
  currently planned, we do welcome any interest in such projects.


     [1mLinux[0m
        This software has been tested on a variety of Linux systems:

        ·  Desktops, laptops, and some PDAs.

        ·  Processors from a 386SX20 to a Pentium.

        ·  A huge range of memory sizes.

        ·  Several distributions including Debian, Red Hat, Slackware,
           and SuSE.

        ·  Many kernels, including 1.2.13, 2.0, 2.2, and 2.4.

     [1mSolaris[0m
        This software has been tested on the following Solaris systems:

        ·  The Sparc architecture (releases 7, 8, and 9).

        ·  The Intel architecture (release 9).

     [1mOpenBSD[0m
        This software has been tested on the following OpenBSD systems:

        ·  The Intel architecture (release 3.4).

     [1mFreeBSD[0m
        This software has been tested on the following FreeBSD systems:

        ·  The Intel architecture (release 5.1).

     [1mNetBSD[0m
        This software has been tested on the following NetBSD systems:

        ·  The Intel architecture (release 1.6).

  On Linux, BRLTTY can inspect the content of the screen completely
  independently of any logged in user.  It does this by using a special
  device which provides easy access to the contents of the current
  virtual console.  This device was introduced in version 1.1.92 of the
  Linux kernel, and is normally called either /dev/vcsa or /dev/vcsa0
  (on systems with devfs it's called /dev/vcc/a).  For this reason,
  Linux kernel 1.1.92 or later is required if BRLTTY is to be used in
  this way.  This capability:

  ·  Allows BRLTTY to be started very early in the system boot sequence.

  ·  Enables the braille display to be fully operational during the
     login prompt.
  ·  Makes it much easier for a braille user to perform boot-time system
     administration tasks.

  A patch for the screen program is provide (see the Patches
  subdirectory).  It allows BRLTTY to access screen's screen image via
  shared memory, and, therefore, allows BRLTTY to be used quite
  effectively on platforms which don't have their own screen content
  inspection facility.  The main weakness of the screen approach is that
  BRLTTY can't be started until the user has logged in.

  In order for BRLTTY to successfully communicate with the refreshable
  braille display, the correct driver (serial, parallel, USB, bluetooth)
  must be configured into the kernel.  If the driver requires special
  options, then they must be supplied.  If it's built into the kernel,
  then its options must be:

     [1mLinux[0m

        ·  Set during the kernel configuration procedure.

        ·  Supplied at the LILO boot prompt.

        ·  Specified on an append directive in /etc/lilo.conf.

  If the driver is a module, then its options must be:

     [1mLinux[0m

        ·  Supplied as options to the modprobe (or insmod) command.

        ·  Specified on an options directive in /etc/modules.conf
           (called /etc/conf.modules by some older distributions).

  BRLTTY only works with text-based consoles and applications.  It can
  be used with curses-based applications, but not with any application
  which either uses special VGA features or requires a graphics console
  (like the X Window system).

  You must also, of course, possess a supported refreshable braille
  display (see section ``Supported Braille Displays'' for the complete
  list).  We hope that additional displays will be supported in the
  future, so, if you have any vaguely technical programming information
  for a device which you'd like to see supported, then please let us
  know (see section ``Contact Information'').

  Finally, you need tools to build the executable from its source: make,
  C and C++ compilers, yacc, awk, etc.  The development tools provided
  with standard Unix distributions should suffice.  If you have
  problems, then contact us and we'll compile a binary for you.


  [1m3.  The Build Procedure[0m

  BRLTTY can be downloaded from its web site (see section ``Contact
  Information'' for its location).  All releases are provided as
  compressed ``tar balls''.  Newer releases are also provided as ``RPM''
  (RedHat Package Manager) files.

  That tidbit of information has probably peaked your curiosity, and now
  you just can't wait to get started.  It's a good idea, though, to
  first become familiar with the files which will ultimately be
  installed.



  [1m3.1.  Installed File Hierarchy[0m

  The build procedure should result in the installation of the following
  files:

     [1m/bin/[0m

        [1mbrltty[0m
           The BRLTTY program.

        [1m``brltty-install''[0m
           A utility for copying BRLTTY's ``installed file hierarchy''
           from one location to another.

        [1m``brltty-config''[0m
           A utility which sets a number of environment variables to
           values which reflect the current installation of BRLTTY.

     [1m/etc/[0m

        [1mbrltty.conf[0m
           System defaults for BRLTTY.

        [1mbrlapi.key[0m
           The access key for BrlAPI.

     [1m/etc/brltty/[0m
        Your installation of BRLTTY may not have all of the following
        types of files.  They're only created as needed based on the
        build options you select (see ``Build Options'').

        [1m*.conf[0m
           Driver-specific configuration data.  Their names look more or
           less like brltty-[4mdriver[24m.conf, where [4mdriver[24m is the two-letter
           ``driver identification code''.

        [1m*.ctb[0m
           Contraction tables (see section ``Contracted Braille'' for
           details).  Their names look like [4mlanguage[24m-[4mcountry[24m-[4mlevel[24m.ctb.

        [1m*.cti[0m
           Include files for contraction tables.

        [1m*.hlp[0m
           Driver-specific help pages.  Their names look more or less
           like brltty-[4mdriver[24m.hlp, where [4mdriver[24m is the two-letter
           ``driver identification code''.

        [1m*.tbl[0m
           Translation tables (see section ``Translation Tables'' for
           details).  Their names look like text.[4mlanguage[24m.tbl.  There
           are also a couple of special tables which map character
           highlighting attributes to braille dots: attrib.tbl does it
           the original way, and attributes.tbl does it the current way.

     [1m/lib/[0m

        [1mlibbrlapi.a[0m
           Static archive of the Application Programming Interface.

        [1mlibbrlapi.so[0m
           Dynamically loadable object for the Application Programming
           Interface.

     [1m/lib/brltty/[0m
        Your installation of BRLTTY may not have all of the following
        types of files.  They're only created as needed based on the
        build options you select (see ``Build Options'').

        [1mbrltty-brl.lst[0m
           A list of the braille display drivers which have been built
           as dynamically loadable shared objects, and, therefore, which
           can be selected at run-time.  Each line consists of the two-
           letter identification code for a driver, a tab character, and
           a description of the braille display which that driver is
           for.

        [1mlibbrlttyb[4m[22mdriver[24m[1m.so.1[0m
           The dynamically loadable driver for a braille display, where
           [4mdriver[24m is the two-letter ``driver identification code''.

        [1mbrltty-spk.lst[0m
           A list of the speech synthesizer drivers which have been
           built as dynamically loadable shared objects, and, therefore,
           which can be selected at run-time.  Each line consists of the
           two-letter identification code for a driver, a tab character,
           and a description of the speech synthesizer which that driver
           is for.

        [1mlibbrlttys[4m[22mdriver[24m[1m.so.1[0m
           The dynamically loadable driver for a speech synthesizer,
           where [4mdriver[24m is the two-letter ``driver identification
           code''.

     [1m/include/brltty/[0m
        C header files for the Application Programming Interface.  Their
        naems look like [4mfunction[24m.h or [4mfunction[24m-[4mdriver[24m.h (where [4mdriver[24m is
        the two-letter ``driver identification code'').

     [1m/man/[0m
        Man pages.

        [1mman1/[4m[22mname[24m[1m.1[0m
           Man pages for BRLTTY-related user commands.

        [1mman3/[4m[22mname[24m[1m.3[0m
           Man pages for Application Programming Interface library
           routines.

  Some optional files which you should be aware of, although they aren't
  part of the installed file hierarchy, are:

     [1m/etc/brltty.conf[0m
        The system defaults configuration file.  It's created by the
        system administrator.  See ``The Configuration File'' for
        details.

     [1m/etc/brltty-[4m[22mdriver[24m[1m.prefs[0m
        The saved preferences settings file ([4mdriver[24m is a two-letter
        ``driver identification code'').  It's created by the
        ``PREFSAVE'' command.  See ``Preferences Settings'' for details.


  [1m3.2.  Installing from a TAR Ball[0m

  Here's what to do if you just want to install BRLTTY as quickly as
  possible, trusting that all of our defaults are correct.

  1. Download the source.  It'll be a file named brltty-[4mrelease[24m.tar.gz,
     e.g. brltty-3.0.tar.gz.


  2. Unpack the source into its native hierarchical structure.

       tar xzf brltty-[4mrelease[24m.tar.gz


  This should create the directory brltty-[4mrelease[24m.

  3. Change to the source directory, configure, compile, and install
     BRLTTY.

       cd brltty-[4mrelease[0m
       ./configure
       make install


  This should be done as [1mroot[22m.

  To uninstall BRLTTY, do:

       cd brltty-[4mrelease[0m
       make uninstall


  That's all there's to it.  Now, for those who really want to know
  what's going on, here are the details.


  [1m3.2.1.  Build Options[0m

  The first step in building BRLTTY is to configure it for your system
  and/or for your personal needs.  This is done by running the configure
  script in BRLTTY's top-level directory.  We've tried to make the
  defaults fit the most common case, so, assuming that you're not
  attempting to do anything out of the ordinary, you may not need to do
  anything more complicated than invoke this script without specifying
  any options at all.

       ./configure


  If, however, you have some special requirements, or even if you're
  just adventurous, you should find out what your choices are.

       ./configure --help


  You should also check out the README file in the subdirectory contain-
  ing the driver for your braille display for any additional display-
  specific instructions.


  [1m3.2.1.1.  System Defaults[0m


     --with-braille-driver=[4mdriver[0m
        Specify the braille display drivers which are to be linked into
        the BRLTTY binary.  Those drivers which aren't listed via this
        option are built as dynamically loadable shared objects and can
        still be selected at run-time.  Each driver must be identified
        either by its two-letter ``driver identification code'' or by
        its proper name (full or abbreviated).  The driver identifiers
        and/or names must be separated from one another by a single
        comma.  If a driver identifier is prefixed by a minus sign (-),
        then that driver is excluded from the build.  The first non-
        excluded driver becomes the default driver.  There's no default
        driver if this option isn't used.  Any of the following words
        can also be used as the operand of this option:

        [1mall[0m
           Link all of the drivers into the binary.  Don't build any of
           them as dynamically loadable shared objects.  This word may
           also be specified as the final element of a driver list.
           This is how to specify the dfault driver when all the drivers
           are to be linked in.

        [1m-all[0m
           Only build those drivers which have been explicitly included
           via this option.

        [1mno [22mDon't build any drivers at all.  This is equivalent to
           specifying --without-braille-driver.

        [1myes[0m
           Build all of the drivers as dynamically loadable shared
           objects.  Don't link any of them into the binary.  This is
           equivalent to specifying --with-braille-driver.

        See the ``braille-driver'' configuration file directive and the
        ``-b'' command line option for run-time selection.

     --with-braille-parameters=[[4mdriver[24m:][4mname[24m=[4mvalue[24m,...
        Specify the default parameter settings for the braille display
        drivers.  If the same parameter is specified more than once,
        then its rightmost assignment is used.  If a parameter name is
        qualified by a driver (see section ``Driver Identification
        Codes'') then that setting only applies to that driver; if it
        isn't then it applies to all drivers.  For a description of the
        parameters accepted by a specific driver, please see the
        documentation for that driver.  See the ``braille-parameters''
        configuration file directive and the ``-B'' command line option
        for run-time selection.

     --with-braille-device=[4mdevice[24m,...
        Specify the default device to which the braille display is
        connected (see section ``Braille Device Specification'').  If
        this option isn't specified, then an operating system
        appropriate path for the primary serial port is assumed.  See
        the ``braille-device'' configuration file directive and the
        ``-d'' command line option for run-time selection.

     --with-text-table=[4mfile[0m
        Specify the default text translation table (see section ``Text
        Translation'' for details).  The absolute path to a table
        outside the source tree may be specified.  The .tbl extension is
        optional.  For a simple file name, the text. prefix is optional.
        If this option isn't specified, then nabcc, a commonly (in North
        America) used 8-dot variant of the ``North American Braille
        Computer Code'', is assumed.  See the ``text-table''
        configuration file directive and the ``-t'' command line option
        for run-time selection.  This setting can be changed with the
        ``Text Table'' preference.

     --with-attributes-table=[4mfile[0m
        Specify the default attributes translation table (see section
        ``Attributes Translation'' for details).  The absolute path to a
        table outside the source tree may be specified.  The .tbl
        extension is optional.  If this option isn't specified, then
        attributes is assumed.  Change it to attrib if you'd like it
        done the old way.  See the ``attributes-table'' configuration
        file directive and the ``-a'' command line option for run-time
        selection.  This setting can be changed with the ``Attributes
        Table'' preference.
     --with-speech-driver=[4mdriver[0m
        Specify the speech synthesizer drivers which are to be linked
        into the BRLTTY binary.  Those drivers which aren't listed via
        this option are built as dynamically loadable shared objects and
        can still be selected at run-time.  Each driver must be
        identified either by its two-letter ``driver identification
        code'' or by its proper name (full or abbreviated).  The driver
        identifiers and/or names must be separated from one another by a
        single comma.  If a driver identifier is prefixed by a minus
        sign (-), then that driver is excluded from the build.  The
        first non-excluded driver becomes the default driver.  There's
        no default driver if this option isn't used.  Any of the
        following words can also be used as the operand of this option:

        [1mall[0m
           Link all of the drivers into the binary.  Don't build any of
           them as dynamically loadable shared objects.  This word may
           also be specified as the final element of a driver list.
           This is how to specify the dfault driver when all the drivers
           are to be linked in.

        [1m-all[0m
           Only build those drivers which have been explicitly included
           via this option.

        [1mno [22mDon't build any drivers at all.  This is equivalent to
           specifying --without-speech-driver.

        [1myes[0m
           Build all of the drivers as dynamically loadable shared
           objects.  Don't link any of them into the binary.  This is
           equivalent to specifying --with-speech-driver.

        See the ``speech-driver'' configuration file directive and the
        ``-s'' command line option for run-time selection.

     --with-speech-parameters=[[4mdriver[24m:][4mname[24m=[4mvalue[24m,...
        Specify the default parameter settings for the speech
        synthesizer drivers.  If the same parameter is specified more
        than once, then its rightmost assignment is used.  If a
        parameter name is qualified by a driver (see section ``Driver
        Identification Codes'') then that setting only applies to that
        driver; if it isn't then it applies to all drivers.  For a
        description of the parameters accepted by a specific driver,
        please see the documentation for that driver.  See the ``speech-
        parameters'' configuration file directive and the ``-S'' command
        line option for run-time selection.

     --with-flite=[4mdirectory[0m
        Specify the installed location of the FestivalLite text-to-
        speech package, and build the FestivalLite speech synthesizer
        driver (see ``Build Restrictions'').  Any of the following words
        can also be used as the operand of this option:

        [1mno [22mDon't build the driver.  This is equivalent to specifying
           --without-flite.

        [1myes[0m
           Build the driver if the package can be found in /usr,
           /usr/local, or /opt/flite.  This is equivalent to specifying
           --with-flite.

     --with-flite-language=[4mlanguage[0m
        Specify the language which the FestivalLite text to speech
        engine is to use.  The default language is usenglish.

     --with-flite-lexicon=[4mlexicon[0m
        Specify the lexicon which the FestivalLite text to speech engine
        is to use.  The default lexicon is cmulex.

     --with-flite-voice=[4mvoice[0m
        Specify the voice which the FestivalLite text to speech engine
        is to use.  The default voice is cmu_us_kal16.

     --with-mikropuhe=[4mdirectory[0m
        Specify the installed location of the Mikropuhe text-to-speech
        package, and build the Mikropuhe speech synthesizer driver (see
        ``Build Restrictions'').  Any of the following words can also be
        used as the operand of this option:

        [1mno [22mDon't build the driver.  This is equivalent to specifying
           --without-mikropuhe.

        [1myes[0m
           Build the driver if the package can be found in /usr,
           /usr/local, or /opt/mikropuhe.  This is equivalent to
           specifying --with-mikropuhe.

     --with-theta=[4mdirectory[0m
        Specify the installed location of the Theta text-to-speech
        package, and build the Theta speech synthesizer driver (see
        ``Build Restrictions'').  Any of the following words can also be
        used as the operand of this option:

        [1mno [22mDon't build the driver.  This is equivalent to specifying
           --without-theta.

        [1myes[0m
           Build the driver if the package can be found in /usr,
           /usr/local, or /opt/theta.  This is equivalent to specifying
           --with-theta.

     --with-viavoice=[4mdirectory[0m
        Specify the installed location of the ViaVoice text-to-speech
        package, and build the ViaVoice speech synthesizer driver (see
        ``Build Restrictions'').  Any of the following words can also be
        used as the operand of this option:

        [1mno [22mDon't build the driver.  This is equivalent to specifying
           --without-viavoice.

        [1myes[0m
           Build the driver if the package can be found in /usr,
           /usr/local, or /opt/viavoice.  This is equivalent to
           specifying --with-viavoice.

     --with-screen-driver=[4mdriver[0m
        Specify the screen driver.  It may be one of the following:

        [1mlinux[0m
           This driver provides direct access to the Linux console
           screen.  It's only selectable, and is the default, on Linux
           systems.

        [1mshm[0m
           This driver provides access to the screen program.  It's
           selectable on all systems, and is the default on most.  The
           patch for screen which we provide (see the Patches
           subdirectory) must be applied.  Use of this driver, due to
           the fact that screen must be concurrently running, makes
           BRLTTY effectively useful only after the user has logged in.

        If this option isn't specified, then an operating system appro-
        priate selection is made.  If a specific driver for the current
        operating system is available, then it's used.  If not, then shm
        is used.

     --with-screen-parameters=[4mname[24m=[4mvalue[24m,...
        Specify the default parameter settings for the screen driver.
        If the same parameter is specified more than once, then its
        rightmost assignment is used.  For a description of the
        parameters accepted by a specific driver, please see the
        documentation for that driver.  See the ``screen-parameters''
        configuration file directive and the ``-X'' command line option
        for run-time selection.


  [1m3.2.1.2.  Directory Specification[0m


     --with-execute-root=[4mdirectory[0m
        Specify the directory at which the ``installed file hierarchy''
        is to be rooted at run-time.  The absolute path should be
        supplied.  If this option isn't specified, then the system's
        root directory is assumed.  Use this option if you need to
        install BRLTTY's run-time files in a non-standard location.  You
        need to use this feature, for example, if you'd like to have
        more than one version of BRLTTY installed at the same time (see
        section ``Installing Multiple Versions'' for an example of how
        to do this).

     --with-install-root=[4mdirectory[0m
        Specify the directory beneath which the ``installed file
        hierarchy'' is to be installed.  The absolute path should be
        supplied.  If this option isn't specified, then the run-time
        package root (see the ``--with-execute-root'' build option) is
        assumed.  This directory is only used by ``make install'' and
        ``make uninstall''.  Use this option if you need to install
        BRLTTY in a different location than the one from which it'll
        ultimately be executed.  You need to use this feature, for
        example, if you're building BRLTTY on one system for use on
        another.

     --prefix=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the default directories for the architecture-independent
        files are to be rooted.  These directories include:

        ·  the ``data directory''

        ·  the ``configuration directory''

        ·  the ``manpage directory''

        ·  the ``include directory''

        The absolute path should be supplied.  If this option isn't
        specified, then the system's root directory is assumed.  This
        directory is rooted at the directory specified by the ``--with-
        execute-root'' build option.

     --exec-prefix=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the default directories for the architecture-dependent
        files are to be rooted.  These directories include:

        ·  the ``program directory''

        ·  the ``library directory''

        ·  the ``API directory''

        The absolute path should be supplied.  If this option isn't
        specified, then the directory specified via the ``--prefix''
        build option is assumed.  This directory is rooted at the direc-
        tory specified by the ``--with-execute-root'' build option.

     --libdir=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the static archive and the dynamically loadable object for
        the Application Programming Interface are to be installed.  The
        absolute path should be supplied.  If this option isn't
        specified, then the directory specified via the standard
        configure option --libdir (which defaults to /lib rooted at the
        directory specified by the ``--exec-prefix'' build option) is
        assumed.  The directory is created if it doesn't exist.

     --sysconfdir=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the configuration files are to be installed.  The absolute
        path should be supplied.  If this option isn't specified, then
        the directory specified via the standard configure option
        --sysconfdir (which defaults to /etc rooted at the directory
        specified by the ``--prefix'' build option) is assumed.  The
        directory is created if it doesn't exist.

     --with-program-directory=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the runnable programs (binaries, executables) are to be
        installed.  The absolute path should be supplied.  If this
        option isn't specified, then the directory specified via the
        standard configure option --bindir (which defaults to /bin
        rooted at the directory specified by the ``--exec-prefix'' build
        option) is assumed.  The directory is created if it doesn't
        exist.

     --with-library-directory=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the drivers and other architecture-dependent files are to
        be installed.  The absolute path should be supplied.  If this
        option isn't specified, then the brltty subdirectory of the
        directory specified via the standard configure option --libdir
        (which defaults to /lib rooted at the directory specified by the
        ``--exec-prefix'' build option) is assumed.  The directory is
        created if it doesn't exist.

     --with-data-directory=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the tables, help pages, and other architecture-independent
        files are to be installed.  The absolute path should be
        supplied.  If this option isn't specified, then the brltty
        subdirectory of the directory specified via the standard
        configure option --sysconfdir (which defaults to /etc rooted at
        the directory specified by the ``--prefix'' build option) is
        assumed.  The directory is created if it doesn't exist.

     --with-manpage-directory=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the man pages are to be installed.  The absolute path
        should be supplied.  If this option isn't specified, then the
        directory specified via the standard configure option --mandir
        (which defaults to /man rooted at the directory specified by the
        ``--prefix'' build option) is assumed.  The directory is created
        if it doesn't exist.
     --with-include-directory=[4mdirectory[0m
        Specify the directory within the ``installed file hierarchy''
        where the C header files for the Application Programming
        Interface are to be installed.  The absolute path should be
        supplied.  If this option isn't specified, then the brltty
        subdirectory of the directory specified via the standard
        configure option --includedir (which defaults to /include rooted
        at the directory specified by the ``--prefix'' build option) is
        assumed.  The directory is created if it doesn't exist.


  [1m3.2.1.3.  Build Features[0m

  These options are primarily useful when building BRLTTY for use on a
  boot disk.

     --enable-standalone-programs
        Create statically linked, rather than dynamically linked,
        programs.  This option removes all dependencies on shared
        objects at run-time.  Only the default drivers (see the
        ``--with-braille-driver'' and the ``--with-speech-driver'' build
        options) are compiled.

     --disable-preferences-menu
        Reduce program size by excluding the preferences menu (see
        section ``The Preferences Menu'').

     --disable-table-selection
        Reduce program size by excluding the table selection entries
        from the preferences menu (see the ``Text Table'', ``Attributes
        Table'', and ``Contraction Table'' preferences).

     --disable-learn-mode
        Reduce program size by excluding command learn mode (see section
        ``Command Learn Mode'').

     --disable-contracted-braille
        Reduce program size by excluding support for contracted braille
        (see section ``Contracted Braille'').

     --disable-usb-support
        Reduce program size by excluding support for USB devices.

     --disable-bluetooth-support
        Reduce program size by excluding support for bluetooth devices.

     --disable-speech-support
        Reduce program size by excluding support for speech
        synthesizers.

     --disable-beeper-support
        Reduce program size by excluding support for the console tone
        generator.

     --disable-pcm-support
        Reduce program size by excluding support for the digital audio
        interface on the sound card.

     --enable-pcm-support=[4minterface[0m
        If a platform provides more than one digital audio interface
        then the one which is to be used may be specified.

     --disable-midi-support
        Reduce program size by excluding support for the Musical
        Instrument Digital Interface of the sound card.


         Platform   Interface   Description
         _______________________________________________________________
         Linux      oss         Open Sound System
                    alsa        Advanced Linux Sound Architecture

     --enable-midi-support=[4minterface[0m
        If a platform provides more than one Musical Instrument Digital
        Interface then the one which is to be used may be specified.

         Platform   Interface   Description
         _______________________________________________________________
         Linux      oss         Open Sound System
                    alsa        Advanced Linux Sound Architecture


     --disable-fm-support
        Reduce program size by excluding support for the FM synthesizer
        on an AdLib, OPL3, Sound Blaster, or equivalent sound card.

     --disable-pm-configfile
        Reduce program size by excluding support for the Papenmeier
        driver's configuration file.

     --enable-gpm
        Include an interface to the gpm application so that, on systems
        which support it, BRLTTY will interact with the pointer (mouse)
        device (see section ``Pointer (Mouse) Support via GPM'').

     --enable-api
        Include the Application Programming Interface.

     --with-api-parameters=[4mname[24m=[4mvalue[24m,...
        Specify the default parameter settings for the Application
        Programming Interface.  If the same parameter is specified more
        than once, then its rightmost assignment is used.  For a
        description of the parameters accepted by the interface, please
        see the [1mBrlAPI [22mreference manual.  See the ``api-parameters''
        configuration file directive and the ``-A'' command line option
        for run-time selection.


  [1m3.2.1.4.  Miscellaneous Options[0m


     --with-compiler-prefix=[4mprefix[0m
        Specify the prefix (path and beginning of program name) for the
        suite of compile and link tools which are to be used.  You may
        need to use this option if, for example, you're cross-compiling
        for a different architecture.

     --with-init-path=[4mpath[0m
        Specify the path to the real init program for the system.  The
        absolute path should be supplied.  If this option is specified,
        then:

        1. The init program should be moved to a new location.

        2. brltty should be moved to the init program's original
           location.

        3. When the system runs init at startup, brltty is actually run.
           It puts itself into the background, and runs the real init in
           the foreground.  This is one (somewhat sneaky) way to have
           braille right at the outset.  It's especially useful for some
           install/rescue disks.
        If this option isn't specified, then this feature isn't acti-
        vated.


  [1m3.2.2.  Make File Targets[0m

  Once BRLTTY has been configured, the next steps are to compile and to
  install it.  These are done by applying the system's make command to
  BRLTTY's main make file (Makefile in the top-level directory).
  BRLTTY's make file supports most of the common application maintenance
  targets.  They include:

     [1mmake[0m
        A shortcut for make all.

     [1mmake all[0m
        Compile and link the BRLTTY executable, its drivers and their
        help pages, its test programs, and a few other small utilities.

     [1mmake install[0m
        Complete the compile and link phase (see ``make all''), and then
        install the BRLTTY executable, its data files, drivers, and help
        pages, in the correct places and with the correct permissions.

     [1mmake uninstall[0m
        Remove the BRLTTY executable, its data files, drivers, and help
        pages, from the system.

     [1mmake clean[0m
        Ensure that the next compile and link (see ``make all'') will be
        done from scratch by removing the results of compiling, linking,
        and testing from the source directory structure.  This includes
        the removal of object files, executables, dynamically loadable
        shared objects, driver lists, help pages, temporary header
        files, and core files.

     [1mmake distclean[0m
        In addition to removing the results of compiling and linking
        (see ``make clean''):

        ·  Remove the results of BRLTTY configuration (see ``Build
           Options'').  This includes the removal of config.mk,
           config.h, config.cache, config.status, and config.log.

        ·  Remove other files from the source directory structure which
           tend to accumulate over time but which don't belong there.
           This includes the removal of editor backup files, test case
           results, rejected patch hunks, and copies of original source
           files.


  [1m3.3.  Testing BRLTTY[0m

  After compiling, linking, and installing BRLTTY, it's a good idea to
  give it a quick test before activating it permanently.  To do so,
  invoke it with the command:

       brltty -b[4mdriver[24m -d[4mdevice[0m


  For [4mdriver[24m, specify the two-letter ``driver identification code'' cor-
  responding to your braille display.  For [4mdevice[24m, specify the full path
  for the device to which your braille display is connected.

  If you don't want to explicitly identify the driver and device each
  time you start BRLTTY, then you can take two approaches.  You can
  establish system defaults via the ``braille-driver'' and the
  ``braille-device'' configuration file directives, and/or compile your
  needs right into BRLTTY via the ``--with-braille-driver'' and the
  ``--with-braille-device'' build options.

  If all is well, BRLTTY's version identification message should appear
  on the braille display for a few seconds (see the ``-M'' command line
  option).  After it goes away (which you can hasten by pressing any key
  on the display), the area of the screen where the cursor is should
  appear.  This means that you should expect to see your shell's command
  prompt.  Then, as you enter your next command, each character should
  appear on the display as it's typed on the keyboard.

  If this is your experience, then leave BRLTTY running, and enjoy it.
  If this isn't your experience, then it may be necessary to test each
  driver separately in order to isolate the source of the probledm.  The
  screen driver can be tested with ``scrtest'', and the braille display
  driver can be tested with ``brltest''.

  If you experience a problem which requires a lot of digging, then you
  may wish to use the following brltty command line options:

  ·  ``-ldebug'' to log lots of diagnostic messages.

  ·  ``-n'' to keep BRLTTY in the foreground.

  ·  ``-e'' to direct diagnostic messages to standard error rather than
     to the system log.


  [1m3.4.  Starting BRLTTY[0m

  BRLTTY, when properly installed, is invoked with the single command
  brltty.  A configuration file (see section ``The Configuration File''
  for details) can be created in order to establish system defaults for
  such things as the location of the preferences file, the braille
  display driver to be used, the device to which the braille display is
  connected, and the text translation table to be used.  Many options
  (see section ``Command Line Options'' for details) allow explicit run-
  time specification of such things as the location of the configuration
  file, any defaults established within the configuration file, and some
  characteristics which have reasonable defaults but which those who
  think they know what they're doing may wish to play with.  The ``-h''
  option displays a summary of all the options.  The ``-V'' option
  displays the current version of the program, the API, and the selected
  drivers.  The ``-v'' option displays the values of the options after
  all sources have been considered.

  It's probably best to have the system automatically start BRLTTY as
  part of the boot sequence so that the braille display is already up
  and running when the login prompt appears.  Most (probably all)
  distributions provide a script wherein user-supplied applications can
  be safely started near the end of the boot sequence.  The name of this
  script is distribution-dependent.  Here are the ones we know about so
  far:

     [1mRed Hat[0m
        /etc/rc.d/rc.local

  Starting BRLTTY from this script is a good approach (especially for
  new users).  Just add a set of lines like these:



  if [ -x /bin/brltty -a -f /etc/brltty.conf ]
  then
     /bin/brltty
  fi



  This can usually be abbreviated to the somewhat less readable form:


       [ -x /bin/brltty -a -f /etc/brltty.conf ] && /bin/brltty



  Don't add these lines before the first line (which usually looks like
  #!/bin/sh).

  If the braille display is to be used by a system administrator, then
  it should probably be started as early as possible during the boot
  sequence (like before the file systems are checked) so that the
  display is usable in the event that something goes wrong during these
  checks and the system drops into single user mode.  Again, exactly
  where it's best to do this is distribution-dependent.  Here are the
  places we know about so far:

     [1mDebian[0m
        /etc/init.d/boot (for older releases)
        /etc/init.d/rcS (for newer releases)
        A brltty package is provided (see
        [http://packages.debian.org/brltty]) as of release 3.0 (Woody).
        Since this package takes care of starting BRLTTY, there's no
        need for user-supplied code to do so if it's installed.

     [1mRedHat[0m
        /etc/rc.d/rc.sysinit
        Beware that later releases, in order to support a more user-
        oriented system initialization procedure, have this script
        reinvoke itself such that it's under the control of initlog.
        Look, probably right up near the top, for a set of lines like
        these:


              # Rerun ourselves through initlog
              if [ -z "$IN_INITLOG" ]; then
                [ -f /sbin/initlog ] && exec /sbin/initlog $INITLOG_ARGS -r /etc/rc.sysinit
              fi



     Starting BRLTTY before this reinvocation results in two BRLTTY pro-
     cesses running at the same time, and that'll give you no end of
     problems.  If your version of this script has this feature, then
     make sure you start BRLTTY after the lines which implement it.

     [1mSlackware[0m
        /etc/rc.d/rc.S

     [1mSuSE[0m
        /sbin/init.d/boot

  An alternative is to start BRLTTY from /etc/inittab.  You have two
  choices if you choose this route.
  ·  If you want it to be started really early but don't need it to be
     automatially restarted if it dies, then add a line like this before
     the first :sysinit: line which is already in there.

       brl::sysinit:/bin/brltty


  ·  If you don't mind it being started later but do want it to be
     automatially restarted if it dies, then add a line like this
     anywhere within the file.

       brl:12345:respawn:/bin/brltty -n


  The ``-n'' (--nodaemon) option is very important when running BRLTTY
  with [1minit[22m's respawn facility.  You'll end up with hundreds of BRLTTY
  processes all running at the same time if you forget to specify it.

  Check that the identifier (bt in these examples) isn't already being
  used by another entry, and, if it is, choose a different one which
  isn't.

  Note that a command like kill -TERM is sufficient to stop BRLTTY in
  its tracks.  If it dies during entry into single user mode, for
  example, it may well be due to a problem of this nature.

  Some systems experience problems if an application tries to use the
  kernel's sound subsystem before it has been initialized.  If your
  system is one of them, then you may need to disable the automatic
  starting of the speech synthesizer driver with the ``-N'' option.

  Some systems, as part of the boot sequence, probe the serial ports
  (usually in order to automatically find the mouse and deduce its
  type).  If your braille display is using a serial port, this kind of
  probing may be enough to get it confused.  If this happens to you,
  then try restarting the braille driver (see the ``RESTARTBRL''
  command).  Better yet, turn off the serial port probing.  Here's what
  we know so far about how to do this:

     [1mRed Hat[0m
        The probing is done by a service named kudzu.  Use the command

          chkconfig --list kudzu

     to see if it's been enabled.  Use the command

          chkconfig kudzu off

     to disable it.  Later releases allow you to let kudzu run without
     probing the serial ports.  To do this, edit the file /etc/syscon-
     fig/kudzu, and set SAFE to yes.

  If you want to start BRLTTY before any file systems are mounted, then
  ensure that all of its components are installed within the root file
  system.  See the ``--with-execute-root'', ``--bindir'', ``--with-data-
  directory'', and ``--libdir'' build options.


  [1m3.5.  Security Considerations[0m

  BRLTTY needs to run with root privileges because it needs read and
  write access for the port to which the braille display is connected,
  read access to /dev/vcsa or equivalent (to query the screen dimensions
  and the cursor position, and to review the current screen content and
  highlighting), and read and write access to the system console (for
  arrow key entry during cursor routing, for input character insertion
  during paste, for special key simulation using keys on the braille
  display, for retrieving output character translation and screen font
  mapping tables, and for activation of the internal beeper).  Access to
  the needed devices can, of course, be granted to a non-root user by
  changing the file permissions associated with the devices.  Merely
  having access to the console, however, isn't enough because activating
  the internal beeper and simulating key strokes still require root
  privilege.  So, if you're willing to give up cursor routing,
  cut&paste, beeps, and all that, you can run BRLTTY without root
  priviledge.


  [1m3.6.  Build and Run-Time Restrictions[0m


     [1mAlert Tunes[0m

        Some platforms don't support all of the tune devices.  See the
        ``Tune Device'' preference for details.

     [1mFestivalLite Speech Synthesizer Driver[0m

        The driver for the FestivalLite text to speech engine is only
        built if that package has been installed.

        This driver and the driver for the Theta text to speech engine
        (see the ``--with-theta'' build option) cannot be simultaneously
        linked into the BRLTTY binary (see the ``--with-speech-driver''
        build option) because their run-time libraries contain
        conflicting symbols.

     [1mMikropuhe Speech Synthesizer Driver[0m

        The driver for the Mikropuhe text to speech engine is only built
        if that package has been installed.

        This driver cannot be included if the BRLTTY binary is
        statically linked (see the ``--enable-standalone-programs''
        build option) because a static archive isn't included with the
        package.

     [1mTheta Speech Synthesizer Driver[0m

        The driver for the Theta text to speech engine is only built if
        that package has been installed.

        This driver and the driver for the FestivalLite text to speech
        engine (see the ``--with-flite'' build option) cannot be
        simultaneously linked into the BRLTTY binary (see the ``--with-
        speech-driver'' build option) because their run-time libraries
        contain conflicting symbols.

        If this driver is built as a dynamically loadable shared object
        then $THETA_HOME/lib must be added to the LD_LIBRARY_PATH
        environment variable before BRLTTY is invoked because the shared
        objects within the package don't contain run-time search paths
        for their dependencies.

     [1mViaVoice Speech Synthesizer Driver[0m

        The driver for the ViaVoice text to speech engine is only built
        if that package has been installed.

        This driver cannot be included if the BRLTTY binary is
        statically linked (see the ``--enable-standalone-programs''
        build option) because a static archive isn't included with the
        package.

     [1mVideoBraille Braille Display Driver[0m

        The driver for the VideoBraille braille display is built on all
        systems, but only works on Linux.


  [1m3.7.  Installing from an RPM File[0m

  To install BRLTTY from an RPM (RedHat Package Manager) file, do the
  following:

  1. Download the binary package which corresponds to your hardware.
     It'll be a file named brltty-[4mrelease[24m-[4mversion[24m.[4marchitecture[24m.rpm, e.g.
     brltty-3.0-1.i386.rpm.

  2. Install the package.

       rpm -Uvh brltty-[4mrelease[24m-[4mversion[24m.[4marchitecture[24m.rpm


  This should be done as [1mroot[22m.  Strictly speaking, the -U (update)
  option is the only one which is necessary.  The -v (verbose) option
  displays the name of the package as it's being installed.  The -h
  (hashes) option displays a progress meter (using hash signs).

  For the brave, we also provide the source RPM (.src.rpm) file, but
  that's beyond the scope of this document.

  To uninstall BRLTTY, do:

       rpm -e brltty



  [1m3.8.  Other Utilities[0m

  Building BRLTTY also results in the building of a few small helper and
  diagnostic utilities.


  [1m3.8.1.  brltty-config[0m

  This utility sets a number of environment variables to values which
  reflect the current installation of BRLTTY (see ``Build Options'').
  It should be executed within an existing shell environment, i.e. not
  as a command in its own right, and can only be used by scripts which
  support [1mBourne Shell [22msyntax.

       . brltty-config


  The following environment variables are set:

     [1mBRLTTY_VERSION[0m
        The version number of the BRLTTY package.

     [1mBRLTTY_EXECUTE_ROOT[0m
        Run-time root for the installed package.  Configured via the
        ``--with-execute-root'' build option.

     [1mBRLTTY_PROGRAM_DIRECTORY[0m
        Directory for runnable programs (binaries, executables).
        Configured via the ``--with-program-directory'' build option.

     [1mBRLTTY_LIBRARY_DIRECTORY[0m
        Directory for drivers.  Configured via the ``--with-library-
        directory'' build option.

     [1mBRLTTY_DATA_DIRECTORY[0m
        Directory for tables and help pages.  Configured via the
        ``--with-data-directory'' build option.

     [1mBRLTTY_MANPAGE_DIRECTORY[0m
        Directory for manual pages.  Configured via the ``--with-
        manpage-directory'' build option.

     [1mBRLTTY_INCLUDE_DIRECTORY[0m
        Directory for BrlAPI's C header files.  Configured via the
        ``--with-include-directory'' build option.

     [1mBRLAPI_VERSION[0m
        The version number of BrlAPI (BRLTTY's Application Programming
        Interface).

     [1mBRLAPI_RELEASE[0m
        The full release number of BrlAPI.

     [1mBRLAPI_KEYFILE[0m
        The name of BrlAPI's key file.

  In addition, the following standard [1mautoconf [22menvironment variables are
  also set:

     [1mprefix[0m
        Subroot for architecture-independent files.  Configured via the
        ``--prefix'' build option.

     [1mexec_prefix[0m
        Subroot for architecture-dependent files.  Configured via the
        ``--exec-prefix'' build option.

     [1mbindir[0m
        Default location for ``program directory''.  Configured via the
        --bindir build option.

     [1mlibdir[0m
        Directory for BrlAPI's static archive and dynamically loadable
        object.  Default anchor for ``library directory''.  Configured
        via the ``--libdir'' build option.

     [1msysconfdir[0m
        Directory for configuration files.  Default anchor for ``data
        directory''.  Configured via the ``--sysconfdir'' build option.

     [1mmandir[0m
        Default location for ``manual pages directory''.  Configured via
        the --mandir build option.

     [1mincludedir[0m
        Default anchor for ``header files directory''.  Configured via
        the --includedir build option.


  [1m3.8.2.  brltty-install[0m

  This utility copies BRLTTY's ``installed file hierarchy'' from one
  location to another.

       brltty-install [4mto[24m [[4mfrom[24m]

     [4mto[24m The location to which the ``installed file hierarchy'' is to be
        copied.  It must be an existing directory.

     [4mfrom[0m
        The location from which the ``installed file hierarchy'' is to
        be taken.  If it's specified, then it must be an existing
        directory.  If it's not specified, then the location used for
        the build is assumed.

  This utility can be used, for example, to copy BRLTTY to a root disk.
  If a root floppy is mounted as /mnt, and BRLTTY is installed on the
  main system, then typing

       brltty-install /mnt


  copies BRLTTY, along with all of its data and library files, to the
  root floppy.

  Some problems have been experienced when copying BRLTTY between
  systems with different versions of the shared C library.  This is
  worth investigating if you have difficulties.


  [1m3.8.3.  brltest[0m

  This utility tests a braille display driver, and also provides an
  interactive way to learn what the keys on the braille display do.  It
  should be run as root.

       brltest -[4moption[24m ... [[4mdriver[24m [[4mname[24m=[4mvalue[24m ...]]



     [4mdriver[0m
        The driver for the braille display.  It must be a two-letter
        ``driver identification code''.  If it's not specified, then the
        first driver configured via the ``--with-braille-driver'' build
        option is assumed.

     [4mname[24m=[4mvalue[0m
        Set a braille display driver parameter.  For a description of
        the parameters accepted by a specific driver, please see the
        documentation for that driver.

     -d[4mdevice[24m --device=[4mdevice[0m
        The absolute path for the device to which the braille display is
        connected.  If it's not specified, then the device configured
        via the ``--with-braille-device'' build option is assumed.

     -D[4mdirectory[24m --data-directory=[4mdirectory[0m
        The absolute path for the directory wherein the driver data
        files reside.  If it's not specified, then the directory
        configured via the ``--with-data-directory'' build option is
        assumed.

     -L[4mdirectory[24m --library-directory=[4mdirectory[0m
        The absolute path for the directory wherein the drivers reside.
        If it's not specified, then the directory configured via the
        ``--libdir'' build option is assumed.

     -h --help
        Display a summary of the command line options, and then exit.

  This utility uses BRLTTY's ``Command Learn Mode''.  The key press
  timeout (after which this utility exits) is 10 seconds.  The message
  hold time (used for non-final segments of long messages) is 4 seconds.


  [1m3.8.4.  spktest[0m

  This utility tests a speech synthesizer driver.  It may need to be run
  as root.

       spktest -[4moption[24m ... [[4mdriver[24m [[4mname[24m=[4mvalue[24m ...]]



     [4mdriver[0m
        The driver for the speech synthesizer.  It must be a two-letter
        ``driver identification code''.  If it's not specified, then the
        first driver configured via the ``--with-speech-driver'' build
        option is assumed.

     [4mname[24m=[4mvalue[0m
        Set a speech synthesizer driver parameter.  For a description of
        the parameters accepted by a specific driver, please see the
        documentation for that driver.

     -t[4mstring[24m --text-string=[4mstring[0m
        The text to be spoken.  If it's not specified, then standard
        input is read.

     -D[4mdirectory[24m --data-directory=[4mdirectory[0m
        The absolute path for the directory wherein the driver data
        files reside.  If it's not specified, then the directory
        configured via the ``--with-data-directory'' build option is
        assumed.

     -L[4mdirectory[24m --library-directory=[4mdirectory[0m
        The absolute path for the directory wherein the drivers reside.
        If it's not specified, then the directory configured via the
        ``--libdir'' build option is assumed.

     -h --help
        Display a summary of the command line options, and then exit.


  [1m3.8.5.  scrtest[0m

  This utility tests the screen driver.  It must be run as root.

       scrtest -[4moption[24m ... [[4mname[24m=[4mvalue[24m ...]



     [4mname[24m=[4mvalue[0m
        Set a screen driver parameter.  For a description of the
        parameters accepted by a specific driver, please see the
        documentation for that driver.

     -l[4mcolumn[24m --left=[4mcolumn[0m
        Specify the starting (left) column (zero-origin) of the region.
        If this value isn't supplied, then a default value, based on the
        specified width, is selected such that the region is
        horizontally centred.

     -c[4mcount[24m --columns=[4mcount[0m
        Specify the width of the region (in columns).  If this value
        isn't supplied, then a default value, based on the specified
        starting column, is selected such that the region is
        horizontally centred.
     -t[4mrow[24m --top=[4mrow[0m
        Specify the starting (top) row (zero-origin) of the region.  If
        this value isn't supplied, then a default value, based on the
        specified height, is selected such that the region is vertically
        centred.

     -r[4mcount[24m --rows=[4mcount[0m
        Specify the height of the region (in rows).  If this value isn't
        supplied, then a default value, based on the specified starting
        row, is selected such that the region is vertically centred.

     -h --help
        Display a summary of the command line options, and then exit.

  Notes:

  ·  If neither a starting column nor a region width is specified, then
     the region is horizontally-centred and starts at column 5.

  ·  If neither a starting row nor a region height is specified, then
     the region is vertically-centred and starts at row 5.

  The following is written to standard output:

  1. A line detailing the dimensions of the screen.

       Screen: [4mwidth[24mx[4mheight[0m


  2. A line detailing the position (zero-origin) of the cursor.

       Cursor: [[4mcolumn[24m,[4mrow[24m]


  3. A line detailing the size of the selected screen region, and the
     position (zero-origin) of its top-left corner.

       Region: [4mwidth[24mx[4mheight[24m@[[4mcolumn[24m,[4mrow[24m]


  4. The contents of the selected screen region.  Unprintable characters
     are written as blanks.


  [1m3.8.6.  tbltest[0m

  This utility tests a translation table (see section ``Translation
  Tables'').

       tbltest -[4moption[24m ... [4mtranslation-table[0m



     [4mtranslation-table[0m
        The file system path to the translation table.  If it's relative
        then it's anchored at the directory configured via the ``--with-
        data-directory'' build option.

     -h --help
        Display a summary of the command line options, and then exit.


  [1m3.8.7.  ctbtest[0m

  This utility tests a contraction table (see section ``Contracted
  Braille'').  The text read from standard input is rewritten to
  standard output as contracted braille.

       ctbtest -[4moption[24m ... [4mcontraction-table[0m



     [4mcontraction-table[0m
        The file system path to the contraction table.  If it's relative
        then it's anchored at the directory configured via the ``--with-
        data-directory'' build option.

     -t[4mfile[24m --text-table=[4mfile[0m
        The file system path to the text translation table to use.  If
        it's relative then it's anchored at the directory configured via
        the ``--with-data-directory'' build option.  If this option
        isn't supplied then the table defined via the ``--with-text-
        table'' build option is assumed.

     -h --help
        Display a summary of the command line options, and then exit.

  The text translation table is used:

  ·  To define the output character set so that the contracted braille
     will be displayed correctly.  The same table as will be used by
     BRLTTY when the output is read should be specified.

  ·  To define the braille representations of those characters defined
     within the contraction table as = (see section ``Character
     Translation'').

  The text.brf.tbl text translation table is provided for use with this
  utility.  It defines the format used within .brf files.  This is also
  the preferred format used by most braille printers and within
  electronically distributed braille documents.  This table effectively
  allows this utility to be used as a text to braille translator.


  [1m3.8.8.  tunetest[0m

  This utility tests the alert tunes facility, and also provides an easy
  way to compose new tunes.  It may need to be run as root.

       tunetest -[4moption[24m ... {[4mnote[24m [4mduration[24m} ...



     [4mnote[0m
        A standard MIDI note number.  It must be an integer from 1
        through 127, with 60 representing Middle C.  Each value
        represents a standard chromatic semi-tone, with the next lower
        and higher values representing, respectively, the next lower and
        higher notes.  The lowest value (1) represents the fifth C-Sharp
        below Middle C, and the highest value (127) represents the sixth
        G above Middle C.

     [4mduration[0m
        The duration of the note in milliseconds.  It must be an integer
        from 1 through 255.

     -d[4mdevice[24m --device=[4mdevice[0m
        The device on which to play the tune.

        [1mbeeper[0m
           The internal beeper (console tone generator).

        [1mpcm[0m
           The digital audio interface on the sound card.

        [1mmidi[0m
           The Musical Instrument Digital Interface on the sound card.

        [1mfm [22mThe FM synthesizer on an AdLib, OPL3, Sound Blaster, or
           equivalent sound card.

        The device name may be abbreviated.  See the ``Tune Device''
        preference for details regarding the default device and platform
        restrictions.

     -v[4mloudness[24m --volume=[4mloudness[0m
        Specify the output volume (loudness) as a percentage of the
        maximum.  The default output volume is 50.

     -p[4mdevice[24m --pcm-device=[4mdevice[0m
        Specify the device to use for digital audio (see section ``PCM
        Device Specification'').  This option isn't available if the
        ``--disable-pcm-support'' build option was specified.

     -m[4mdevice[24m --midi-device=[4mdevice[0m
        Specify the device to use for the Musical Instrument Digital
        Interface (see section ``MIDI Device Specification'').  This
        option isn't available if the ``--disable-midi-support'' build
        option was specified.

     -i[4minstrument[24m --instrument=[4minstrument[0m
        The instrument to use if the selected device is midi.  For the
        complete list of instruments, see the ``MIDI Instrument Table''.
        The default instrument is an acoustic grand piano.  The words
        comprising the instrument name must be separated from one
        another by a single minus sign rather than by spaces, and any of
        the words may be abbreviated.  An acoustic grand piano, for
        example, may be specified as a-gra-pi.

     -h --help
        Display a summary of the command line options, and then exit.


  [1m4.  Using BRLTTY[0m

  Before starting BRLTTY, you need to set up your braille display.  In
  most cases this is done simply by connecting it to an available serial
  port, and then turning it on.  After your display has been set up, run
  BRLTTY simply by typing the command brltty at a shell prompt (this
  must be done as root).  Check the ``-d'' command line option, the
  ``braille-device'' configuration file directive, and the ``--with-
  braille-device'' build option for alternatives regarding how to tell
  BRLTTY which device your display is connected to.  Check the ``-b''
  command line option, the ``braille-driver'' configuration file
  directive, and the ``--with-braille-driver'' build option for
  alternatives regarding how to tell BRLTTY which kind of braille
  display you have.  Check the ``-B'' command line option, and the
  ``braille-parameters'' configuration file directive for alternatives
  regarding how to pass parameters to the driver for your braille
  display.

  A message giving the program name (BRLTTY) and its version number will
  appear briefly (see the ``-M'' command line option) on the braille
  display.  The display will then show a small area of the screen
  including the cursor.  By default, the cursor is represented as dots 7
  and 8 superimposed on the character it is on.


  Any screen activity will be reflected on the braille display.  The
  display will also follow the progress of the cursor on the screen.
  This feature is known as [1mcursor tracking[22m.

  Just typing on the keyboard and reading the display, however, isn't
  enough.  Try entering a command which will cause an error, and
  pressing [1menter[22m.  The error appears on the screen, but, unless you have
  a multi-line display, the chances are that it isn't visible on the
  braille display.  All you see thereon is another shell prompt.  What's
  needed, then, is some way to move the braille [4mwindow[24m around the
  screen.  The keys on the braille display itself can be used to send
  commands to BRLTTY which, in addition to a lot of other things, can
  also do exactly that.


  [1m4.1.  Commands[0m

  Unfortunately, the various braille displays don't offer a standard set
  of controls.  Some have the six standard dot keys, some have eight,
  and others have none.  Some have thumb keys, but there's no standard
  number of them.  Some have a button above each braille cell.  Some
  have rocker switches.  Some have an easy-to-reach bar which works much
  like a joystick.  Most have varying combinations of the above.
  Because the nature and layout of each display is so different, please
  refer to the documentation for your particular display in order to
  find out exactly what its keys do.

  BRLTTY commands are referred to by name within this manual.  If you
  forget which key(s) on your braille display to use for a paticular
  command, then refer to its driver's help page.  The main key you
  should immediately commit to memory, therefore, is the one for the
  ``HELP'' command.  Use the regular motion keys (as described below) to
  navigate the help page, and press the help key again to quit.


  [1m4.1.1.  Vertical Motion[0m

  See also the ``PRINDENT/NXINDENT'' routing key commands.

     [1mLNUP/LNDN[0m
        Go up/down one line.  If identical line skipping has been
        activated (see the ``SKPIDLNS'' command), then these commands,
        rather than moving exactly one line, are aliases for the
        ``PRDIFLN/NXDIFLN'' commands.

     [1mWINUP/WINDN[0m
        Go up/down one window.  If the window is only 1 line high then
        move 5 lines.

     [1mPRDIFLN/NXDIFLN[0m
        Go up/down to the nearest line with different content.  If
        identical line skipping has been activated (see the ``SKPIDLNS''
        command), then these commands, rather than skipping identical
        lines, are aliases for the ``LNUP/LNDN'' commands.

     [1mATTRUP/ATTRDN[0m
        Go up/down to the nearest line with different attributes
        (character highlighting).

     [1mTOP/BOT[0m
        Go to the top/bottom line.

     [1mTOP_LEFT/BOT_LEFT[0m
        Go to the top-left/bottom-left corner.


     [1mPRPGRPH/NXPGRPH[0m
        Go to the nearest line of the previous/next paragraph (the first
        non-blank line beyond the nearest blank line).  The current line
        is included when searching for the inter-paragraph space.

     [1mPRPROMPT/NXPROMPT[0m
        Go to the previous/next command prompt.

     [1mPRSEARCH/NXSEARCH[0m
        Search backward/forward for the nearest occurrence of the
        character string within the cut buffer (see ``Cut and Paste'')
        which isn't within the braille window.  The search proceeds to
        the left/right, starting at the character immediately to the
        left/right of the window, and wrapping at the edge of the
        screen.  The search isn't case sensitive.


  [1m4.1.2.  Horizontal Motion[0m

  See also the ``SETLEFT'' routing key command.

     [1mCHRLT/CHRRT[0m
        Go left/right one character.

     [1mHWINLT/HWINRT[0m
        Go left/right half a window.

     [1mFWINLT/FWINRT[0m
        Go left/right one window.  These commands are particularly
        useful because they automatically wrap when they reach the edge
        of the screen.  Other features, like their ability to skip blank
        windows (see the ``SKPBLNKWINS'' command), further enhance their
        usefulness.

     [1mFWINLTSKIP/FWINRTSKIP[0m
        Go left/right to the nearest non-blank window.

     [1mLNBEG/LNEND[0m
        Go to the beginning/end of the line.


  [1m4.1.3.  Implicit Motion[0m

  See also the ``GOTOMARK'' routing key command.

     [1mHOME[0m
        Go to where the cursor is.

     [1mBACK[0m
        Go back to where the most recent motion command put the braille
        window.  This is an easy way to get right back to where you were
        reading after an unexpected event (like cursor tracking) moves
        the braille window at an inopportune moment.

     [1mRETURN[0m

        ·  If the most recent motion of the braille window was
           automatic, e.g. as a result of cursor tracking, then go back
           to where the most recent motion command put it (see the
           ``BACK'' command).

        ·  If the cursor isn't within the braille window then go to
           where the cursor is (see the ``HOME'' command).



  [1m4.1.4.  Feature Activation[0m

  Each of these commands has three forms: [1mactivate [22m(turn the feature
  on), [1mdeactivate [22m(turn the feature off), and [1mtoggle [22m(if it's off then
  turn it on, and if it's on then turn it off).  Unless specifically
  noted, each of these features is initially [1moff[22m, and, when [1mon[22m, affects
  BRLTTY's operation as a whole.  The initial setting of some of these
  features can be changed via the ``preferences menu''.

     [1mFREEZE[0m
        Freeze the screen image.  BRLTTY makes a copy of the screen
        (content and attributes) as of the moment when the screen image
        is frozen, and then ignores all updating of the screen until
        it's unfrozen.  This feature makes it easy, for example, to
        sample the output of an application which writes too much too
        quickly.

     [1mDISPMD[0m
        Show the highlighting (the attributes) of each character within
        the braille window, rather than the characters themselves (the
        content).  This feature is useful, for example, when you need to
        locate a highlighted item.  When showing screen content, the
        text translation table is used (see the ``-t'' command line
        option, the ``text-table'' configuration file directive, and the
        ``--with-text-table'' build option).  When showing screen
        attributes, the attributes translation table is used (see the
        ``-a'' command line option, the ``attributes-table''
        configuration file directive, and the ``--with-attributes-
        table'' build option).  This feature only affects the current
        virtual terminal.

     [1mSIXDOTS[0m
        Show characters using 6-dot, rather than 8-dot, braille.  Dots 7
        and 8 are still used by other features like cursor
        representation and highlighted character underlining.  If a
        contraction table has been selected (see the ``-c'' command line
        option and the ``contraction-table'' configuration file
        directive), then it is used.  This setting can also be changed
        with the ``Text Style'' preference.

     [1mSLIDEWIN[0m
        If cursor tracking (see the ``CSRTRK'' command) is [1mon[22m, then,
        whenever the cursor moves too close to (or beyond) either end of
        the braille window, horizontally reposition the window such that
        the cursor, while remaining on that side, is nearer the centre.
        If this feature is [1moff[22m, then the braille window is always
        positioned such that its left end is a multiple of its width
        from the left edge of the screen.  This setting can also be
        changed with the ``Sliding Window'' preference.

     [1mSKPIDLNS[0m
        Rather than explicitly moving exactly one line either up or
        down, skip passed lines which have the same content as the
        current line.  This feature affects the ``LNUP/LNDN'' commands,
        as well as the line wrapping feature of the ``FWINLT/FWINRT''
        and ``FWINLTSKIP/FWINRTSKIP'' commands.  This setting can also
        be changed with the ``Skip Identical Lines'' preference.

     [1mSKPBLNKWINS[0m
        Skip passed blank windows when reading either forward or
        backward.  This feature affects the ``FWINLT/FWINRT'' commands.
        This setting can also be changed with the ``Skip Blank Windows''
        preference.

     [1mCSRVIS[0m
        Show the cursor by superimposing a dot pattern (see the
        ``CSRSIZE'' command) on top of the character where it is.  This
        feature is initially [1mon[22m.  This setting can also be changed with
        the ``Show Cursor'' preference.

     [1mCSRHIDE[0m
        Hide the cursor (see the ``CSRVIS'' command) in order to
        accurately read the character beneath it.  This feature only
        affects the current virtual terminal.

     [1mCSRTRK[0m
        Track (follow) the cursor.  If the cursor moves to a location
        which isn't within the braille window, then automatically move
        the braille window to the cursor's new location.  You'll usually
        want this feature turned on since it minimizes the effects of
        screen scrolling, and since, during input, the region wherein
        you're currently typing is always visible.  If this feature
        causes the braille window to jump at an inopportune moment, then
        use the ``BACK'' command to get back to where you were reading.
        You may need to turn this feature off when using an application
        which continually updates the screen while maintaining a fixed
        data layout.  This feature is initially [1mon[22m.  This feature only
        affects the current virtual terminal.

     [1mCSRSIZE[0m
        Represent the cursor with all eight dots (a solid block), rather
        than with just dots 7 and 8 (an underline).  This setting can
        also be changed with the ``Cursor Style'' preference.

     [1mCSRBLINK[0m
        Blink (turn on and off according to a predefined interval) the
        symbol representing the cursor (see the ``CSRVIS'' command).
        This setting can also be changed with the ``Blinking Cursor''
        preference.

     [1mATTRVIS[0m
        Underline (with combinations of dots 7 and 8) highlighted
        characters.

        [1mno underline[0m
           White on black (normal), gray on black, white on blue, black
           on cyan.

        [1mdots 7 and 8[0m
           Black on white (reverse video).

        [1mdot 8[0m
           Everything else.

        This setting can also be changed with the ``Show Attributes''
        preference.

     [1mATTRBLINK[0m
        Blink (turn on and off according to a predefined interval) the
        attribute underline (see the ``ATTRVIS'' command).  This feature
        is initially [1mon[22m.  This setting can also be changed with the
        ``Blinking Attributes'' preference.

     [1mCAPBLINK[0m
        Blink (turn on and off according to a predefined interval)
        capital (uppercase) letters.  This setting can also be changed
        with the ``Blinking Capitals'' preference.

     [1mTUNES[0m
        Play a short predefined tune (see ``Alert Tunes'') whenever a
        significant event occurs.  This feature is initially [1mon[22m.  This
        setting can also be changed with the ``Alert Tunes'' preference.
     [1mAUTOREPEAT[0m
        Automatically repeat a command at a regular interval after an
        initial delay while its key (combination) remains pressed.  Only
        some drivers support this functionality, the primary limitation
        being that many braille displays don't signal both key presses
        and key releases as distinctly separate events.  This feature is
        initially [1moff[22m.  This setting can also be changed with the
        ``Autorepeat'' preference.

     [1mAUTOSPEAK[0m
        Automatically speak:

        ·  the new line when the braille window is moved vertically.

        ·  characters which are entered or deleted.

        ·  the character to which the cursor is moved.

        This feature is initially [1moff[22m.  This setting can also be changed
        with the ``Autospeak'' preference.


  [1m4.1.5.  Mode Selection[0m


     [1mHELP[0m
        Switch to the braille display driver's help page.  This is where
        you can find an on-line summary of things like what your braille
        display's keys do, and how to interpret its status cells.  Use
        the regular ``vertical'' and ``horizontal'' motion commands to
        navigate the help page.  Invoke the help command again to return
        to the screen.

     [1mINFO[0m
        Switch to the status display (see section ``The Status Display''
        for full details).  It presents a summary including the position
        of the cursor, the position of the braille window, and the
        states of a number of BRLTTY's features.  Invoke this command
        again to return to the screen.

     [1mLEARN[0m
        Switch to command learn mode (see section ``Command Learn Mode''
        for full details).  This is how you can interactively learn what
        your braille display's keys do.  Invoke this command again to
        return to the screen.  This command isn't available if the
        ``--disable-learn-mode'' build option was specified.


  [1m4.1.6.  Preference Maintenance[0m


     [1mPREFMENU[0m
        Switch to the preferences menu (see ``The Preferences Menu'' for
        full details).  Invoke this command again to return to normal
        operation.  This command isn't available if the ``--disable-
        preferences-menu'' build option was specified.

     [1mPREFSAVE[0m
        Save the current preferences settings (see ``Preferences'' for
        full details).

     [1mPREFLOAD[0m
        Restore the most recently saved preferences settings (see
        ``Preferences'' for full details).


  [1m4.1.7.  Menu Navigation[0m


     [1mMENU_FIRST_ITEM/MENU_LAST_ITEM[0m
        Go to the first/last item in the menu.

     [1mMENU_PREV_ITEMMENU_NEXT_ITEM/[0m
        Go to the previous/next item in the menu.

     [1mMENU_PREV_SETTING/MENU_NEXT_SETTING[0m
        Decrement/increment the current menu item's setting.


  [1m4.1.8.  Speech Controls[0m


     [1mSAY_LINE[0m
        Speak the current line.  The ``Say-Line Mode'' preference
        determines if pending speech is discarded first.

     [1mSAY_ABOVE[0m
        Speak the top portion of the screen (ending with the current
        line).

     [1mSAY_BELOW[0m
        Speak the bottom portion of the screen (starting with the
        current line).

     [1mMUTE[0m
        Stop speaking immediately.

     [1mSPKHOME[0m
        Go to where the speech cursor is.

     [1mSAY_SLOWER/SAY_FASTER[0m
        Decrease/increase the speech rate (see also the ``Speech Rate''
        preference).  This command is only available if a driver which
        supports it is being used.

     [1mSAY_SOFTER/SAY_LOUDER[0m
        Decrease/increase the speech volume (see also the ``Speech
        Volume'' preference).  This command is only available if a
        driver which supports it is being used.


  [1m4.1.9.  Virtual Terminal Switching[0m

  See also the ``SWITCHVT'' routing key command.

     [1mSWITCHVT_PREV/SWITCHVT_NEXT[0m
        Switch to the previous/next virtual terminal.


  [1m4.1.10.  Other Commands[0m


     [1mCSRJMP_VERT[0m
        Route (bring) the cursor to anywhere on the top line of the
        braille window (see ``Cursor Routing'' for full details).  The
        cursor is moved by simulating vertical arrow-key presses.  This
        command doesn't always work because some applications either
        move the cursor somewhat unpredictably or use the arrow keys for
        purposes other than cursor motion.  It's somewhat safer than the
        other cursor routing commands, though, because it makes no
        attempt to simulate the left- and right-arrows.

     [1mPASTE[0m
        Insert the characters within the cut buffer at the current
        cursor location (see ``Cut and Paste'' for full details).

     [1mRESTARTBRL[0m
        Stop, and then restart the braille display driver.

     [1mRESTARTSPEECH[0m
        Stop, and then restart the speech synthesizer driver.


  [1m4.1.11.  Routing Keys[0m


     [1mROUTE[0m
        Route (bring) the cursor to the character associated with the
        routing key (see ``Cursor Routing'' for full details).  The
        cursor is moved by simulating arrow-key presses.  This command
        doesn't always work because some applications either move the
        cursor somewhat unpredictably or use the arrow keys for purposes
        other than cursor motion.

     [1mCUTBEGIN[0m
        Anchor the start of the cut block at the character associated
        with the routing key (see ``Cut and Paste'' for full details).
        This command clears the cut buffer.

     [1mCUTAPPEND[0m
        Anchor the start of the cut block at the character associated
        with the routing key (see ``Cut and Paste'' for full details).
        This command doesn't clear the cut buffer.

     [1mCUTRECT[0m
        Anchor the end of the cut block at the character associated with
        the routing key, and append the rectangular region to the cut
        buffer (see ``Cut and Paste'' for full details).

     [1mCUTLINE[0m
        Anchor the end of the cut block at the character associated with
        the routing key, and append the linear region to the cut buffer
        (see ``Cut and Paste'' for full details).

     [1mSWITCHVT[0m
        Switch to the virtual terminal whose number (counting from 1)
        matches that of the routing key.  See also the
        ``SWITCHVT_PREV/SWITCHVT_NEXT'' virtual terminal switching
        commands.

     [1mPRINDENT/NXINDENT[0m
        Go up/down to the nearest line which isn't indented more than
        the column associated with the routing key.

     [1mDESCCHAR[0m
        Momentarily (see the ``-M'' command line option) display a
        message describing the character associated with the routing
        key.  It reveals the decimal and hexadecimal values of the
        character, the foreground and background colours, and, when
        present, special attributes (bright and blink).  The message
        looks like this:

          char 65 (0x41): white on black bright blink


     [1mSETLEFT[0m
        Horizontally reposition the braille window so that its left edge
        is at the column associated with the routing key.  This feature
        makes it very easy to put the window exactly where it's needed,
        and, therefore, for displays which have routing keys, almost
        eliminates the need for a lot of elementary window motion (like
        the ``CHRLT/CHRRT'' and ``HWINLT/HWINRT'' commands).

     [1mSETMARK[0m
        Mark (remember) the current position of the braille window in a
        register associated with the routing key.  See the ``GOTOMARK''
        command.  This feature only affects the current virtual
        terminal.

     [1mGOTOMARK[0m
        Move the braille window to the position formerly marked (see the
        ``SETMARK'' command) with the same routing key.  This feature
        only affects the current virtual terminal.


  [1m4.2.  The Configuration File[0m

  System defaults for many settings may be established within a
  configuration file.  The default name for this file is
  /etc/brltty.conf, although it may be overridden with the ``-f''
  command line option.  It doesn't need to exist.  A template for it can
  be found within the DOCS subdirectory.

  Blank lines are ignored.  A comment begin with a number sign (#), and
  continues to the end of the line.  The following directives are
  recognized:

     api-parameters [4mname[24m=[4mvalue[24m,...
        Specify parameters for the Application Programming Interrface.
        If the same parameter is specified more than once, then its
        rightmost assignment is used.  For a description of the
        parameters accepted by the interface, please see the [1mBrlAPI[0m
        reference manual.  See the ``--with-api-parameters'' build
        option for the defaults established during the build procedure.
        This directive can be overridden with the ``-A'' command line
        option.

     attributes-table [4mfile[0m
        Specify the attributes translation table (see section
        ``Translation Tables'' for details).  If a relative path is
        supplied, then it's anchored at /etc/brltty (see the ``--with-
        data-directory'' and the ``--with-execute-root'' build options
        for more details).  The .tbl extension is optional.  See the
        ``--with-attributes-table'' build option for the default
        established during the build procedure.  This directive can be
        overridden with the ``-a'' command line option.

     braille-device [4mdevice[24m,...
        Specify the device to which the braille display is connected
        (see section ``Braille Device Specification'').  See the
        ``--with-braille-device'' build option for the default
        established during the build procedure.  This directive can be
        overridden with the ``-d'' command line option.

     braille-driver [4mdriver[24m,...|auto
        Specify the braille display driver (see section ``Driver
        Specification'').  See the ``--with-braille-driver'' build
        option for the default established during the build procedure.
        This directive can be overridden with the ``-b'' command line
        option.

     braille-parameters [[4mdriver[24m:][4mname[24m=[4mvalue[24m,...
        Specify parameters for the braille display drivers.  If the same
        parameter is specified more than once, then its rightmost
        assignment is used.  If a parameter name is qualified by a
        driver (see section ``Driver Identification Codes'') then that
        setting only applies to that driver; if it isn't then it applies
        to all drivers.  For a description of the parameters accepted by
        a specific driver, please see the documentation for that driver.
        See the ``--with-braille-parameters'' build option for the
        defaults established during the build procedure.  This directive
        can be overridden with the ``-B'' command line option.

     contraction-table [4mfile[0m
        Specify the contraction table (see section ``Contracted
        Braille'' for details).  If a relative path is supplied, then
        it's anchored at /etc/brltty (see the ``--with-data-directory''
        and the ``--with-execute-root'' build options for more details).
        The .ctb extension is optional.  The contraction table is used
        when the 6-dot braille feature is activated (see the ``SIXDOTS''
        command and the ``Text Style'' preference).  The default is to
        display uncontracted 6-dot braille.  This directive can be
        overridden with the ``-c'' command line option.  It isn't
        available if the ``--disable-contracted-braille'' build option
        was specified.

     midi-device [4mdevice[0m
        Specify the device to use for the Musical Instrument Digital
        Interface (see section ``MIDI Device Specification'').  This
        directive can be overridden with the ``-m'' command line option.
        It isn't available if the ``--disable-midi-support'' build
        option was specified.

     pcm-device [4mdevice[0m
        Specify the device to use for digital audio (see section ``PCM
        Device Specification'').  This directive can be overridden with
        the ``-p'' command line option.  It isn't available if the
        ``--disable-pcm-support'' build option was specified.

     screen-parameters [4mname[24m=[4mvalue[24m,...
        Specify parameters for the screen driver.  If the same parameter
        is specified more than once, then its rightmost assignment is
        used.  For a description of the parameters accepted by a
        specific driver, please see the documentation for that driver.
        See the ``--with-screen-parameters'' build option for the
        defaults established during the build procedure.  This directive
        can be overridden with the ``-X'' command line option.

     speech-driver [4mdriver[24m,...|auto
        Specify the speech synthesizer driver (see section ``Driver
        Specification'').  See the ``--with-speech-driver'' build option
        for the default established during the build procedure.  This
        directive can be overridden with the ``-s'' command line option.
        It isn't available if the ``--disable-speech-support'' build
        option was specified.

     speech-fifo [4mfile[0m
        Specify the FIFO (a special file which works like a pipe) which
        is to be used by other applications that wish to gain access to
        BRLTTY's speech driver.  This directive can be overridden with
        the ``-F'' command line option.  It isn't available if the
        ``--disable-speech-support'' build option was specified.

     speech-parameters [[4mdriver[24m:][4mname[24m=[4mvalue[24m,...
        Specify parameters for the speech synthesizer drivers.  If the
        same parameter is specified more than once, then its rightmost
        assignment is used.  If a parameter name is qualified by a
        driver (see section ``Driver Identification Codes'') then that
        setting only applies to that driver; if it isn't then it applies
        to all drivers.  For a description of the parameters accepted by
        a specific driver, please see the documentation for that driver.
        See the ``--with-speech-parameters'' build option for the
        defaults established during the build procedure.  This directive
        can be overridden with the ``-S'' command line option.

     text-table [4mfile[0m
        Specify the text translation table (see section ``Translation
        Tables'' for details).  If a relative path is supplied, then
        it's anchored at /etc/brltty (see the ``--with-data-directory''
        and the ``--with-execute-root'' build options for more details).
        The .tbl extension is optional.  For a simple file name, the
        text. prefix is optional.  See the ``--with-text-table'' build
        option for the default established during the build procedure.
        This directive can be overridden with the ``-t'' command line
        option.


  [1m4.3.  Command Line Options[0m

  Many settings can be explicitly specified when invoking BRLTTY.  The
  brltty command accepts the following options:

     -a[4mfile[24m --attributes-table=[4mfile[0m
        Specify the attributes translation table (see section
        ``Translation Tables'' for details).  If a relative path is
        supplied, then it's anchored at /etc/brltty (see the ``--with-
        data-directory'' and the ``--with-execute-root'' build options
        for more details).  The .tbl extension is optional.  See the
        ``attributes-table'' configuration file directive for the
        default run-time setting.  This setting can be changed with the
        ``Attributes Table'' preference.

     -b[4mdriver[24m,...|auto --braille-driver=[4mdriver[24m,...|auto
        Specify the braille display driver (see section ``Driver
        Specification'').  See the ``braille-driver'' configuration file
        directive for the default run-time setting.

     -c[4mfile[24m --contraction-table=[4mfile[0m
        Specify the contraction table (see section ``Contracted
        Braille'' for details).  If a relative path is supplied, then
        it's anchored at /etc/brltty (see the ``--with-data-directory''
        and the ``--with-execute-root'' build options for more details).
        The .ctb extension is optional.  The contraction table is used
        when the 6-dot braille feature is activated (see the ``SIXDOTS''
        command and the ``Text Style'' preference).  See the
        ``contraction-table'' configureation file directive for the
        default run-time setting.  This setting can be changed with the
        ``Contraction Table'' preference.  This option isn't available
        if the ``--disable-contracted-braille'' build option was
        specified.

     -d[4mdevice[24m,... --braille-device=[4mdevice[24m,...
        Specify the device to which the braille display is connected
        (see section ``Braille Device Specification'').  See the
        ``braille-device'' configuration file directive for the default
        run-time setting.

     -e --standard-error
        Write diagnostic messages to standard error.  The default is to
        record them via syslog.

     -f[4mfile[24m --configuration-file=[4mfile[0m
        Specify the location of the ``configuration file'' which is to
        be used for the establishing of default run-time settings.


     -h --help
        Display a summary of the command line options accepted by
        BRLTTY, and then exit.

     -l[4mlevel[24m --log-level=[4mlevel[0m
        Specify the severity threshold for diagnostic message
        generation.  The following levels are recognized.

        [1m0  [22memergency

        [1m1  [22malert

        [1m2  [22mcritical

        [1m3  [22merror

        [1m4  [22mwarning

        [1m5  [22mnotice

        [1m6  [22minformation

        [1m7  [22mdebug

        Either the number or the name may be supplied, and the name may
        be abbreviated.  If not specified, then information is assumed
        (see the ``-q'' option for more details).

     -m[4mdevice[24m --midi-device=[4mdevice[0m
        Specify the device to use for the Musical Instrument Digital
        Interface (see section ``MIDI Device Specification'').  See the
        ``midi-device'' configuration file directive for the default
        run-time setting.  This option isn't available if the
        ``--disable-midi-support'' build option was specified.

     -n --no-daemon
        Specify that BRLTTY is to remain in the foreground.  If not
        specified, then BRLTTY becomes a background process (daemon)
        after initializing itself but before starting any of the
        selected drivers.

     -p[4mdevice[24m --pcm-device=[4mdevice[0m
        Specify the device to use for digital audio (see section ``PCM
        Device Specification'').  See the ``pcm-device'' configuration
        file directive for the default run-time setting.  This option
        isn't available if the ``--disable-pcm-support'' build option
        was specified.

     -q --quiet
        Log less information.  This option changes the default log level
        (see the ``-l'' option) to notice if either the ``-v'' or the
        ``-V'' option is specified, and to warning otherwise.

     -s[4mdriver[24m,...|auto --speech-driver=[4mdriver[24m,...|auto
        Specify the speech synthesizer driver (see section ``Driver
        Specification'').  See the ``speech-driver'' configuration file
        directive for the default run-time setting.  This option isn't
        available if the ``--disable-speech-support'' build option was
        specified.

     -t[4mfile[24m --text-table=[4mfile[0m
        Specify the text translation table (see section ``Translation
        Tables'' for details).  If a relative path is supplied, then
        it's anchored at /etc/brltty (see the ``--with-data-directory''
        and the ``--with-execute-root'' build options for more details).
        The .tbl extension is optional.  For a simple file name, the
        text. prefix is optional.  See the ``text-table'' configureation
        file directive for the default run-time setting.  This setting
        can be changed with the ``Text Table'' preference.

     -v --verify
        Display the current versions of BRLTTY itself, of the server
        side of its application programming interface, and of the
        selected braille and speech drivers, and then exit.  If the
        ``-q'' option isn't specified, then also display copyright
        information as well as the values of the options after all
        sources have been considered.  If more than one braille driver
        (see the ``-b'' command line option) and/or more than one
        braille device (see the ``-d'' command line option) has been
        specified then braille display autodetection is performed.  If
        more than one speech driver (see the ``-s'' command line option)
        has been specified then speech synthesizer autodetection is
        performed.

     -A[4mname[24m=[4mvalue[24m,... --api-parameters=[4mname[24m=[4mvalue[24m,...
        Specify parameters for the Application Programming Interface.
        If the same parameter is specified more than once, then its
        rightmost assignment is used.  For a description of the
        parameters accepted by the interface, please see the [1mBrlAPI[0m
        reference manual.  See the ``api-parameters'' configuration file
        directive for the default run-time settings.

     -B[[4mdriver[24m:][4mname[24m=[4mvalue[24m,... --braille-parame-
        ters=[[4mdriver[24m:][4mname[24m=[4mvalue[24m,...
        Specify parameters for the braille display drivers.  If the same
        parameter is specified more than once, then its rightmost
        assignment is used.  If a parameter name is qualified by a
        driver (see section ``Driver Identification Codes'') then that
        setting only applies to that driver; if it isn't then it applies
        to all drivers.  For a description of the parameters accepted by
        a specific driver, please see the documentation for that driver.
        See the ``braille-parameters'' configuration file directive for
        the default run-time settings.

     -E --environment-variables
        Recognize environment variables when determining the default
        settings for unspecified command line options (see section
        ``Command Line Options'').  If this option is specified, and if
        the environment variable associated with an unspecified option
        is defined, then the value of that environment variable is used.
        The names of these environment variables are based on the long
        names of the options they correspond to:

        ·  All letters are in upper case.

        ·  Underscores (_) are used instead of minus signs (-).

        ·  The prefix BRLTTY_ is added.

        This option is particularly useful on the Linux operating system
        as it allows default settings to be passed to BRLTTY via boot
        parameters.  The following environment variables are supported:

        BRLTTY_API_PARAMETERS
           Parameters for the Application Programming Interface (see the
           ``-A'' command line option).

        BRLTTY_ATTRIBUTES_TABLE
           The attributes translation table (see the ``-a'' command line
           option).


        BRLTTY_BRAILLE_DEVICE
           The braille display device (see the ``-d'' command line
           option).

        BRLTTY_BRAILLE_DRIVER
           The braille display driver (see the ``-b'' command line
           option).

        BRLTTY_BRAILLE_PARAMETERS
           Parameters for the braille display driver (see the ``-B''
           command line option).

        BRLTTY_CONFIGURATION_FILE
           The configuration file (see the ``-f'' command line option).

        BRLTTY_CONTRACTION_TABLE
           The contraction table (see the ``-c'' command line option).

        BRLTTY_MIDI_DEVICE
           The Musical Instrument Digital Interface device (see the
           ``-m'' command line option).

        BRLTTY_PCM_DEVICE
           The digital audio device (see the ``-p'' command line
           option).

        BRLTTY_SCREEN_PARAMETERS
           Parameters for the screen driver (see the ``-X'' command line
           option).

        BRLTTY_SPEECH_DRIVER
           The speech synthesizer driver (see the ``-s'' command line
           option).

        BRLTTY_SPEECH_FIFO
           The speech pass-through FIFO (see the ``-F'' command line
           option).

        BRLTTY_SPEECH_PARAMETERS
           Parameters for the speech synthesizer driver (see the ``-S''
           command line option).

        BRLTTY_TEXT_TABLE
           The text translation table (see the ``-a'' command line
           option).

     -F[4mfile[24m --speech-fifo=[4mfile[0m
        Specify the FIFO (a special file which works like a pipe) which
        is to be used by other applications that wish to gain access to
        BRLTTY's speech driver.  If not specified, no FIFO is created.
        See the ``speech-fifo'' configuration file directive for the
        default run-time setting.  This option isn't available if the
        ``--disable-speech-support'' build option was specified.

     -M[4mcsecs[24m --message-delay=[4mcsecs[0m
        Specify the amount of time (in hundredths of a second) that
        BRLTTY keeps its own internally generated messages on the
        braille display.  If not specified, then 400 (4 seconds) is
        assumed.

     -N --no-speech
        Don't automatically start the speech synthesizer driver.  This
        option is unfortunately necessary on some systems when BRLTTY is
        started before the sound subsystem within the kernel has been
        initialized.

     -P[4mfile[24m --pid-file=[4mfile[0m
        Specify the file wherein BRLTTY is to write its process
        identifier (pid).  If not specified, BRLTTY doesn't write its
        process identifier anywhere.

     -S[[4mdriver[24m:][4mname[24m=[4mvalue[24m,... --speech-parame-
        ters=[[4mdriver[24m:][4mname[24m=[4mvalue[24m,...
        Specify parameters for the speech synthesizer drivers.  If the
        same parameter is specified more than once, then its rightmost
        assignment is used.  If a parameter name is qualified by a
        driver (see section ``Driver Identification Codes'') then that
        setting only applies to that driver; if it isn't then it applies
        to all drivers.  For a description of the parameters accepted by
        a specific driver, please see the documentation for that driver.
        See the ``speech-parameters'' configuration file directive for
        the default run-time settings.

     -U[4mcsecs[24m --update-interval=[4mcsecs[0m
        Specify the interval (in hundredths of a second) at which the
        braille window is updated with new screen content.  If not
        specified, then 4 (40 milliseconds) is assumed.

     -V --version
        Display the current versions of BRLTTY itself, of the server
        side of its application programming interface, and of those
        drivers which have been linked into its binary, and then exit.
        If the ``-q'' option isn't specified, then also display
        copyright information.

     -X[4mname[24m=[4mvalue[24m,... --screen-parameters=[4mname[24m=[4mvalue[24m,...
        Specify parameters for the screen driver.  If the same parameter
        is specified more than once, then its rightmost assignment is
        used.  For a description of the parameters accepted by a
        specific driver, please see the documentation for that driver.
        See the ``screen-parameters'' configuration file directive for
        the default run-time settings.


  [1m5.  Feature Descriptions[0m



  [1m5.1.  Cursor Routing[0m

  When moving the braille window around the screen while examining the
  text, say, in an editor, you often need to bring the cursor to a
  specific character within the braille window.  You'll probably find
  this to be a rather difficult task for a number of reasons.  One is
  that you may not know where the cursor is, and that you may lose your
  place while trying to find it.  Another is that the cursor may move
  unrpedictably as the arrow keys are pressed (some editors, for
  example, don't allow the cursor to be more to the right than the end
  of the line it's on).  Cursor routing provides just such a capability
  by knowing where the cursor is, by simulating the same arrow-key
  presses which you'd have to enter manually, and by monitoring the
  progress of the cursor as it moves.

  Some braille displays have a button, known as a routing key, above
  each cell.  These keys use the ``ROUTE'' command to route the cursor
  right to the desired location.

  Cursor routing, while very convenient and effective, is, strictly
  speaking, not completely reliable.  One reason for this is that its
  current implementation assumes VT100 cursor key escape sequences.
  Another is that some applications do non-standard things in response
  to detecting that a cursor key has been pressed.  A minor problem
  found within some editors (like vi), as already mentioned above, is
  that they throw in some unpredictable horizontal motion when vertical
  motion is requested because they don't allow the cursor to be to the
  right of the end of a line.  A major problem found within some web
  browsers (like lynx) is that the up- and down-arrow keys are used to
  move among the links (which may skip lines and/or move the cursor
  horizontally, but which rarely just moves the cursor one line in the
  desired direction), and that the left- and right-arrow keys are used
  to select links (which has absolutely nothing to do with any form of
  cursor motion whatsoever, and which even totally changes the screen
  content).

  Cursor routing may not work very well on a heavily loaded system, and
  definitely doesn't work very well when working on a remote system over
  a slow link.  This is so because of all of the checks which must be
  made along the way in order to deal with unpredictable cursor motion
  and in order to ensure that any mistake has at least a fighting chance
  to be undone.  Even  though BRLTTY tries to be fairly clever, it must
  still essentially wait to see what happens after each simulated arrow-
  key press.

  Once a cursor routing request has been made, BRLTTY keeps trying to
  route the cursor to the desired location until a timeout expires
  before the cursor reaches that location, the cursor seems to be moving
  in the wrong direction, or you switch to a different virtual terminal.
  An attempt is first made to use virtical motion to bring the cursor to
  the right line, and, only if that succeeds, an attempt is then made to
  use horizontal motion to bring the cursor to the right column.  If
  another request is made while one is still in progress, then the first
  one is aborted and the second one is initiated.

  A safer but less powerful cursor routing command, ``CSRJMP_VERT'',
  uses just vertical motion to bring the cursor to anywhere on the top
  line of the braille window.  It's especially useful in conjunction
  with applications (like lynx) wherein horizontal cursor motion must
  never be attempted.


  [1m5.2.  Cut and Paste[0m

  This feature enables you to grab some text which is already on the
  screen and re-enter it at the current cursor position.  Using it saves
  time and avoids errors when a long and/or complicated piece of text
  needs to be copied, and even when the same short and simple piece of
  text needs to be copied many times.  It's particularly useful for
  things like long file names, complicated command lines, E-mail
  addresses, and URLs. Cutting and pasting text involves three simple
  steps:

  1. Mark either the top-left corner of the rectangular area or the
     beginning of the linear area on the screen which is to be grabbed
     (cut).  If your display has routing keys, then move the braille
     window so that the first character to be cut appears anywhere
     within it, and then:

     ·  invoke the ``CUTBEGIN'' command to start a new cut buffer

     ·  invoke the ``CUTAPPEND'' command to append to the existing cut
        buffer

     by pressing the key(s) associated with it and then pressing the
     routing key associated with the character.

  2. Mark either the bottom-right corner of the rectangular area or the
     end of the linear area on the screen which is to be grabbed (cut).
     If your display has routing keys, then move the braille window so
     that the last character to be cut appears anywhere within it, and
     then

     ·  invoke the ``CUTRECT'' command to cut a rectangular area

     ·  invoke the ``CUTLINE'' command to cut a linear area

     by pressing the key(s) associated with it and then pressing the
     routing key associated with the character.  Marking the end of the
     cut area appends the selected screen content to the cut buffer.
     Excess white-space is removed from the end of each line in the cut
     buffer so that unwanted trailing spaces won't be pasted back in.
     Control characters are replaced with blanks.

  3. Insert (paste) the text where it's needed.  Place the cursor over
     the character where the text is to be pasted, and invoke the
     ``PASTE'' command.  You can paste the same text any number of times
     without recutting it.  This description assumes that you're already
     in some sort of input mode.  If you paste when you're in some other
     kind of mode (like vi's command mode), then you'd better be aware
     of what the characters in the cut buffer will do.

  The cut buffer is also used by the ``PRSEARCH/NXSEARCH'' commands.


  [1m5.3.  Pointer (Mouse) Support via GPM[0m

  If BRLTTY is configured with the ``--enable-gpm'' build option on a
  system where the gpm application has been installed, then it'll
  interact with the pointer (mouse).

  Moving the braille window moves the pointer (see the ``Pointer Follows
  Window'' preference).  Any motion of the braille window (manual,
  cursor tracking, etc.), other than when it moves in response to
  pointer motion, moves the pointer to the character on the screen which
  corresponds to the upper-left corner of the braille window.  This
  enables a sighted observer to see where the braille window is, and,
  therefore, to know what the braille user is reading.  It also keeps
  the pointer within the braille window so that it can be found easily,
  and so that the pointer device can always be readily used as another
  way to move the braille window.

  Moving the pointer drags the braille window (see the ``Window Follows
  Pointer'' preference).  Whenever the pointer is moved beyond the edge
  of the braille window, the braille window is dragged along (one
  character at a time).  This gives the braille user another two-
  dimensional way to inspect the screen content or to quickly move the
  braille window to a desired location.  It also gives a sighted
  observer an easy way to move the braille window to something he'd like
  the braille user to read.

  gpm uses reverse video to show where the pointer is.  Underlining of
  highlighted characters (see the ``ATTRVIS'' command for details)
  should be turned on, therefore, when the braille user wishes to use
  the pointer.

  This feature also gives the braille user access to gpm's cut-and-paste
  capability.  Although you should read gpm's own documentation, here
  are some notes on how it works.

  ·  Copy the current character to the cut buffer by single-clicking the
     left button.

  ·  Copy the current word (space-delimited) to the cut buffer by
     double-clicking the left button.

  ·  Copy the current line to the cut buffer by tripple-clicking the
     left button.

  ·  Copy a linear region to the cut buffer as follows:

     1. Place the pointer on the first character of the region.

     2. Press (and hold) the left button.

     3. Move the pointer to the last character of the region (all
        currently selected characters are highlighted).

     4. Release the left button.

  ·  Paste (input) the current contents of the cut buffer by clicking
     the middle button of a three-button mouse or by clicking the right
     button of a two-button mouse.

  ·  Append to the cut buffer by using the right button of a three-
     button mouse.


  [1m5.4.  Alert Tunes[0m

  BRLTTY alerts you to the occurrence of significant events by playing
  short predefined tunes.  This feature can be activated and deactivated
  with either the ``TUNES'' command or the ``Alert Tunes'' preference.
  The tunes are played via the internal beeper by default, but other
  alternatives can be selected with the ``Tune Device'' preference.

  Each significant event is associated, from highest to lowest priority,
  with one or more of the following:

     [1ma tune[0m
        If a tune has been associated with the event, if the ``Alert
        Tunes'' preference (see also the ``TUNES'' command) is active,
        and if the selected tune device (see the ``Tune Device''
        preference) can be opened, then the tune is played.

     [1ma dot pattern[0m
        If a dot pattern has been associated with the event, and if the
        ``Alert Dots'' preference is active, then the dot pattern is
        briefly displayed on every braille cell.  Some braille displays
        don't respond quickly enough for this mechanism to work
        effectively.

     [1ma message[0m
        If a message has been associated with the event, and if the
        ``Alert Messages'' preference is active, then it is displayed
        for a few seconds (see the ``-M'' command line option).

  These events include:

  ·  When the braille display driver starts or stops.

  ·  When a lengthy command completes.

  ·  When a command cannot be executed.

  ·  When a mark is set.

  ·  When the start or end of the cut block is set.

  ·  When a feature is activated or deactivated.


  ·  When cursor tracking is turned on or off.

  ·  When the screen image is frozen or unfrozen.

  ·  When the braille window wraps either down to the beginning of the
     next line or up to the end of the previous line.

  ·  When identical lines are skipped.

  ·  When a requested motion cannot be performed.

  ·  When cursor routing starts, finishes, or fails.


  [1m5.5.  Preferences Settings[0m

  When BRLTTY starts, it loads a file which contains your preferences
  settings.  The file doesn't need to exist, and is created the first
  time the settings are saved with the ``PREFSAVE'' command.  The most
  recently saved settings can be restored at any time with the
  ``PREFLOAD'' command.

  The name for this file is /etc/brltty-[4mdriver[24m.prefs.  where [4mdriver[24m is
  the two-letter ``driver identification code''.


  [1m5.5.1.  The Preferences Menu[0m

  The preferences settings are saved as binary data which, therefore,
  can't be edited by hand.  BRLTTY, however, has a simple menu from
  which you can easily change them.  This feature isn't available if the
  ``--disable-preferences-menu'' build option was specified.

  The meny is activated by the ``PREFMENU'' command.  The braille
  display briefly (see the ``-M'' command line option) shows the menu
  title, and then presents the current item and its current setting.


  [1m5.5.1.1.  Navigating the Menu[0m

  See ``Menu Navigation Commands'' for the full list of commands which
  enable you to select items and change settings within the menu.  For
  backward compatibility with old drivers, the window motion commands,
  which have modified meanings in this context, can also be used.

     TOP/BOT, TOP_LEFT/BOT_LEFT, PAGE_UP/PAGE_DOWN
        Go to the first/last item in the menu (same as
        ``MENU_FIRST_ITEM/MENU_LAST_ITEM'').

     LNUP/LNDN, PRDIFLN/NXDIFLN, CURSOR_UP/CURSOR_DOWN
        Go to the previous/next item in the menu (same as
        ``MENU_PREV_ITEM/MENU_NEXT_ITEM'').

     WINUP/WINDN, CHRLT/CHRRT, CURSOR_LEFT/CURSOR_RIGHT, BACK/HOME
        Decrement/increment the current menu item's setting (same as
        ``MENU_PREV_SETTING/MENU_NEXT_SETTING'').

  Notes:

  ·  The routing keys can also be used to select a setting for the
     current item.  If the item has numeric settings, then the entire
     row of routing keys acts as a scroll bar which covers the full
     range of valid values.  If the item has named settings, then the
     routing keys correspond ordinally with the settings.


  ·  Use the PREFLOAD command to undo all of the changes which were made
     since entering the menu.

  ·  Use the PREFMENU command (again) to leave the new settings in
     effect, exit the menu, and resume normal operation.  If the "Save
     Settings on Exit" item is set, then, in addition, the new settings
     are written to the preferences settings file.  Any command not
     recognized by the menu system also does these same things.


  [1m5.5.1.2.  The Menu Items[0m


     [1mSave on Exit[0m
        When exiting the preferences menu:

        [1mNo [22mDon't automatically save the preferences settings.

        [1mYes[0m
           Automatically save the preferences settings.

        The initial setting is No.

     [1mText Style[0m
        When displaying screen content (see the ``DISPMD'' command),
        show characters:

        [1m8-dot[0m
           With all eight dots.

        [1m6-dot[0m
           With only dots 1 through 6.  If a contraction table has been
           selected (see the ``-c'' command line option and the
           ``contraction-table'' configuration file directive), then it
           is used.

        This setting can also be changed with the ``SIXDOTS'' command.

     [1mSkip Identical Lines[0m
        When moving either up or down exactly one line with the
        ``LNUP/LNDN'' commands, as well as the line wrapping feature of
        the ``FWINLT/FWINRT'' and ``FWINLTSKIP/FWINRTSKIP'' commands:

        [1mNo [22mDon't skip passed lines which have the same content as the
           current line.

        [1mYes[0m
           Skip passed lines which have the same content as the current
           line.

        This setting can also be changed with the ``SKPIDLNS'' command.

     [1mSkip Blank Windows[0m
        When moving either left or right with the ``FWINLT/FWINRT''
        commands:

        [1mNo [22mDon't skip passed blank windows.

        [1mYes[0m
           Skip passed blank windows.

        This setting can also be changed with the ``SKPBLNKWINS'' com-
        mand.

     [1mWhich Blank Windows[0m
        If blank windows are to be skipped:
        [1mAll[0m
           Skip all of them.

        [1mEnd of Line[0m
           Only skip those which are at the end (on the right side) of a
           line.

        [1mRest of Line[0m
           Only skip those which are at the end (on the right side) of a
           line when reading forward, and at the beginning (on the left
           side) of a line when reading backward.

     [1mSliding Window[0m
        If the cursor is being tracked (see the ``CSRTRK'' command), and
        the cursor moves too close to (or beyond) either end of the
        braille window:

        [1mNo [22mHorizontally reposition the window such that its left end is
           a multiple of its width from the left edge of the screen.

        [1mYes[0m
           Horizontally reposition the window such that the cursor,
           while remaining on that side of the window, is nearer the
           centre.

        This setting can also be changed with the ``SLIDEWIN'' command.

     [1mEager Sliding Window[0m
        If the braille window is to slide:

        [1mNo [22mReposition it whenever the cursor moves beyond either end.

        [1mYes[0m
           Reposition it whenever the cursor moves too close to either
           end.

        The initial setting is off.

     [1mWindow Overlap[0m
        When moving either left or right with the ``FWINLT/FWINRT''
        commands, this setting specifies how many characters
        horizontally adjacent braille windows should overlap each other
        by.  The initial setting is 0.

     [1mAutorepeat[0m
        While the key (combination) for a command remains pressed:

        [1mNo [22mDon't automatically repeat the command.

        [1mYes[0m
           Automatically repeat the command at a regular interval after
           an initial delay.

        The following commands are eligible for autorepeating:

        ·  The ``LNUP/LNDN'' commands.

        ·  The ``PRDIFLN/NXDIFLN'' commands.

        ·  The ``CHRLT/CHRRT'' commands.

        ·  The Page-Up and Page-Down operations.

        ·  The Cursor-Up and Cursor-Down operations.


        ·  The Cursor-Left and Cursor-Right operations.

        ·  The Backspace and Delete operations.

        ·  Character entry.

        Only some drivers support this functionality, the primary limi-
        tation being that many braille displays don't signal both key
        presses and key releases as distinctly separate events.  This
        setting can also be changed with the ``AUTOREPEAT'' command.
        The initial setting is off.

     [1mAutorepeat Delay[0m
        When a character is to be autorepeated, this setting specifies
        the amount of time (see the note on ``time settings'' below)
        which must pass before autorepeating begins.  The initial
        setting is 50.

     [1mAutorepeat Interval[0m
        When a character is being autorepeated, this setting specifies
        the amount of time (see the note on ``time settings'' below)
        between each reexecution.  The initial setting is 10.

     [1mShow Cursor[0m
        When displaying screen content (see the ``DISPMD'' command):

        [1mNo [22mDon't show the cursor.

        [1mYes[0m
           Show the cursor.

        This setting can also be changed with the ``CSRVIS'' command.
        The initial setting is Yes.

     [1mCursor Style[0m
        When showing the cursor, represent it:

        [1mUnderline[0m
           With dots 7 and 8.

        [1mBlock[0m
           With all eight dots.

        This setting can also be changed with the ``CSRSIZE'' command.

     [1mBlinking Cursor[0m
        When the cursor is to be shown:

        [1mNo [22mLeave it visible all the time.

        [1mYes[0m
           Make it alternately visible and invisible according to a
           predefined interval.

        This setting can also be changed with the ``CSRBLINK'' command.

     [1mCursor Visible Time[0m
        When the cursor is to be blinked, this setting specifies the
        length of time (see the note on ``time settings'' below) during
        each cycle that it is to be visible.  The initial setting is 40.

     [1mCursor Invisible Time[0m
        When the cursor is to be blinked, this setting specifies the
        length of time (see the note on ``time settings'' below) during
        each cycle that it is to be invisible.  The initial setting is
        40.
     [1mShow Attributes[0m
        When displaying screen content (see the ``DISPMD'' command):

        [1mNo [22mDon't underline highlighted characters.

        [1mYes[0m
           Underline highlighted characters.

        This setting can also be changed with the ``ATTRVIS'' command.

     [1mBlinking Attributes[0m
        When highlighted characters are to be underlined:

        [1mNo [22mLeave the indicator visible all the time.

        [1mYes[0m
           Make the indicator alternately visible and invisible
           according to a predefined interval.

        This setting can also be changed with the ``ATTRBLINK'' command.

     [1mAttributes Visible Time[0m
        When the highlighted character underline is to be blinked, this
        setting specifies the length of time (see the note on ``time
        settings'' below) during each cycle that it is to be visible.
        The initial setting is 20.

     [1mAttributes Invisible Time[0m
        When the highlighted character underline is to be blinked, this
        setting specifies the length of time (see the note on ``time
        settings'' below) during each cycle that it is to be invisible.
        The initial setting is 60.

     [1mBlinking Capitals[0m
        When displaying screen content (see the ``DISPMD'' command):

        [1mNo [22mLeave capital letters visible all the time.

        [1mYes[0m
           Make capital letters alternately visible and invisible
           according to a predefined interval.

        This setting can also be changed with the ``CAPBLINK'' command.

     [1mCapitals Visible Time[0m
        When capital letters are to be blinked, this setting specifies
        the length of time (see the note on ``time settings'' below)
        during each cycle that they're to be visible.  The initial
        setting is 60.

     [1mCapitals Invisible Time[0m
        When capital letters are to be blinked, this setting specifies
        the length of time (see the note on ``time settings'' below)
        during each cycle that they're to be invisible.  The initial
        setting is 20.

     [1mBraille Firmness[0m
        Adjust the firmness (or stiffness) of the braille dots.  It can
        be set to:

        ·  Maximum

        ·  High

        ·  Medium

        ·  Low

        ·  Minimum

        This preference is only available if a driver which supports it
        is being used.  The initial setting is Medium.

     [1mWindow Follows Pointer[0m
        When moving the pointer device (mouse):

        [1mNo [22mDon't drag the braille window.

        [1mYes[0m
           Drag the braille window.

        This preference is only presented if the ``--enable-gpm'' build
        option was specified.

     [1mPointer Follows Window[0m
        When moving the braille window:

        [1mNo [22mDon't move the pointer (mouse).

        [1mYes[0m
           Move the pointer (mouse) to the character on the screen
           corresponding to the top-left corner of the braille window.

        This preference is only presented if the ``--enable-gpm'' build
        option was specified.

     [1mAlert Tunes[0m
        Whenever a significant event with an associated tune occurs (see
        ``Alert Tunes''):

        [1mNo [22mDon't play the tune.

        [1mYes[0m
           Play the tune.

        This setting can also be changed with the ``TUNES'' command.
        The initial setting is on.

     [1mTune Device[0m
        Play alert tunes via:

        [1mBeeper[0m
           The internal beeper (console tone generator).  This setting
           is supported on Linux, on OpenBSD, on FreeBSD, and on NetBSD.
           It's always safe to use, although it may be somewhat soft.
           This device isn't available if the ``--disable-beeper-
           support'' build option was specified.

        [1mPCM[0m
           The digital audio interface on the sound card.  This setting
           is supported on Linux (via /dev/dsp), on Solaris (via
           /dev/audio), on OpenBSD (via /dev/audio0), on FreeBSD (via
           /dev/dsp), and on NetBSD (via /dev/audio0).  It doesn't work
           when this device is already being used by another
           application.  This device isn't available if the ``--disable-
           pcm-support'' build option was specified.

        [1mMIDI[0m
           The Musical Instrument Digital Interface on the sound card
           This setting is supported on Linux (via /dev/sequencer).  It
           doesn't work when this device is already being used by
           another application.  This device isn't available if the
           ``--disable-midi-support'' build option was specified.

        [1mFM [22mThe FM synthesizer on an AdLib, OPL3, Sound Blaster, or
           equivalent sound card.  This setting is supported on Linux.
           It works even if the FM synthesizer is already being used by
           another application.  The results are unpredictable, and
           potentially not very good, if it's used with a sound card
           which doesn't support this feature.  This device isn't
           available if the ``--disable-fm-support'' build option was
           specified.

        The initial setting is beeper on those platforms which support
        it, and PCM on those platforms which don't.

     [1mMIDI Instrument[0m
        If the Musical Instrument Digital Interface (MIDI) of the sound
        card is being used to play the alert tunes, this setting
        specifies which instrument is to be used (see the ``MIDI
        Instrument Table'').  The initial setting is Acoustic Grand
        Piano.

     [1mAlert Dots[0m
        Whenever a significant event with an associated dot pattern
        occurs (see ``Alert Tunes''):

        [1mNo [22mDon't display the dot pattern.

        [1mYes[0m
           Briefly display the dot pattern.

        If alert tunes are to be played (see the ``TUNES'' command and
        the ``Alert Tunes'' preference), if a tune has been associated
        with the event, and if the selected tune device can be opened,
        then, regardless of the setting of this preference, the dot pat-
        tern isn't displayed.

     [1mAlert Messages[0m
        Whenever a significant event with an associated message occurs
        (see ``Alert Tunes''):

        [1mNo [22mDon't display the message.

        [1mYes[0m
           Display the message.

        If alert tunes are to be played (see the ``TUNES'' command and
        the ``Alert Tunes'' preference), if a tune has been associated
        with the event, and if the selected tune device can be opened,
        or if alert dot patterns are to be displayed (see the ``Alert
        Dots'' preference) and if a dot pattern has been associated with
        the event, then, regardless of the setting of this preference,
        the message isn't displayed.

     [1mSay-Line Mode[0m
        When using the ``SAY_LINE'' command:

        [1mImmediate[0m
           Discard pending speech.

        [1mEnqueue[0m
           Don't discard pending speech.

        The initial setting is immediate.

     [1mAutospeak[0m

        [1mNo [22mOnly speak when explicitly requested to do so.

        [1mYes[0m
           Automatically speak:

           ·  the new line when the braille window is moved vertically.

           ·  characters which are entered or deleted.

           ·  the character to which the cursor is moved.

        This setting can also be changed with the ``AUTOSPEAK'' command.
        The initial setting is off.

     [1mSpeech Rate[0m
        Adjust the speech rate (0 is the slowest, 20 is the fastest).
        This preference is only available if a driver which supports it
        is being used.  This setting can also be changed with the
        ``SAY_SLOWER/SAY_FASTER'' commands.  The initial setting is 10.

     [1mSpeech Volume[0m
        Adjust the speech volume (0 is the softest, 20 is the loudest).
        This preference is only available if a driver which supports it
        is being used.  This setting can also be changed with the
        ``SAY_SOFTER/SAY_LOUDER'' commands.  The initial setting is 10.

     [1mStatus Style[0m
        This setting specifies the way that the status cells are to be
        used.  You shuldn't normally need to play with it.  It enables
        BRLTTY's developers to test status cell configurations for
        braille displays which they don't actually have.

        [1mNone[0m
           Don't use the status cells.  This setting is always safe, but
           it's also quite useless.

        [1mAlva[0m
           The status cells contain:

           [1m1  [22mThe location of the cursor (see below).

           [1m2  [22mThe location of the top-left corner of the braille window
              (see below).

           [1m3  [22mA letter indicating BRLTTY's state.  In order of
              precedence:

              [1ma  [22mScreen attributes are being shown (see the ``DISPMD''
                 command).

              [1mf  [22mThe screen image is frozen (see the ``FREEZE''
                 command).

              [1mf  [22mThe cursor is being tracked (see the ``CSRTRK''
                 command).

              [4mblank[0m
                 Nothing special.

           The locations of the cursor and the braille window are pre-
           sented in an interesting way.  Dots 1 through 6 represent the
           line number with a letter from a (for 1) through y (for 25).
           Dots 7 and 8 (the extra two at the bottom) represent the hor-
           izontal braille window number as follows:


           [1mNo Dots[0m
              The first (leftmost) window.

           [1mDot 7[0m
              The second window.

           [1mDot 8[0m
              The third window.

           [1mDots 7 and 8[0m
              The fourth window.

           In both cases, the indicators wrap: line 26 is represented by
           the letter a, and the fifth horizontal braille window is rep-
           resented by no dots at the bottom.

        [1mTieman[0m
           The status cells contain:

           [1m1-2[0m
              The columns (counting from zero) of the cursor (shown in
              the top half of the cells) and the top-left corner of the
              braille window (shown in the bottom half of the cells).

           [1m3-4[0m
              The rows (counting from zero) of the cursor (shown in the
              top half of the cells) and the top-left corner of the
              braille window (shown in the bottom half of the cells).

           [1m5  [22mEach dot indicates if a feature is turned on as follows:

              [1mDot 1[0m
                 The screen image is frozen (see the ``FREEZE''
                 command).

              [1mDot 2[0m
                 Screen attributes are being displayed (see the
                 ``DISPMD'' command).

              [1mDot 3[0m
                 Alert tunes are being played (see the ``TUNES''
                 command).

              [1mDot 4[0m
                 The cursor is being shown (see the ``CSRVIS'' command).

              [1mDot 5[0m
                 The cursor is a solid block (see the ``CSRSIZE''
                 command).

              [1mDot 6[0m
                 The cursor is blinking (see the ``CSRBLINK'' command).

              [1mDot 7[0m
                 The cursor is being tracked (see the ``CSRTRK''
                 command).

              [1mDot 8[0m
                 The braille window will slide (see the ``SLIDEWIN''
                 command).

        [1mPowerBraille 80[0m
           The status cells contain:

           [1m1  [22mThe row (counting from 1) corresponding to the top of the
              braille window.  The tens digit is shown in the top half
              of the cell, and the units digit is shown in the bottom
              half of the cell.

        [1mGeneric[0m
           This setting passes a lot of information to the braille
           driver, and the driver itself decides how to present it.

        [1mMDV[0m
           The status cells contain:

           [1m1-2[0m
              The location of the top-left corner of the braille window.
              The row (counting from 1) is shown in the top half of the
              cells, and the column (counting from 1) is shown in the
              bottom half of the cells.

        [1mVoyager[0m
           The status cells contain:

           [1m1  [22mThe row (counting from 0) corresponding to the top of the
              braille window (see below).

           [1m2  [22mThe row (counting from 0) whereon the cursor is (see
              below).

           [1m3  [22mIf the screen is frozen (see the ``FREEZE'' command), then
              the letter F.  If it isn't, then the column (counting from
              0) wherein the cursor is (see below).

           Row and column numbers are shown as two digits within a sin-
           gle cell.  The tens digit is shown in the top half of the
           cell, and the units digit is shown in the bottom half of the
           cell.

        It's initial setting is braille display driver dependent.

     [1mText Table[0m
        Select the text translation table.  See section ``Text
        Translation'' for details.  See the ``-t'' command line option
        for the initial setting.  This preference isn't saved.  It isn't
        presented if the ``--disable-table-selection'' build option was
        specified.

     [1mAttributesw Table[0m
        Select the attributes translation table.  See section
        ``Attributes Translation'' for details.  See the ``-a'' command
        line option for the initial setting.  This preference isn't
        saved.  It isn't presented if the ``--disable-table-selection''
        build option was specified.

     [1mContraction Table[0m
        Select the contraction table.  See section ``Contracted
        Braille'' for details.  See the ``-c'' command line option for
        the initial setting.  This preference isn't saved.  It isn't
        presented if the ``--disable-table-selection'' build option was
        specified.

  Notes:

  ·   All time settings are in hundredths of a second.  They are
     multiples of the braille window update interval (see the ``-U''
     command line option) within the range 1 through 100.



  [1m5.6.  The Status Display[0m

  The status display is a summary of BRLTTY's current state which fits
  completely within the braille window.  Some braille displays have a
  set of status cells which are used to permanently display some of this
  information as well (see the documentation for your display's driver).
  The data presented by this display isn't static, and may change at any
  time in response to screen updates and/or BRLTTY commands.

  Use the ``INFO'' command to switch to the status display, and use it
  again to return to the screen.  The layout of the information
  contained therein is dependent on the size of the braille window.


  [1m5.6.1.  Displays with 21 Cells or More[0m

  Short pneumonics have been used, even though they're rather cryptic,
  in order to show the precise column layout.

       [4mwx[24m:[4mwy[24m [4mcx[24m:[4mcy[24m [4mvt[24m [4mtcmfdu[0m



     [4mwx[24m:[4mwy[0m
        The column and row (counting from 0) on the screen corresponding
        to the top-left corner of the braille window.

     [4mcx[24m:[4mcy[0m
        The column and row (counting from 0) on the screen corresponding
        to the position of the cursor.

     [4mvt[24m The number (counting from 1) of the current virtual terminal.

     [4mt[24m  The state of the cursor tracking feature (see the ``CSRTRK''
        command).

        [1mblank[0m
           Cursor tracking is off.

        t  Cursor tracking is on.

     [4mc[24m  The state of the cursor visibility features (see the ``CSRVIS''
        and ``CSRBLINK'' commands).

        [1mblank[0m
           The cursor isn't visible, and won't blink when made visible.

        b  The cursor isn't visible, and will blink when made visible.

        v  The cursor is visible, and isn't blinking.

        B  The cursor is visible, and is blinking.

     [4mm[24m  The current display mode (see the ``DISPMD'' command).

        t  Screen content (text) is being displayed.

        a  Screen highlighting (attributes) is being displayed.

     [4mf[24m  The state of the frozen screen feature (see the ``FREEZE''
        command).

        [1mblank[0m
           The screen isn't frozen.


        f  The screen is frozen.

     [4md[24m  The number of braille dots being used to display each character
        (see the ``SIXDOTS'' command).

        8  All eight dots are being used.

        6  Only dots 1 through 6 are being used.

     [4mu[24m  The state of the uppercase (capital letter) display features
        (see the ``CAPBLINK'' command).

        [1mblank[0m
           Uppercase letters don't blink.

        B  Uppercase letters blink.


  [1m5.6.2.  Displays with 20 Cells or Less[0m

  Short pneumonics have been used, even though they're rather cryptic,
  in order to show the precise column layout.

       [4mxxyys[24m [4mvt[24m [4mtcmfdu[0m



     [4mxx[24m The columns (counting from 0) on the screen corresponding to the
        position of the cursor (shown in the top half of the cells) and
        to the top-left corner of the braille window (shown in the
        bottom half of the cells).

     [4myy[24m The rows (counting from 0) on the screen corresponding to the
        position of the cursor (shown in the top half of the cells) and
        to the top-left corner of the braille window (shown in the
        bottom half of the cells).

     [4ms[24m  The settings of some of BRLTTY's features.  A feature is turned
        on if its corresponding dot is raised.

        [1mDot 1[0m
           Frozen screen image (see the ``FREEZE'' command).

        [1mDot 2[0m
           Display attributes (see the ``DISPMD'' command).

        [1mDot 3[0m
           Alert tunes (see the ``TUNES'' command).

        [1mDot 4[0m
           Visible cursor (see the ``CSRVIS'' command).

        [1mDot 5[0m
           Block cursor (see the ``CSRSIZE'' command).

        [1mDot 6[0m
           Blinking cursor (see the ``CSRBLINK'' command).

        [1mDot 7[0m
           Cursor tracking (see the ``CSRTRK'' command).

        [1mDot 8[0m
           Sliding window (see the ``SLIDEWIN'' command).

     [4mvt[24m The number (counting from 1) of the current virtual terminal.

     [4mt[24m  The state of the cursor tracking feature (see the ``CSRTRK''
        command).

        [1mblank[0m
           Cursor tracking is off.

        t  Cursor tracking is on.

     [4mc[24m  The state of the cursor visibility features (see the ``CSRVIS''
        and ``CSRBLINK'' commands).

        [1mblank[0m
           The cursor isn't visible, and won't blink when made visible.

        b  The cursor isn't visible, and will blink when made visible.

        v  The cursor is visible, and isn't blinking.

        B  The cursor is visible, and is blinking.

     [4mm[24m  The current display mode (see the ``DISPMD'' command).

        t  Screen content (text) is being displayed.

        a  Screen highlighting (attributes) is being displayed.

     [4mf[24m  The state of the frozen screen feature (see the ``FREEZE''
        command).

        [1mblank[0m
           The screen isn't frozen.

        f  The screen is frozen.

     [4md[24m  The number of braille dots being used to display each character
        (see the ``SIXDOTS'' command).

        8  All eight dots are being used.

        6  Only dots 1 through 6 are being used.

     [4mu[24m  The state of the uppercase (capital letter) display features
        (see the ``CAPBLINK'' command).

        [1mblank[0m
           Uppercase letters don't blink.

        B  Uppercase letters blink.


  [1m5.7.  Command Learn Mode[0m

  Command learn mode is an interactive way to learn what the keys on the
  braille display do.  It can be accessed either by the ``LEARN''
  command or via the ``brltest'' utility.  This feature isn't available
  if the ``--disable-learn-mode'' build option was specified.

  When this mode is entered, the message command learn mode is written
  to the braille display.  Then, as each key (or key combination) on the
  display is pressed, a short message describing its BRLTTY function is
  written.  This mode exits immediately if the key (or key combination)
  for the ``LEARN'' command is pressed.  It exits automatically, and the
  message done is written, if ten seconds elapse without any key on the
  display being pressed.  Note that some displays don't signal the
  driver and/or some drivers don't signal BRLTTY until all the keys are
  released.
  If a message is longer than the braille display is wide, then it's
  displayed in segments.  The length of each segment but the last is one
  less than the display's width, with the rightmost character on the
  display being set to a minus sign.  Each such segment remains on the
  display either for a few seconds (see the ``-M'' command line option)
  or until any key on the display is pressed.


  [1m6.  Translation Tables[0m

  BRLTTY uses two [1mtranslation tables [22mto govern the mapping from bytes to
  dot combinations.


  [1m6.1.  Text Translation[0m

  The first, and most important, is the text translation table.  BRLTTY
  is initially configured to use the ``North American Braille Computer
  Code'' (NABCC).  In addition to this default text translation table,
  several alternatives are provided:

     [1mbrf[0m
        good for viewing .brf files in text editor or pager

     [1mcz [22mCzech (iso-8859-2)

     [1mda [22mDanish (iso-8859-1)

     [1mde [22mGerman (iso-8859-1)

     [1mes [22mSpanish (iso-8859-1)

     [1mfi1[0m
        Finnish (iso-8859-1)

     [1mfi2[0m
        Finnish (iso-8859-1)

     [1mfr [22mFrench (iso-8859-1)

     [1mfr-cbifs[0m
        Code Braille Informatique Français Standard (iso-8859-1)

     [1mit [22mItalian (iso-8859-1)

     [1mnabcc[0m
        North American Braille Computer Code (iso-8859-1)

     [1mno-h[0m
        Norwegian and German (iso-8859-1)

     [1mno-p[0m
        Norwegian (iso-8859-1)

     [1mpl [22mPolish (iso-8859-2)

     [1mru [22mRussian (koi8-r)

     [1mse1[0m
        Swedish (iso-8859-1)

     [1mse2[0m
        Swedish (iso-8859-1)

     [1muk [22mUnited Kingdom English (iso-8859-1)

     [1mus [22mAmerican English (iso-8859-1)

     [1mvni[0m
        Vietnamese (iso-8859-1)

  See the ``-t'' command line option, the ``text-table'' configuration
  file directive, and the ``--with-text-table'' build option for details
  regarding how to use an alternate text translation table.


  [1m6.2.  Attributes Translation[0m

  The attributes translation table is used when BRLTTY is displaying
  screen attributes rather than screen content (see the ``DISPMD''
  command).  Each of the eight braille dots represents one of the eight
  VGA attribute bits.  The following attributes translation tables are
  provided:

     [1mattributes[0m
        The lefthand column represents the foreground colours:

        [1mDot 1[0m
           Red

        [1mDot 2[0m
           Green

        [1mDot 3[0m
           Blue

        [1mDot 7[0m
           Bright

        The righthand column represents the background colours:

        [1mDot 4[0m
           Red

        [1mDot 5[0m
           Green

        [1mDot 6[0m
           Blue

        [1mDot 8[0m
           Blink

        A dot is raised when its corresponding attribute bit is on.
        This is the default attributes translation table because it's
        the most intuitive.  One of its problems, though, is that it's
        difficult to discern the difference between normal (white on
        black) and reverse (black on white) video.

     [1mattrib[0m
        The lefthand column represents the foreground colours:

        [1mDot 1[0m
           Red

        [1mDot 2[0m
           Green

        [1mDot 3[0m
           Blue


        [1mDot 7[0m
           Bright

        The righthand column represents the background colours:

        [1mDot 4[0m
           Red

        [1mDot 5[0m
           Green

        [1mDot 6[0m
           Blue

        [1mDot 8[0m
           Blink

        A background bit being on triggers its corresponding dot,
        whereas a foreground bit being off triggers its corresponding
        dot.  This unintuitive logic actually makes it easier to read
        the most commonly used attribute combinations.

  See the ``-a'' command line option, the ``attributes-table'' configu-
  ration file directive, and the ``--with-attributes-table'' build
  option for details regarding how to use an alternate attributes trans-
  lation table.


  [1m6.3.  Table Format[0m

  A translation table consists of a sequence of directives, one per
  line, which define how each possible byte value is to be represented
  in braille.  White-space (blanks, tabs) at the beginning of a line, as
  well as before and/or after any operand of any directive, is ignored.
  Lines containing only white-space are ignored.  If the first non-
  white-space character of a line is "#" then that line is a comment and
  is ignored.

  The following directives are provided:

     byte [4mbyte[24m [4mdots[24m # [4mcomment[0m
        Use the byte directive to specify how a byte (character) is to
        be represented in braille.  See the text translation tables for
        examples of its use.  Since this is by far the most commonly
        used directive, the byte keyword itself is optional.


        [4mbyte[0m
           The byte being defined.  It may be:

           ·  Any single character other than a backslash or a white-
              space character.

           ·  A backslash-prefixed special character.  These are:

              [1m\\ [22mA literal backslash.

              [1m\# [22mA literal number sign.

              [1m\x##[0m
                 The two-digit hexadecimal representation of any
                 character.

              [1m\X##[0m
                 ... (the case of the X and of the digits isn't
                 significant)
        [4mdots[0m
           The braille representation of the byte.  It is a sequence of
           one to eight dot numbers.  If the dot number sequence is
           enclosed within parentheses then the dot numbers may be
           separated from one another by white-space.  A dot number is a
           digit within the range 1-8 as defined by the ``Standard
           Braille Dot Numbering Convention''.  The special dot number 0
           is recognized when not enclosed within parentheses, and means
           no dots; it may not be used in conjunction with any other dot
           number.

        Examples:

        ·  byte a 1

        ·  b 12

        ·  c (14)

        ·  d ( 1  4   5    )

        ·  \\ 12567

        ·  \x20 0

     dot [4mdot[24m [4mstate[24m # [4mcomment[0m
        Use the dot directive to specify how the undefined bytes are to
        be represented in braille.  See the attributes translation
        tables for examples of its use.  The default is that all dots
        are on.


        [4mdot[0m
           The dot being defined.  It is a single digit within the range
           1-8 as defined by the ``Standard Braille Dot Numbering
           Convention''.

        [4mstate[0m
           When the dot is raised.  It may be:

           on The dot is raised.

           off
              The dot isn't raised.

           =[4mbit[0m
              The dot is raised if the named bit is on (set to 1).

           ~[4mbit[0m
              The dot is raised if the named bit is off (set to 0).

           The names of the bits are:

           [1m0X01[0m
              fg-blue

           [1m0X02[0m
              fg-green

           [1m0X04[0m
              fg-red

           [1m0X08[0m
              fg-bright


           [1m0X10[0m
              bg-blue

           [1m0X20[0m
              bg-green

           [1m0X40[0m
              bg-red

           [1m0X80[0m
              blink

        Examples:

        ·  dot 1 on

        ·  dot 2 off

        ·  dot 3 =fg-red

        ·  dot 4 ~bg-blue


  [1m7.  Contracted Braille[0m

  BRLTTY can display in-line contracted braille.  It does this if:

  ·  A contraction table has been selected.  See the ``-c'' command line
     option and the ``contraction-table'' configuration file directive
     for details.

  ·  The 6-dot braille feature has been activated.  See the ``SIXDOTS''
     command and the ``Text Style'' preference for details.

     This feature isn't available if the ``--disable-contracted-
     braille'' build option was specified.

  The following contraction tables are provided:

     [1mbig5[0m
        Chinese

     [1mcompress[0m
        Remove excessive white-space.

     [1men-us-g2[0m
        Grade 2 American English.

     [1mfr-abrege[0m
        Contracted Unified French.

     [1mfr-integral[0m
        Uncontracted Unified French.


  [1m7.1.  File Format[0m

  Blank lines are ignored.  Any leading and trailing white-space (any
  number of blanks and/or tabs) is ignored.  Lines which begin with a
  number sign (#) are ignored, i.e. they're comments.

       # This is a comment.


  All other lines define table entries.

  The general form of a table entry is an opcode followed by its
  operands.  The opcode and its operands are separated from one another
  by white-space.  Each opcode has a specific number of operands, and
  any text following its last operand is treated as a comment.

       [4mopcode[24m [4moperand[24m ... [4mcomment[0m


  The following operand types are supported:

     [1mstring[0m
        A sequence of characters other than white-space (which
        terminates the string) and backslashes (\).  The following
        special representations are also supported:

        \\ backslash

        \f form feed

        \n new line

        \o[4mooo[0m
           3-digit octal value

        \r carriage return

        \s blank (space)

        \t horizontal tab

        \v vertical tab

        \x[4mxx[0m
           2-digit hexadecimal value

     [1mnumber[0m
        An integer.  It may be specified in any of the following ways:

        [1mdecimal[0m
           A sequence of decimal digits (0-9), with the first digit
           being nonzero (1-9).

        [1mhexadecimal[0m
           A sequence of hexadecimal digits (0-9, and either a-f or A-
           F), preceded by either 0x or 0X.

        [1moctal[0m
           A sequence of octal digits (0-7), with the first digit being
           zero (0).

     [1mdots[0m
        A braille symbol.  The braille dots must be specified via their
        standard numbers (see section ``Standard Braille Dot Numbering
        Convention''), and, for a multi-cell symbol, the cell
        specifications must be separated from one another by a dash (-).
        For example, the contraction for the English word lord (the
        letter l prefixed with dot 5) would be specified as 5-123.  A
        space may be specified via the special dot number 0.


  [1m7.2.  Opcodes[0m

  An opcode is a keyword which tells the translator how to interpret the
  operands.  The opcodes are grouped here by function.


  [1m7.2.1.  Table Administration[0m

  These opcodes make it easier to write contraction tables.  They have
  no direct effect on the character translation.

     include [4mpath[0m
        Include the contents of another file.  Nesting can be to any
        depth.  Relative paths are anchored at the directory of the
        including file.

     locale [4mlocale[0m
        Define the locale for character interpretation (lowercase,
        uppercase, numeric, etc.).  The locale may be specified as:

        [4mlanguage[24m[1m[[22m_[4mcountry[24m][.[4mcharset[24m][@[4mmodifier[24m]
           The [4mlanguage[24m component is required and should be a two-letter
           ISO-639 language code.  The [4mcountry[24m component is optional and
           should be a two-letter ISO-3166 country code.  The [4mcharset[0m
           component is optional and should be a character set name,
           e.g. ISO-8859-1.

        [1mC  [22m7-bit ASCII.

        [1m-  [22mNo locale.

        The last locale specification applies to the entire table.  If
        this opcode isn't used then the C locale is assumed.


  [1m7.2.2.  Special Symbol Definition[0m

  These opcodes define special symbols which must be inserted into the
  braille text in order to clarify it.

     capsign [4mdots[0m
        The symbol which capitalizes a single letter.

     begcaps [4mdots[0m
        The symbol which begins a block of capital letters within a
        word.

     endcaps [4mdots[0m
        The symbol which ends a block of capital letters within a word.

     letsign [4mdots[0m
        The symbol which marks a letter which isn't part of a word.

     numsign [4mdots[0m
        The symbol which marks the beginning of a number.


  [1m7.2.3.  Character Translation[0m

  These opcodes define the braille representations for character
  sequences.  Each of them defines an entry within the contraction
  table.  These entries may be defined in any order except, as noted
  below, when they define alternate representations for the same
  character sequence.

  Each of these opcodes has a [4mcharacters[24m operand (which must be
  specified as a [4mstring[24m), and a built-in condition governing its
  eligibility for use.  The text is processed strictly from left to
  right, character by character, with the most eligible entry for each
  position being used.  If there's more than one eligible entry for a
  given position, then the one with the longest character string is
  used.  If there's more than one eligible entry for the same character
  string, then the one defined nearest to the beginning of the table is
  used (this is the only order dependency).

  Many of these opcodes have a [4mdots[24m operand which defines the braille
  representation for its [4mcharacters[24m operand.  It may also be specified
  as an equals sign (=), in which case it means one of two things.  If
  the entry is for a single character, then it means that the currently
  selected computer braille representation (see the ``-t'' command line
  option and the ``text-table'' configuration file directive) for that
  character is to be used.  If it's for a multi-character sequence, then
  the default representation for each character (see ``always'') within
  the sequence is to be used.

  Some special terms are used within the descriptions of these opcodes.

     [1mword[0m
        A maximal sequence of one or more consecutive letters.

  Now, finally, here are the opcode descriptions themselves:

     literal [4mcharacters[0m
        Translate the entire white-space-bounded containing character
        sequence into computer braille (see the ``-t'' command line
        option and the ``text-table'' configuration file directive).

     replace [4mcharacters[24m [4mcharacters[0m
        Replace the first set of characters, no matter where they
        appear, with the second.  The replaced characters aren't
        reprocessed.

     always [4mcharacters[24m [4mdots[0m
        Translate the characters no matter where they appear.  If
        there's only one character, then, in addition, define the
        default representation for that character.

     repeated [4mcharacters[24m [4mdots[0m
        Translate the characters no matter where they appear.  Ignore
        any consecutive repetitions of the same sequence.

     largesign [4mcharacters[24m [4mdots[0m
        Translate the characters no matter where they appear.  Remove
        white-space between consecutive words matched by this opcode.

     word [4mcharacters[24m [4mdots[0m
        Translate the characters if they're a word.

     joinword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're a word.  Remove the
        following white-space if the first character after it is a
        letter.

     lowword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're a white-space-bounded word.

     contraction [4mcharacters[0m
        Prefix the characters with a letter sign (see ``letsign'') if
        they're a word.

     sufword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're either a word or at the
        beginning of a word.

     prfword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're either a word or at the end
        of a word.

     begword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're at the beginning of a word.

     begmidword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're either at the beginning or
        in the middle of a word.

     midword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're in the middle of a word.

     midendword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're either in the middle or at
        the end of a word.

     endword [4mcharacters[24m [4mdots[0m
        Translate the characters if they're at the end of a word.

     prepunc [4mcharacters[24m [4mdots[0m
        Translate the characters if they're part of punctuation at the
        beginning of a word.

     postpunc [4mcharacters[24m [4mdots[0m
        Translate the characters if they're part of punctuation at the
        end of a word.

     begnum [4mcharacters[24m [4mdots[0m
        Translate the characters if they're at the beginning of a
        number.

     midnum [4mcharacters[24m [4mdots[0m
        Translate the characters if they're in the middle of a number.

     endnum [4mcharacters[24m [4mdots[0m
        Translate the characters if they're at the end of a number.


  [1m7.2.4.  Character Classes[0m

  These opcodes define and use character classes.  A character class
  associates a set of characters with a name.  The name then refers to
  any character within the class.  A character may belong to more than
  one class.

  The following character classes are automatically predefined basdd on
  the selected locale:

     [1mdigit[0m
        Numeric characters.

     [1mletter[0m
        Both uppercase and lowercase alphabetic characters.  Some
        locales have additional letters which are neither uppercase nor
        lowercase.

     [1mlowercase[0m
        Lowercase alphabetic characters.

     [1mpunctuation[0m
        Printable characters which are neither white-space nor
        alphanumeric.

     [1mspace[0m
        White-space characters.  In the default locale these are: space,
        horizontal tab, vertical tab, carriage return, new line, form
        feed.

     [1muppercase[0m
        Uppercase alphabetic characters.

  The opcodes which define and use character classes are:

     class [4mname[24m [4mcharacters[0m
        Define a new character class.  The [4mcharacters[24m operand must be
        specified as a [4mstring[24m.  A character class may not be used until
        it's been defined.

     after [4mclass[24m [4mopcode[24m ...
        The specified opcode is further constrained in that the matched
        character sequence must be immediately preceded by a character
        belonging to the specified class.  If this opcode is used more
        than once on the same line then the union of the characters in
        all the classes is used.

     before [4mclass[24m [4mopcode[24m ...
        The specified opcode is further constrained in that the matched
        character sequence must be immediately followed by a character
        belonging to the specified class.  If this opcode is used more
        than once on the same line then the union of the characters in
        all the classes is used.


  [1m8.  Advanced Topics[0m



  [1m8.1.  Installing Multiple Versions[0m

  It's easy to have more than one version of BRLTTY installed on the
  same system at the same time.  This capability allows you to test a
  new version before removing the old one.

  The ``--with-execute-root'' build option allows you to install the
  complete ``installed file hierarchy'' anywhere you want such that it's
  entirely self-contained.  Remembering that it's best to keep all of
  BRLTTY's components within the root file system, you can build it like
  this:


       ./configure --with-execute-root=/brltty-3.1
       make install



  You can then run it like this:

       /brltty-3.1/bin/brltty


  When version 3.2 is released, just install it in a different location
  and run the new executable from there.


       ./configure --with-execute-root=/brltty-3.2
       make install
       /brltty-3.2/bin/brltty



  So far, this paradigm is somewhat awkward for at least two reasons.
  One is that these long path names are too hard to type, and the other
  is that you don't want to fiddle with your system's boot sequence each
  time you want to switch to a different version of BRLTTY.  These
  problems are easily solved by adding a symbolic link for the
  executable.

       ln -s /brltty-3.1/bin/brltty /bin/brltty


  When it's time to switch to the newer version, just repoint the sym-
  bolc link.

       ln -s /brltty-3.2/bin/brltty /bin/brltty


  If you'd like to get really fancy, then introduce another level of
  indirection in order to make all of BRLTTY's files for any given
  version look like they're in all of the standard places.  First,
  create a symbolic link through a common repointable location from each
  of BRLTTY's standard locations.


       ln -s /brltty/bin/brltty /bin/brltty
       ln -s /brltty/etc/brltty /etc/brltty
       ln -s /brltty/lib/brltty /lib/brltty



  Then all you need to do is to point /brltty to the desired version.

       ln -s /brltty-3.1 /brltty



  [1m8.2.  Installation/Rescue Root Disks for Linux[0m

  BRLTTY can run as a stand-alone executable.  Everything it needs to
  know can be explicitly configured at build-time (see ``Build
  Options'').  If the data directory (see the ``--with-data-directory''
  and ``--with-execute-root'' build options) doesn't exist, then BRLTTY
  looks in /etc for the files it needs.  Even if any of these files
  don't exist at all, BRLTTY still works!

  If, for some reason, you ever create the data directory (usually
  /etc/brltty) by hand, it's important to set its permissions so that
  only root can create files within it.

       chmod 755 /etc/brltty


  The screen content inspection device (usually /dev/vcsa) is required.
  It should already exist unless your Linux distribution is quite old.
  If necessary, you can create it with:


       mknod /dev/vcsa c 7 128
       chmod 660 /dev/vcsa
       chown root.tty /dev/vcsa



  One problem often encountered when trying to use BRLTTY in an
  uncertain environment like a root disk or an incomplete system is that
  it might not find the shared libraries (or parts thereof) which it
  needs.  Root disks often use subset and/or outdated versions of the
  libraries which may be inadequate.  The solution is to configure
  BRLTTY with the ``--enable-standalone-programs'' build option.  This
  removes all dependencies on shared libraries, but, unfortunately, also
  creates a larger executable.  There are a number of build options
  which can be used to selectively remove unneeded features from BRLTTY
  in order to somewhat mitigate this problem (see section ``Build
  Features'').

  The executable is stripped during the ``make install''.  This
  significantly reduces its size by removing its symbol table.  You'll
  get a much smaller executable, therefore, if you complete the full
  build procedure, and then copy it from its installed location.  If,
  however, you copy it from the build directory, it'll be way too big.
  Don't forget to strip it.

       strip brltty



  [1m8.3.  Future Enhancements[0m

  Apart from fixing bugs and supporting more types of braille displays,
  we hope, time permitting, to work on the following:

     [1mBetter Attribute Handling[0m

        ·  Attribute tracking.

        ·  Mixed text and attribute mode.

     [1mScroll Tracking[0m
        Locking the braille window to one line as it scrolls on the
        screen.

     [1mBetter Speech Support[0m

        ·  Mixed braille and speech for faster reading of text.

        ·  Better speech navigation.

        ·  More speech synthesizers.

     [1mScreen Subregions[0m
        Ignore cursor motion outside the region, and set soft
        navigational boundaries at the edges of the region.

  See the file TODO for a more complete list.


  [1m8.4.  Known Bugs[0m

  At the time of writing (December 2001), the following problems are
  known:

  Cursor routing is implemented as a looping sub-process which runs at
  reduced priority to avoid using too much cpu time.  Different system
  loads require different settings of its parameters.  The defaults work
  very well in a typical Unix editor on a fairly lightly loaded system,
  but very poorly in some other situations, e.g. over a slow serial link
  to a remote host.


  [1mA.  Supported Braille Displays[0m

  BRLTTY supports the following braille displays:


        Name                Models
        ________________________________________________________________
        Albatross           46/80
        Alva                ABT (3nn)
                            Delphi (4nn)
                            Satellite (5nn)
        BrailleLite         18/40/M20/M40
        BrailleNote         18/32
        CombiBraille        25/45/85
        EcoBraille          20/40/80
        EuroBraille         AzerBraille
                            Clio
                            Iris
                            NoteBraille
                            Scriba
        FreedomScientific   Focus 44/70/84
                            PAC Mate 20/40
        HandyTech           Modular 20/40/80
                            Braille Wave 40
                            Braille Star 40/80
                            Bookworm
                            Braillino 20
        LogText             32
        MDV                 MB208/MB408L/MB408S (protocol 5)
        MiniBraille         20
        MultiBraille        MB125CR/MB145CR/MB185CR
        Papenmeier          Tiny
                            Compact
                            2D Lite/Screen
                            EL2D 40/66/80
                            EL 40/80
                            EL 40 P
                            Elba 20/32
                            IB 80
                            II EL 40/66/80 S
        TSI                 Navigator 20/40/80
                            PowerBraille 40/65/80
        TTY                 terminfo
        Vario               40/80 (native mode)
        VarioHT             40 (Vario in HandyTech emulation mode)
        VideoBraille        40
        Virtual             TCP/Unix, client/server
        VisioBraille        20/40
        Voyager             44/70
        XWindow             X11

  [1mB.  Supported Speech Synthesizers[0m

  BRLTTY supports the following speech synthesizers:

           Name             Models
           _____________________________________________________________
           Alva             Delphi (4nn)
           BrailleLite
           CombiBraille
           ExternalSpeech   runs /usr/local/bin/externalspeech
           Festival         text to speech engine
           FestivalLite     text to speech engine
           GenericSay       pipes to /usr/local/bin/say
           Mikropuhe        text to speech engine
           Theta            text to speech engine
           ViaVoice         text to speech engine



  [1mC.  Driver Identification Codes[0m


                     Code   Name
                     ___________________________________________________
                     al     Alva
                     at     Albatross
                     bl     BrailleLite
                     bn     BrailleNote
                     cb     CombiBraille
                     ec     EcoBraille
                     es     ExternalSpeech
                     eu     EuroBraille
                     fl     FestivalLite
                     fs     FreedomScientific
                     fv     Festival
                     gs     GenericSay
                     ht     HandyTech
                     lt     LogText
                     mb     MultiBraille
                     md     MDV
                     mn     MiniBraille
                     mp     Mikropuhe
                     no     no driver
                     pm     Papenmeier
                     th     Theta
                     ts     Telesensory Systems Inc.
                     tt     TTY
                     va     Vario/RBT (emulation 1)
                     vd     VideoBraille
                     vh     Vario/RBT (emulation 2)
                     vo     Voyager
                     vr     Virtual
                     vs     VisioBraille
                     vv     ViaVoice
                     xw     XWindow



  [1mD.  Operand Syntax[0m



  [1mD.1.  Driver Specificationn[0m

  A braille display or speech synthesizer driver must be specified via
  its two-letter ``driver identification code''.

  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.

  If the single word auto is specified then autodetection is performed
  using only those drivers which are known to be reliable for this
  purpose.


  [1mD.2.  Braille Device Specificationn[0m

  The general form of a braille device specification (see the ``-d''
  command line option, the ``braille-device'' configuration file
  directive, and the ``--with-braille-device'' build option) is
  qualifier:[4mdata[24m.  For backward compatibility with earlier releases, if
  the qualifier is omitted then serial: is assumed.

  The following device types are supported:

     [1mBluetooth[0m
        For a bluetooth device, specify bluez:[4maddress[24m.  The address must
        be six two-digit hexadecimal numbers separated by colons, e.g.
        01:23:45:67:89:AB.

     [1mSerial[0m
        For a serial device, specify serial:[4m/path/to/device[24m.  The
        serial: qualifier is optional (for backward compatibility).  If
        a relative path is given then it's anchored at /dev (the usual
        location where devices are defined on a Unix-like system).  The
        following device specifications all refer to the first serial
        device on Linux:

        ·  serial:/dev/ttyS0

        ·  serial:ttyS0

        ·  /dev/ttyS0

        ·  ttyS0

     [1mUSB[0m
        For a USB device, specify usb:.  BRLTTY 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. usb:12345.  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.

  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 interrface, e.g. both a serial and a USB
  port.  In this case it's usually better to list the USB port first,
  e.g. usb:,serial:/dev/ttyS0, since the former tends to autodetect more
  reliably than the latter.


  [1mD.3.  PCM Device Specificationn[0m

  In most cases the PCM device is the full path to an appropriate system
  device.  Exceptions are:

     [1mALSA[0m
        The name of and arguments for the physical or logical device,
        i.e. [4mname[24m[:[4margument[24m,...].

  The default PCM device is:

                 Platform     Device
                 _______________________________________________________
                 FreeBSD      /dev/dsp
                 Linux/ALSA   hw:0,0
                 Linux/OSS    /dev/dsp
                 NetBSD       /dev/audio
                 OpenBSD      /dev/audio
                 Qnx          preferred PCM output device
                 Solaris      /dev/audio



  [1mD.4.  MIDI Device Specificationn[0m

  In most cases the MIDI device is the full path to an appropriate
  system device.  Exceptions are:

     [1mALSA[0m
        The client and port separated by a colon, i.e. [4mclient[24m:[4mport[24m.
        Each may be specified either as a number or as a case-sensitive
        substring of its name.

  The default MIDI device is:

            Platform     Device
            ____________________________________________________________
            Linux/ALSA   the first available MIDI output port
            Linux/OSS    /dev/sequencer



  [1mE.  Standard Braille Dot Numbering Convention[0m

  A standard braille cell consists of six dots arranged in three rows
  and two columns.  Each dot can be specifically identified by its
  number as follows:

     [1m1  [22mTop-left (row 1, column 1).

     [1m2  [22mMiddle-left (row 2, column 1).

     [1m3  [22mBottom-left (row 3, column 1).

     [1m4  [22mTop-right (row 1, column 2).

     [1m5  [22mMiddle-right (row 2, column 2).

     [1m6  [22mBottom-right (row 3, column 2).

  Computer braille has introduced a fourth row at the bottom.

     [1m7  [22mBelow-left (row 4, column 1).

     [1m8  [22mBelow-right (row 4, column 2).

  Perhaps a picture will make this numbering convention easier to
  understand.


       1 o o 4
       2 o o 5
       3 o o 6
       7 o o 8



  [1mF.  North American Braille Computer Code[0m



    Num Hex     Dots     Description
  +-----------------------------------------------------------------+
  |   0  00  [7   4  8]  NUL (null)                                 |
  |   1  01  [7  1   8]  SOH (start of header)                      |
  |   2  02  [7 21   8]  STX (start of text)                        |
  |   3  03  [7  14  8]  ETX (end of text)                          |
  |   4  04  [7  145 8]  EOT (end of transmission)                  |
  |   5  05  [7  1 5 8]  ENQ (enquiry)                              |
  |   6  06  [7 214  8]  ACK (acknowledge)                          |
  |   7  07  [7 2145 8]  BEL (bell)                                 |
  |   8  08  [7 21 5 8]  BS (back space)                            |
  |   9  09  [7 2 4  8]  HT (horizontal tab)                        |
  |  10  0A  [7 2 45 8]  LF (line feed)                             |
  |  11  0B  [73 1   8]  VT (vertical tab)                          |
  |  12  0C  [7321   8]  FF (form feed)                             |
  |  13  0D  [73 14  8]  CR (carriage return)                       |
  |  14  0E  [73 145 8]  SO (shift out)                             |
  |  15  0F  [73 1 5 8]  SI (shift in)                              |
  |  16  10  [73214  8]  DLE (data link escape)                     |
  |  17  11  [732145 8]  DC1 (direct control 1)                     |
  |  18  12  [7321 5 8]  DC2 (direct control 2)                     |
  |  19  13  [732 4  8]  DC3 (direct control 3)                     |
  |  20  14  [732 45 8]  DC4 (direct control 4)                     |
  |  21  15  [73 1  68]  NAK (negative acknowledge)                 |
  |  22  16  [7321  68]  SYN (synchronize)                          |
  |  23  17  [7 2 4568]  ETB (end of text block)                    |
  |  24  18  [73 14 68]  CAN (cancel)                               |
  |  25  19  [73 14568]  EM (end of medium)                         |
  |  26  1A  [73 1 568]  SUB (substitute)                           |
  |  27  1B  [7 2 4 68]  ESC (escape)                               |
  |  28  1C  [7 21 568]  FS (file separator)                        |
  |  29  1D  [7 214568]  GS (group separator)                       |
  |  30  1E  [7   45 8]  RS (record separator)                      |
  |  31  1F  [7   4568]  US (unit separator)                        |
  |  32  20  [        ]  space                                      |
  |  33  21  [ 32 4 6 ]  exclamation point                          |
  |  34  22  [     5  ]  quotation mark                             |
  |  35  23  [ 3  456 ]  number sign                                |
  |  36  24  [  214 6 ]  dollar sign                                |
  |  37  25  [   14 6 ]  percent sign                               |
  |  38  26  [ 3214 6 ]  ampersand                                  |
  |  39  27  [ 3      ]  acute accent                               |
  |  40  28  [ 321 56 ]  left parenthesis                           |
  |   4  291  [ 32 456 ) right parenthesis                          |
  |  42  2A  [   1  6 ]  asterisk                                   |
  |  43  2B  [ 3  4 6 ]  plus sign                                  |
  |  44  2C  [      6 ]  comma                                      |
  |  45  2D  [ 3    6 ]  minus sign                                 |
  |  46  2E  [    4 6 ]  period                                     |
  |  47  2F  [ 3  4   ]  forward slash                              |
  |  48  30  [ 3   56 ]  zero                                       |
  |  49  31  [  2     ]  one                                        |
  |  50  32  [ 32     ]  two                                        |
  |  51  33  [  2  5  ]  three                                      |
  |  52  34  [  2  56 ]  four                                       |
  |  53  35  [  2   6 ]  five                                       |
  |  54  36  [ 32  5  ]  six                                        |
  |  55  37  [ 32  56 ]  seven                                      |
  |  56  38  [ 32   6 ]  eight                                      |
  |  57  39  [ 3   5  ]  nine                                       |
  |  58  3A  [   1 56 ]  colon                                      |
  |  59  3B  [     56 ]  semicolon                                  |
  |  60  3C  [  21  6 ]  less-than sign                             |
  |  61  3D  [ 321456 ]  equals sign                                |
  |  62  3E  [ 3  45  ]  greater-than sign                          |
  |  63  3F  [   1456 ]  question mark                              |
  |  64  40  [7   4   ]  commercial at                              |
  |  65  41  [7  1    ]  capital a                                  |
  |  66  42  [7 21    ]  capital b                                  |
  |  67  43  [7  14   ]  capital c                                  |
  |  68  44  [7  145  ]  capital d                                  |
  |  69  45  [7  1 5  ]  capital e                                  |
  |  70  46  [7 214   ]  capital f                                  |
  |  71  47  [7 2145  ]  capital g                                  |
  |  72  48  [7 21 5  ]  capital h                                  |
  |  73  49  [7 2 4   ]  capital i                                  |
  |  74  4A  [7 2 45  ]  capital j                                  |
  |  75  4B  [73 1    ]  capital k                                  |
  |  76  4C  [7321    ]  capital l                                  |
  |  77  4D  [73 14   ]  capital m                                  |
  |  78  4E  [73 145  ]  capital n                                  |
  |  79  4F  [73 1 5  ]  capital o                                  |
  |  80  50  [73214   ]  capital p                                  |
  |  81  51  [732145  ]  capital q                                  |
  |  82  52  [7321 5  ]  capital r                                  |
  |  83  53  [732 4   ]  capital s                                  |
  |  84  54  [732 45  ]  capital t                                  |
  |  85  55  [73 1  6 ]  capital u                                  |
  |  86  56  [7321  6 ]  capital v                                  |
  |  87  57  [7 2 456 ]  capital w                                  |
  |  88  58  [73 14 6 ]  capital x                                  |
  |  89  59  [73 1456 ]  capital y                                  |
  |  90  5A  [73 1 56 ]  capital z                                  |
  |  91  5B  [7 2 4 6 ]  left bracket                               |
  |  92  5C  [7 21 56 ]  backward slash                             |
  |  93  5D  [7 21456 ]  right bracket                              |
  |  94  5E  [7   45  ]  circumflex accent                          |
  |  95  5F  [    456 ]  underscore                                 |
  |  96  60  [    4   ]  grave accent                               |
  |  97  61  [   1    ]  small a                                    |
  |  98  62  [  21    ]  small b                                    |
  |  99  63  [   14   ]  small c                                    |
  | 100  64  [   145  ]  small d                                    |
  | 101  65  [   1 5  ]  small e                                    |
  | 102  66  [  214   ]  small f                                    |
  | 103  67  [  2145  ]  small g                                    |
  | 104  68  [  21 5  ]  small h                                    |
  | 105  69  [  2 4   ]  small i                                    |
  | 106  6A  [  2 45  ]  small j                                    |
  | 107  6B  [ 3 1    ]  small k                                    |
  | 108  6C  [ 321    ]  small l                                    |
  | 109  6D  [ 3 14   ]  small m                                    |
  | 110  6E  [ 3 145  ]  small n                                    |
  | 111  6F  [ 3 1 5  ]  small o                                    |
  | 112  70  [ 3214   ]  small p                                    |
  | 113  71  [ 32145  ]  small q                                    |
  | 114  72  [ 321 5  ]  small r                                    |
  | 115  73  [ 32 4   ]  small s                                    |
  | 116  74  [ 32 45  ]  small t                                    |
  | 117  75  [ 3 1  6 ]  small u                                    |
  | 118  76  [ 321  6 ]  small v                                    |
  | 119  77  [  2 456 ]  small w                                    |
  | 120  78  [ 3 14 6 ]  small x                                    |
  | 121  79  [ 3 1456 ]  small y                                    |
  | 122  7A  [ 3 1 56 ]  small z                                    |
  | 123  7B  [  2 4 6 ]  left brace                                 |
  | 124  7C  [  21 56 ]  vertical bar                               |
  | 125  7D  [  21456 ]  right brace                                |
  | 126  7E  [    45  ]  tilde accent                               |
  | 127  7F  [7   456 ]  DEL (delete)                               |
  | 128  80  [    4  8]  <control>                                  |
  | 129  81  [   1   8]  <control>                                  |
  | 130  82  [  21   8]  BPH (break permitted here)                 |
  | 131  83  [   14  8]  NBH (no break here)                        |
  | 132  84  [   145 8]  <control>                                  |
  | 133  85  [   1 5 8]  NL (next line)                             |
  | 134  86  [  214  8]  SSA (start of selected area)               |
  | 135  87  [  2145 8]  ESA (end of selected area)                 |
  | 136  88  [  21 5 8]  CTS (character tabulation set)             |
  | 137  89  [  2 4  8]  CTJ (character tabulation justification)   |
  | 138  8A  [  2 45 8]  LTS (line tabulation set)                  |
  | 139  8B  [ 3 1   8]  PLD (partial line down)                    |
  | 140  8C  [ 321   8]  PLU (partial line up)                      |
  | 141  8D  [ 3 14  8]  RLF (reverse line feed)                    |
  | 142  8E  [ 3 145 8]  SS2 (single shift two)                     |
  | 143  8F  [ 3 1 5 8]  SS3 (single shift three)                   |
  | 144  90  [ 3214  8]  DCS (device control string)                |
  | 145  91  [ 32145 8]  PU1 (private use one)                      |
  | 146  92  [ 321 5 8]  PU2 (private use two)                      |
  | 147  93  [ 32 4  8]  STS (set transmit state)                   |
  | 148  94  [ 32 45 8]  CC (cancel character)                      |
  | 149  95  [ 3 1  68]  MW (message waiting)                       |
  | 150  96  [ 321  68]  SGA (start of guarded area)                |
  | 151  97  [  2 4568]  EGA (end of guarded area)                  |
  | 152  98  [ 3 14 68]  SS (start of string)                       |
  | 153  99  [ 3 14568]  <control>                                  |
  | 154  9A  [ 3 1 568]  SCI (single character introducer)          |
  | 155  9B  [  2 4 68]  CSI (control sequence introducer)          |
  | 156  9C  [  21 568]  ST (string terminator)                     |
  | 157  9D  [  214568]  OSC (operating system command)             |
  | 158  9E  [    45 8]  PM (privacy message)                       |
  | 159  9F  [    4568]  APC (application program command)          |
  | 160  A0  [7      8]  no-break space                             |
  | 161  A1  [732 4 6 ]  inverted exclamation mark                  |
  | 162  A2  [7 214 6 ]  cent sign                                  |
  | 163  A3  [73  456 ]  pound sign                                 |
  | 164  A4  [7  14 6 ]  currency sign                              |
  | 165  A5  [73214 6 ]  yen sign                                   |
  | 166  A6  [7  1 56 ]  broken bar                                 |
  | 167  A7  [73   5  ]  section sign                               |
  | 168  A8  [7    5  ]  diaeresis                                  |
  | 169  A9  [732  56 ]  copyright sign                             |
  | 170  AA  [       8]  feminine ordinal indicator                 |
  | 171  AB  [7 21  6 ]  left-pointing double angle quotation mark  |
  | 172  AC  [7 2  56 ]  not sign                                   |
  | 173  AD  [73    6 ]  soft hyphen                                |
  | 174  AE  [732   6 ]  registered sign                            |
  | 175  AF  [7 2   6 ]  macron                                     |
  | 176  B0  [73   56 ]  degree sign                                |
  | 177  B1  [73  4 6 ]  plus-minus sign                            |
  | 178  B2  [732     ]  superscript two                            |
  | 179  B3  [7 2  5  ]  superscript three                          |
  | 180  B4  [73      ]  acute accent                               |
  | 181  B5  [7    56 ]  micro sign                                 |
  | 182  B6  [732  5  ]  pilcrow sign                               |
  | 183  B7  [7   4 6 ]  middle dot                                 |
  | 184  B8  [7     6 ]  cedilla                                    |
  | 185  B9  [7 2     ]  superscript one                            |
  | 186  BA  [7       ]  masculine ordinal indicator                |
  | 187  BB  [73  45  ]  right-pointing double angle quotation mark |
  | 188  BC  [7321 56 ]  vulgar fraction one quarter                |
  | 189  BD  [7321456 ]  vulgar fraction one half                   |
  | 190  BE  [732 456 ]  vulgar fraction three quarters             |
  | 191  BF  [7  1456 ]  inverted question mark                     |
  | 192  C0  [732  5 8]  capital a grave                            |
  | 193  C1  [7  1  68]  capital a acute                            |
  | 194  C2  [7 2    8]  capital a circumflex                       |
  | 195  C3  [7    5 8]  capital a tilde                            |
  | 196  C4  [73214 68]  capital a diaeresis                        |
  | 197  C5  [73  45 8]  capital a ring above                       |
  | 198  C6  [73     8]  capital ae                                 |
  | 199  C7  [73  4 68]  capital c cedilla                          |
  | 200  C8  [732  568]  capital e grave                            |
  | 201  C9  [7 21  68]  capital e acute                            |
  | 202  CA  [732    8]  capital e circumflex                       |
  | 203  CB  [73214568]  capital e diaeresis                        |
  | 204  CC  [732   68]  capital i grave                            |
  | 205  CD  [7  14 68]  capital i acute                            |
  | 206  CE  [7 2  5 8]  capital i circumflex                       |
  | 207  CF  [7321 568]  capital i diaeresis                        |
  | 208  D0  [7     68]  capital eth                                |
  | 209  D1  [7   4 68]  capital n tilde                            |
  | 210  D2  [73   5 8]  capital o grave                            |
  | 211  D3  [7  14568]  capital o acute                            |
  | 212  D4  [7 2  568]  capital o circumflex                       |
  | 213  D5  [7    568]  capital o tilde                            |
  | 214  D6  [732 4 68]  capital o diaeresis                        |
  | 215  D7  [7  1  6 ]  multiplication sign                        |
  | 216  D8  [73  4  8]  capital o stroke                           |
  | 217  D9  [73   568]  capital u grave                            |
  | 218  DA  [7  1 568]  capital u acute                            |
  | 219  DB  [7 2   68]  capital u circumflex                       |
  | 220  DC  [732 4568]  capital u diaeresis                        |
  | 221  DD  [7 214 68]  capital y acute                            |
  | 222  DE  [73    68]  capital thorn                              |
  | 223  DF  [73  4568]  small sharp s                              |
  | 224  E0  [ 32  5 8]  small a grave                              |
  | 225  E1  [   1  68]  small a acute                              |
  | 226  E2  [  2    8]  small a circumflex                         |
  | 227  E3  [     5 8]  small a tilde                              |
  | 228  E4  [ 3214 68]  small a diaeresis                          |
  | 229  E5  [ 3  45 8]  small a ring above                         |
  | 230  E6  [ 3     8]  small ae                                   |
  | 231  E7  [ 3  4 68]  small c cedilla                            |
  | 232  E8  [ 32  568]  small e grave                              |
  | 233  E9  [  21  68]  small e acute                              |
  | 234  EA  [ 32    8]  small e circumflex                         |
  | 235  EB  [ 3214568]  small e diaeresis                          |
  | 236  EC  [ 32   68]  small i grave                              |
  | 237  ED  [   14 68]  small i acute                              |
  | 238  EE  [  2  5 8]  small i circumflex                         |
  | 239  EF  [ 321 568]  small i diaeresis                          |
  | 240  F0  [      68]  small eth                                  |
  | 241  F1  [    4 68]  small n tilde                              |
  | 242  F2  [ 3   5 8]  small o grave                              |
  | 243  F3  [   14568]  small o acute                              |
  | 244  F4  [  2  568]  small o circumflex                         |
  | 245  F5  [     568]  small o tilde                              |
  | 246  F6  [ 32 4 68]  small o diaeresis                          |
  | 247  F7  [73  4   ]  division sign                              |
  | 248  F8  [ 3  4  8]  small o stroke                             |
  | 249  F9  [ 3   568]  small u grave                              |
  | 250  FA  [   1 568]  small u acute                              |
  | 251  FB  [  2   68]  small u circumflex                         |
  | 252  FC  [ 32 4568]  small u diaeresis                          |
  | 253  FD  [  214 68]  small y acute                              |
  | 254  FE  [ 3    68]  small thorn                                |
  | 255  FF  [ 3  4568]  small y diaeresis                          |
  +-----------------------------------------------------------------+



  [1mG.  MIDI Instrument Table[0m



