Skip to content

Commit

Permalink
BRLTTY spelling fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
pdm committed Nov 28, 2007
1 parent 88fd5af commit c3f52a2
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 52 deletions.
4 changes: 2 additions & 2 deletions ANNOUNCE
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ The Free(b)soft project is pleased to announce speechd-el 2.2.
speechd-el is an Emacs client to speech synthesizers, Braille displays
and other alternative output interfaces. It provides full speech and
Braille output environment for Emacs using the Speech Dispatcher and
BrlTTY backends. It is focused especially on (but not limited to) the
BRLTTY backends. It is focused especially on (but not limited to) the
blind and visually impaired users. It allows the user to work with
Emacs without looking on the screen, by listening to speech output
produced by the speech synthesizers supported in Speech Dispatcher and
watching Braille output on Braille displays supported by BrlTTY.
watching Braille output on Braille displays supported by BRLTTY.

Key speechd-el features are:

Expand Down
12 changes: 6 additions & 6 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ User-visible changes to speechd-el:
** Support for new BrlAPI protocol introduced in BRLTTY 3.8.

speechd-el now works with BRLTTY 3.8 final version and BRLTTY 3.9.
Additionally BrlTTY error reporting cleanup was made.
Additionally BRLTTY error reporting cleanup was made.

** New BRLTTY key handler for general character input.

Expand All @@ -24,12 +24,12 @@ only works with Speech Dispatcher 0.6.3 or higher.

** Invisible text is no longer read.

** Support for BrlTTY 3.8.
** Support for BRLTTY 3.8.

BrlTTY uses 64-bit key codes. They are represented as two-number lists in
BRLTTY uses 64-bit key codes. They are represented as two-number lists in
speechd-braille-key-functions.

** WINDOWPATH BrlTTY environment variable is recognized.
** WINDOWPATH BRLTTY environment variable is recognized.

The WINDOWSPATH environment variable should be named WINDOWPATH now.
This speechd-el version uses whichever of those two is defined.
Expand All @@ -43,9 +43,9 @@ speechd-el is output device independent now, it no longer depends on speech
output and SSIP. It is now possible (and sufficiently simple) to add new
output modules for alternative output devices, such as Braille displays, etc.

** BrlTTY input/output added.
** BRLTTY input/output added.

speechd-el now supports Braille output to BrlTTY with basically the same
speechd-el now supports Braille output to BRLTTY with basically the same
functionality as in the speech output. It is possible to use speech output,
Braille output, or both. You can use sophisticated speechd-el features such as
message priorities and text property handling instead of screen reading.
Expand Down
4 changes: 2 additions & 2 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ environment for Emacs.
It is aimed primarily at visually impaired users who need non-visual
communication with Emacs, but it can be used by anybody who needs sophisticated
speech or other kind of alternative output from Emacs. speechd-el can make
Emacs a completely speech and BrlTTY enabled application suitable for visually
Emacs a completely speech and BRLTTY enabled application suitable for visually
impaired users or, depending on its configuration, it can only speak in certain
situations or when asked, to serve needs of any Emacs user.

Expand All @@ -26,7 +26,7 @@ Installation:
- Install the `speechd-log-extractor' script somewhere to your shell PATH (this
step is optional, the script is used only for bug reporting).

- Start Speech Dispatcher and/or BrlTTY.
- Start Speech Dispatcher and/or BRLTTY.

- Start Emacs and call the commands

Expand Down
28 changes: 14 additions & 14 deletions brltty.el
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;;; brltty.el --- Interface to BrlTTY
;;; brltty.el --- Interface to BRLTTY

;; Copyright (C) 2004, 2005, 2006, 2007 Brailcom, o.p.s.

Expand Down Expand Up @@ -33,16 +33,16 @@


(defgroup brltty ()
"BrlTTY interface."
"BRLTTY interface."
:group 'speechd-el)

(defcustom brltty-default-host "localhost"
"Default BrlTTY host to connect to."
"Default BRLTTY host to connect to."
:type 'string
:group 'brltty)

(defcustom brltty-default-port '(4101 4102 4103 4104 35751)
"Default BrlTTY port to connect to.
"Default BRLTTY port to connect to.
If it is a list, the given port numbers are attempted in the order they are
given until Emacs connects to something."
:type 'integer
Expand All @@ -54,7 +54,7 @@ given until Emacs connects to something."
:group 'brltty)

(defcustom brltty-coding 'iso-8859-1
"Coding in which texts should be sent to BrlTTY."
"Coding in which texts should be sent to BRLTTY."
:type 'coding-system
:group 'brltty)

Expand All @@ -73,7 +73,7 @@ available, from the environment variable CONTROLVT."
:group 'brltty)

(defcustom brltty-timeout 3
"Maximum number of seconds to wait for a BrlTTY answer."
"Maximum number of seconds to wait for a BRLTTY answer."
:type 'integer
:group 'brltty)

Expand Down Expand Up @@ -227,7 +227,7 @@ available, from the environment variable CONTROLVT."
(when process
(delete-process process)
(setf (brltty--connection-process connection) nil)))
(error "Error in communication with BrlTTY: %s" error))
(error "Error in communication with BRLTTY: %s" error))

(defun brltty--process-filter* (process output)
(let ((connection (brltty--process-connection process)))
Expand Down Expand Up @@ -289,7 +289,7 @@ available, from the environment variable CONTROLVT."
(let ((err-number (brltty--read-integer data)))
(if (= err-number brltty--protocol-version-error)
(brltty--add-answer connection (list type err-number))
(error (format "BrlTTY error %d: %s"
(error (format "BRLTTY error %d: %s"
err-number (cdr (assoc err-number brltty--errors)))))))
(key
(let ((handler (brltty--connection-key-handler connection)))
Expand Down Expand Up @@ -344,7 +344,7 @@ available, from the environment variable CONTROLVT."
(brltty--accept-process-output process)
(setq answer (brltty--next-answer connection))))
(when (and (not answer) (not none-ok))
(error "BrlTTY answer not received"))
(error "BRLTTY answer not received"))
(cdr answer)))

(defun brltty--send-packet (connection answer packet-id &rest data-list)
Expand Down Expand Up @@ -408,10 +408,10 @@ available, from the environment variable CONTROLVT."
(put 'brltty-connection-error 'error-conditions
'(error speechd-connection-error brltty-connection-error))
(put 'brltty-connection-error 'error-message
"Error on opening BrlTTY connection")
"Error on opening BRLTTY connection")

(defun brltty-open (&optional host port key-handler)
"Open and return connection to a BrlTTY server running on HOST and PORT.
"Open and return connection to a BRLTTY server running on HOST and PORT.
If HOST or PORT is nil, `brltty-default-host' or `brltty-default-port' is used
respectively."
(condition-case err
Expand Down Expand Up @@ -452,7 +452,7 @@ respectively."
(signal 'brltty-connection-error err))))

(defun brltty-close (connection)
"Close BrlTTY CONNECTION."
"Close BRLTTY CONNECTION."
(when connection
(when (brltty--connection-terminal-spec connection)
(brltty--send-packet connection 'ack 'leavetty))
Expand All @@ -476,7 +476,7 @@ respectively."
(setf (brltty--connection-display-width connection) size))))))

(defun brltty-write (connection text &optional cursor)
"Display TEXT in BrlTTY accessed through CONNECTION.
"Display TEXT in BRLTTY accessed through CONNECTION.
TEXT is encoded in the coding given by `brltty-coding' before it is sent.
CURSOR, if non-nil, is a position of the cursor on the display, starting
from 0."
Expand All @@ -502,7 +502,7 @@ from 0."
1 display-width
(length encoded-text) encoded-text
;; Cursor position may not be too high,
;; otherwise BrlTTY breaks the connection
;; otherwise BRLTTY breaks the connection
(if cursor
(1+ (min cursor display-width))
0))))
Expand Down
4 changes: 2 additions & 2 deletions speechd-brltty.el
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
;;; speechd-brltty.el --- BrlTTY output driver
;;; speechd-brltty.el --- BRLTTY output driver

;; Copyright (C) 2004, 2005, 2006 Brailcom, o.p.s.

Expand Down Expand Up @@ -210,7 +210,7 @@ is not recommended to assign or call user commands here."
(setq unread-command-events (append unread-command-events (list key))))

(defmacro speechd-brltty-command-key-function (key)
"Insert BrlTTY function handling general character KEY event."
"Insert BRLTTY function handling general character KEY event."
`(lambda (driver) (speechd-brltty-command-key driver ,key)))


Expand Down
52 changes: 26 additions & 26 deletions speechd-el.texi
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ General Public License''.

@dircategory Emacs
@direntry
* speechd-el: (speechd-el). Emacs interface to Speech Dispatcher and BrlTTY.
* speechd-el: (speechd-el). Emacs interface to Speech Dispatcher and BRLTTY.
@end direntry

@titlepage
Expand Down Expand Up @@ -82,7 +82,7 @@ Braille output environment for Emacs.
It is aimed primarily at visually impaired users who need non-visual
communication with Emacs, but it can be used by anybody who needs
sophisticated speech or other kind of alternative output from Emacs.
speechd-el can make Emacs a completely speech and BrlTTY enabled
speechd-el can make Emacs a completely speech and BRLTTY enabled
application suitable for visually impaired users or, depending on its
configuration, it can only speak in certain situations or when asked,
to serve needs of any Emacs user.
Expand All @@ -92,7 +92,7 @@ for communication with the output devices.

This manual describes the speech/Braille output user interface, how to
customize and extend the interface, and the Emacs Lisp libraries.
Some degree of familiarity with Speech Dispatcher or BrlTTY on the
Some degree of familiarity with Speech Dispatcher or BRLTTY on the
user level is recommended, although not absolutely necessary.

@menu
Expand Down Expand Up @@ -216,7 +216,7 @@ Dectalk, IBM TTS, Cicero, etc.) and you can use multiple speech
synthesizers inside a single Emacs session.

@item
Braille displays are handled through BrlTTY drivers and APIs.
Braille displays are handled through BRLTTY drivers and APIs.

@item
Programming libraries for those who want to extend speechd-el
Expand Down Expand Up @@ -246,7 +246,7 @@ independently of higher level features.
@cindex BrlAPI
The lowest level components are access libraries to output devices,
especially to SSIP (the Speech Dispatcher TCP communication protocol
for speech output) and BrlAPI (interface to BrlTTY drivers for
for speech output) and BrlAPI (interface to BRLTTY drivers for
communication with Braille displays). They can be used to talk to the
output devices directly from Elisp programs.

Expand Down Expand Up @@ -281,11 +281,11 @@ Speech Dispatcher installation is necessary to produce any speech
output. Please look at @url{http://www.freebsoft.org/speechd} for
more information about Speech Dispatcher.

@cindex BrlTTY
For the Braille output BrlTTY is used through its BrlAPI interface.
To make the Braille output work, BrlTTY must be running and properly
@cindex BRLTTY
For the Braille output BRLTTY is used through its BrlAPI interface.
To make the Braille output work, BRLTTY must be running and properly
configured. Please look at @url{http://www.mielke.cc/brltty/} for
more information about BrlTTY.
more information about BRLTTY.

@menu
* Installation:: Installing speechd-el.
Expand Down Expand Up @@ -342,9 +342,9 @@ Add the following lines to your @file{~/.emacs}:
To receive speech output, Speech Dispatcher must be installed and
running. Speech Dispatcher version 0.5 or higher is recommended.

@cindex BrlTTY
To receive Braille output, BrlTTY must be installed and running.
BrlTTY version 3.7 or higher is required.
@cindex BRLTTY
To receive Braille output, BRLTTY must be installed and running.
BRLTTY version 3.7 or higher is required.

@node Starting Alternative Output, Commands, Installation, speechd-el User Manual
@section Starting Speech and Braille Output
Expand All @@ -366,12 +366,12 @@ Set up Emacs for alternative output and start speaking or
communicating with the Braille display.

Please don't forget Speech Dispatcher must be running in order to get
any speech output and BrlTTY must be running in order to get Braille
any speech output and BRLTTY must be running in order to get Braille
output!

After the initial setup, the command can be used again to restart the
speech or Braille output when needed. Especially, you must run it
again if Speech Dispatcher or BrlTTY gets restarted.
again if Speech Dispatcher or BRLTTY gets restarted.

After the first invocation, the command is available under the
@kbd{C-e C-s} key.
Expand Down Expand Up @@ -858,7 +858,7 @@ List of names of active output drivers.
@end vtable

If a driver that does not work is present in the variable (e.g. the
list contains the @code{brltty} symbol while BrlTTY is not actually
list contains the @code{brltty} symbol while BRLTTY is not actually
running), you receive an error message. To prevent the error message,
remove the driver from this variable.

Expand All @@ -879,7 +879,7 @@ Disable the given output driver.
@subsection Speech Dispatcher Host Connection Configuration

Host connection variables allow you connect to Speech Dispatcher or
BrlTTY running on a remote host or a non-default port and to specify
BRLTTY running on a remote host or a non-default port and to specify
other TCP connection parameters.

Speech Dispatcher connection options:
Expand Down Expand Up @@ -915,11 +915,11 @@ spdsend is not used.
Usually you shouldn't care about this variable.
@end vtable

BrlTTY connection options:
BRLTTY connection options:

@vtable @code
@item brltty-default-host
Name of the host running BrlTTY to connect to, given as a string.
Name of the host running BRLTTY to connect to, given as a string.
Default is @code{"localhost"}.

@item brltty-default-port
Expand All @@ -930,24 +930,24 @@ is the list of the standard BrlAPI ports.

@item brltty-authentication-file
File containing the BrlAPI authentication key. It is important to set
the variable properly, otherwise the connection to BrlTTY gets
the variable properly, otherwise the connection to BRLTTY gets
rejected. Default is @code{"/etc/brlapi.key"}.

@item brltty-coding
Coding in which texts should be sent to BrlTTY. Default is
Coding in which texts should be sent to BRLTTY. Default is
@code{iso-8859-1}; if you use non-Western language, you may need to
change it to display its characters correctly on the Braille display.

@item brltty-tty
Number of the Linux console on which speechd-el runs. If this value
is not set correctly, speechd-el may not interact well with other
applications communicating with BrlTTY. speechd-el tries to find the
applications communicating with BRLTTY. speechd-el tries to find the
correct value itself, if this doesn't work, set this variable properly
or set the @code{CONTROLVT} environment variable.

@item brltty-timeout
Maximum number of seconds to wait for a BrlTTY answer. If it is
exceeded, speechd-el closes the connection. Normally, BrlTTY should
Maximum number of seconds to wait for a BRLTTY answer. If it is
exceeded, speechd-el closes the connection. Normally, BRLTTY should
answer protocol commands immediately, but if you talk to BrlAPI in a
strange way through a lagging network, you may want to increase the
limit.
Expand Down Expand Up @@ -1536,8 +1536,8 @@ If the given key is pressed, the corresponding function is called with
a @code{speechd-brltty-driver} instance as its single argument (read
the source code for information about speechd-el output drivers).

The key codes are either integers (for BrlTTY 3.7 and older) or lists
containing three integers (for BrlTTY 3.8 and newer). See the default
The key codes are either integers (for BRLTTY 3.7 and older) or lists
containing three integers (for BRLTTY 3.8 and newer). See the default
variable value for examples of possible key codes.

The assigned functions needn't be interactive. Actually as the
Expand Down Expand Up @@ -1910,7 +1910,7 @@ User interface implemented in @file{speechd-speak.el}.
@end itemize

You can use the libraries to communicate with Speech Dispatcher,
BrlTTY or other devices in your own programs.
BRLTTY or other devices in your own programs.

Right now, there's no real programmer's manual to the libraries.
Please read docstrings of available variables, functions and macros.
Expand Down

0 comments on commit c3f52a2

Please sign in to comment.