brltty/brltty-4.5-man-fix.patch
Jaroslav Škarvada ae8b056d5d Updated man page
2013-07-15 18:43:15 +02:00

643 lines
18 KiB
Diff

diff -up brltty-4.5/Documents/brltty.1.in.orig brltty-4.5/Documents/brltty.1.in
--- brltty-4.5/Documents/brltty.1.in.orig 2013-03-28 01:24:27.000000000 +0100
+++ brltty-4.5/Documents/brltty.1.in 2013-07-15 17:26:50.610416942 +0200
@@ -41,8 +41,8 @@ Boot Parameters
.IP 3. 4
Environment Variables
(if the
-.B -E
-.RB "(" "--environment-variables" ")"
+.B \-E
+.RB "(" "\-\-environment\-variables" ")"
option is in effect)
.IP 4. 4
The Configuration File
@@ -56,7 +56,7 @@ the rightmost specification takes preced
.PP
The following options are supported:
.TP
-\fB-a \fItable\fR (\fB--attributes-table=\fR)
+\fB\-a \fItable\fR (\fB\-\-attributes\-table=\fR)
The path to the attributes table.
Relative paths are anchored at
.BR "@TABLES_DIRECTORY@" "."
@@ -66,12 +66,12 @@ extension is optional.
The built-in default is
.BR "attributes.atb" "."
.TP
-\fB-b \fIdriver\fB,\fR...|\fBauto\fR (\fB--braille-driver=\fR)
+\fB\-b \fIdriver\fB,\fR...|\fBauto\fR (\fB\-\-braille\-driver=\fR)
The driver for the braille display
(see Driver Specification).
The built-in default is \fBauto\fR.
.TP
-\fB-c \fItable\fR (\fB--contraction-table=\fR)
+\fB\-c \fItable\fR (\fB\-\-contraction\-table=\fR)
The path to the contraction table.
Relative paths are anchored at
.BR "@TABLES_DIRECTORY@" "."
@@ -79,7 +79,7 @@ The
.B ".ctb"
extension is optional.
.TP
-\fB-d \fIdevice\fB,\fR... (\fB--braille-device=\fR)
+\fB\-d \fIdevice\fB,\fR... (\fB\-\-braille\-device=\fR)
The device to which the braille display is connected.
The built-in default is \fB@braille_device@\fR.
.RS
@@ -131,23 +131,23 @@ 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,
+a braille display with more than one interface,
e.g. both a serial and a USB port.
.RE
.TP
-\fB-e\fR (\fB--standard-error\fR)
+\fB\-e\fR (\fB\-\-standard\-error\fR)
Write logs to standard error rather than to the system log (useful for debugging).
.TP
-\fB-f \fIfile\fR (\fB--configuration-file=\fR)
+\fB\-f \fIfile\fR (\fB\-\-configuration\-file=\fR)
The path to the configuration file.
Relative paths are anchored at the current working directory.
-The built-in default is
+The built\-in default is
.BR "@CONFIGURATION_DIRECTORY@/@CONFIGURATION_FILE@" "."
.TP
-\fB-h\fR (\fB--help\fR)
+\fB\-h\fR (\fB\-\-help\fR)
Print a command line usage summary and then exit.
.TP
-\fB-i \fIname\fR (\fB--speech-input=\fR)
+\fB\-i \fIname\fR (\fB\-\-speech\-input=\fR)
The file system object
(FIFO, named pipe, named socket, etc)
which gives other applications access to
@@ -158,7 +158,10 @@ Relative paths are anchored at the curre
The built-in default is
that the file system object is not created.
.TP
-\fB-l \fIlevel\fR (\fB--log-level=\fR)
+\fB\-k \fIfile\fR (\fB\-\-key\-table=\fR)
+Path to key table file.
+.TP
+\fB\-l \fIlevel\fR (\fB\-\-log\-level=\fR)
The minimum severity level for messages written to the log.
Any of the following numbers,
or any abbreviation of their corresponding names,
@@ -193,7 +196,7 @@ may be specified:
The built-in default is
.BR "notice" "."
.TP
-\fB-m \fIdevice\fR (\fB--midi-device=\fR)
+\fB\-m \fIdevice\fR (\fB\-\-midi\-device=\fR)
The device to use for the Musical Instrument Digital Interface.
For ALSA it's \fIclient\fB:\fIport\fR,
where each may be either a number or a case-sensitive substring of its name.
@@ -206,10 +209,10 @@ the first available MIDI output port
.B /dev/sequencer
.RE
.TP
-\fB-n\fR (\fB--no-daemon\fR)
+\fB\-n\fR (\fB\-\-no\-daemon\fR)
Remain in the foreground (useful for debugging).
.TP
-\fB-p \fIdevice\fR (\fB--pcm-device=\fR)
+\fB\-p \fIdevice\fR (\fB\-\-pcm\-device=\fR)
The device to use for digital audio.
For ALSA it's \fIname\fR[\fB:\fIargument\fB,\fR...].
For other interfaces it's the full path to an appropriate system device.
@@ -231,34 +234,34 @@ the preferred PCM output device
.B /dev/audio
.RE
.TP
-\fB-q\fR (\fB--quiet\fR)
+\fB\-q\fR (\fB\-\-quiet\fR)
Suppress the start-up messages.
This is done by reducing the default log level
(see the
-.B -l
-.RB "(" "--log-level=" ")"
+.B \-l
+.RB "(" "\-\-log\-level=" ")"
option)
to
.B warning
.RB "(" "information"
if either
-.B -v
-.RB "(" "--verify" ")"
+.B \-v
+.RB "(" "\-\-verify" ")"
or
-.B -V
-.RB "(" "--version" ")"
+.B \-V
+.RB "(" "\-\-version" ")"
is also specified).
.TP
-\fB-r\fR (\fB--release-device\fR)
+\fB\-r\fR (\fB\-\-release\-device\fR)
Release the device to which the braille display is connected
when the current screen or window can't be read.
.TP
-\fB-s \fIdriver\fB,\fR...|\fBauto\fR (\fB--speech-driver=\fR)
+\fB\-s \fIdriver\fB,\fR...|\fBauto\fR (\fB\-\-speech\-driver=\fR)
The driver for the speech synthesizer
(see Driver Specification).
The built-in default is \fBauto\fR.
.TP
-\fB-t \fItable\fR (\fB--text-table=\fR)
+\fB\-t \fItable\fR (\fB\-\-text\-table=\fR)
The path to the text table.
Relative paths are anchored at
.BR "@TABLES_DIRECTORY@" "."
@@ -269,7 +272,7 @@ The built-in default is
.B "nabcc.ttb"
(the North American Braille Computer Code).
.TP
-\fB-v\fR (\fB--verify\fR)
+\fB\-v\fR (\fB\-\-verify\fR)
Print the start-up messages and then exit.
This always includes the versions of
.B brltty
@@ -277,8 +280,8 @@ itself,
the server side of its application programming interface,
and each of the selected braille and speech drivers.
If the
-.B -q
-.RB "(" "--quiet" ")"
+.B \-q
+.RB "(" "\-\-quiet" ")"
option isn't also specified
then it also includes the values of the options after all sources have been considered.
If more than one braille driver and/or more than one braille device
@@ -286,17 +289,17 @@ has been specified then braille display
If more than one speech driver
has been specified then speech synthesizer autodetection is performed.
.TP
-\fB-x \fIdriver\fR (\fB--screen-driver=\fR)
+\fB\-x \fIdriver\fR (\fB\-\-screen\-driver=\fR)
The screen driver.
The built-in default is operating system appropriate.
.TP
-\fB-A \fIname\fB=\fIvalue\fB,\fR... (\fB--api-parameters=\fR)
+\fB\-A \fIname\fB=\fIvalue\fB,\fR... (\fB\-\-api\-parameters=\fR)
Parameters for the application programming interface.
If the same parameter is specified more than once
then the rightmost specification is used.
Parameter names may be abbreviated.
.TP
-\fB-B \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR... (\fB--braille-parameters=\fR)
+\fB\-B \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR... (\fB\-\-braille\-parameters=\fR)
Parameters for the braille display driver.
If the same parameter is specified more than once
then the rightmost specification is used.
@@ -304,17 +307,23 @@ Parameter names may be abbreviated.
If a parameter assignment is qualified with a driver identification code
then it's only processed if that braille display driver is being used.
.TP
-\fB-E\fR (\fB--environment-variables\fR)
+\fB\-D\fR (\fB\-\-drivers\-directory=\fR)
+Path to directory for loading drivers.
+.TP
+\fB\-E\fR (\fB\-\-environment\-variables\fR)
Recognize environment variables.
.TP
-\fB-F \fIfile\fR (\fB--preferences-file=\fR)
+\fB\-F \fIfile\fR (\fB\-\-preferences\-file=\fR)
The path to the preferences file.
Relative paths are anchored at
.BR "@STATE_DIRECTORY@" "."
The built-in default is
.BR "@PREFERENCES_FILE@" "."
.TP
-\fB-I\fR (\fB--install-service\fR)
+\fB\-H\fR (\fB\-\-full\-help\fR)
+Print a usage summary (all options), and then exit.
+.TP
+\fB\-I\fR (\fB\-\-install\-service\fR)
(Windows only)
Install
.B brltty
@@ -325,21 +334,24 @@ and so that applications can know that a
.B BrlAPI
server is running.
.TP
-\fB-L \fIfile\fR (\fB--log-file=\fR)
+\fB\-K \fIarg\fR (\fB\-\-keyboard\-properties=\fR)
+Properties of the keyboard.
+.TP
+\fB\-L \fIfile\fR (\fB\-\-log\-file=\fR)
The file to which log messages are written.
Relative paths are anchored at the current working directory.
The default is to send log messages to the system log.
.TP
-\fB-M \fIcsecs\fR (\fB--message-delay=\fR)
+\fB\-M \fIcsecs\fR (\fB\-\-message\-delay=\fR)
The message hold time in hundredths of a second.
The built-in default is
.B 400
(4 seconds).
.TP
-\fB-N\fR (\fB--no-api\fR)
+\fB\-N\fR (\fB\-\-no\-api\fR)
Don't start the application programming interface.
.TP
-\fB-P \fIfile\fR (\fB--pid-file=\fR)
+\fB\-P \fIfile\fR (\fB\-\-pid\-file=\fR)
The full path to the process identifier file.
If this option is supplied,
.B brltty
@@ -348,7 +360,7 @@ The file is removed when
.B brltty
terminates.
.TP
-\fB-R\fR (\fB--remove-service\fR)
+\fB\-R\fR (\fB\-\-remove\-service\fR)
(Windows only)
Remove the
.B BrlAPI
@@ -359,7 +371,7 @@ and so that applications can know that n
.B BrlAPI
server is running.
.TP
-\fB-S \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR... (\fB--speech-parameters=\fR)
+\fB\-S \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR... (\fB\-\-speech\-parameters=\fR)
Parameters for the speech synthesizer driver.
If the same parameter is specified more than once
then the rightmost specification is used.
@@ -367,13 +379,16 @@ Parameter names may be abbreviated.
If a parameter assignment is qualified with a driver identification code
then it's only processed if that speech synthesizer driver is being used.
.TP
-\fB-U \fIcsecs\fR (\fB--update-interval=\fR)
+\fB\-T \fIdirectory\fR (\fB\-\-tables\-directory=\fR)
+Path to directory for text and attributes tables.
+.TP
+\fB\-U \fIcsecs\fR (\fB\-\-update\-interval=\fR)
The braille window update interval in hundredths of a second.
The built-in default is
.B 4
(25 times per second).
.TP
-\fB-V\fR (\fB--version\fR)
+\fB\-V\fR (\fB\-\-version\fR)
Print the versions of
.B brltty
itself,
@@ -381,119 +396,122 @@ the server side of its application progr
and those drivers which were configured in at build-time,
and then exit.
If the
-.B -q
-.RB "(" "--quiet" ")"
+.B \-q
+.RB "(" "\-\-quiet" ")"
option isn't also specified
then also print copyright information.
.TP
-\fB-X \fIname\fB=\fIvalue\fB,\fR... (\fB--screen-parameters=\fR)
+\fB\-W \fIdirectory\fR (\fB\-\-writable\-directory=\fR)
+Path to directory which can be written to.
+.TP
+\fB\-X \fIname\fB=\fIvalue\fB,\fR... (\fB\-\-screen\-parameters=\fR)
Parameters for the screen driver.
If the same parameter is specified more than once
then the rightmost specification is used.
Parameter names may be abbreviated.
.SS "Environment Variables"
The following environment variables are recognized if the
-.B -E
-.RB "(" "--environment-variables" ")"
+.B \-E
+.RB "(" "\-\-environment\-variables" ")"
option is specified:
.TP
\fBBRLTTY_API_PARAMETERS=\fIname\fB=\fIvalue\fB,\fR...
Parameters for the application programming interface.
See the
-.B -A
-.RB "(" "--api-parameters=" ")"
+.B \-A
+.RB "(" "\-\-api\-parameters=" ")"
option for details.
.TP
\fBBRLTTY_ATTRIBUTES_TABLE=\fItable\fR
The attributes table.
See the
-.B -a
-.RB "(" "--attributes-table=" ")"
+.B \-a
+.RB "(" "\-\-attributes\-table=" ")"
option for details.
.TP
\fBBRLTTY_BRAILLE_DEVICE=\fIdevice\fB,\fR...
The device to which the braille display is connected.
See the
-.B -d
-.RB "(" "--braille-device=" ")"
+.B \-d
+.RB "(" "\-\-braille\-device=" ")"
option for details.
.TP
\fBBRLTTY_BRAILLE_DRIVER=\fIdriver\fB,\fR...|\fBauto\fR
The driver for the braille display.
See the
-.B -b
-.RB "(" "--braille-driver=" ")"
+.B \-b
+.RB "(" "\-\-braille\-driver=" ")"
option for details.
.TP
\fBBRLTTY_BRAILLE_PARAMETERS=\fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR...
Parameters for the braille display driver.
See the
-.B -B
-.RB "(" "--braille-parameters=" ")"
+.B \-B
+.RB "(" "\-\-braille\-parameters=" ")"
option for details.
.TP
\fBBRLTTY_CONFIGURATION_FILE=\fIfile\fR
The configuration file.
See the
-.B -f
-.RB "(" "--configuration-file=" ")"
+.B \-f
+.RB "(" "\-\-configuration\-file=" ")"
option for details.
.TP
\fBBRLTTY_CONTRACTION_TABLE=\fItable\fR
The contraction table.
See the
-.B -c
-.RB "(" "--contraction-table=" ")"
+.B \-c
+.RB "(" "\-\-contraction\-table=" ")"
option for details.
.TP
\fBBRLTTY_MIDI_DEVICE=\fIdevice\fR
The device to use for the Musical Instrument Digital Interface.
See the
-.B -m
-.RB "(" "--midi-device=" ")"
+.B \-m
+.RB "(" "\-\-midi\-device=" ")"
option for details.
.TP
\fBBRLTTY_PCM_DEVICE=\fIdevice\fR
The device to use for digital audio.
See the
-.B -p
-.RB "(" "--pcm-device=" ")"
+.B \-p
+.RB "(" "\-\-pcm\-device=" ")"
option for details.
.TP
\fBBRLTTY_PREFERENCES_FILE=\fIfile\fR
The preferences file.
See the
-.B -F
-.RB "(" "--preferences-file=" ")"
+.B \-F
+.RB "(" "\-\-preferences\-file=" ")"
option for details.
.TP
\fBBRLTTY_RELEASE_DEVICE=on\fR|\fBoff\fR
Release the device to which the braille display is connected
when the current screen or window can't be read.
See the
-.B -r
-.RB "(" "--release-device" ")"
+.B \-r
+.RB "(" "\-\-release\-device" ")"
option for details.
.TP
\fBBRLTTY_SCREEN_DRIVER=\fIdriver\fR
The screen driver.
See the
-.B -x
-.RB "(" "--screen-driver=" ")"
+.B \-x
+.RB "(" "\-\-screen\-driver=" ")"
option for details.
.TP
\fBBRLTTY_SCREEN_PARAMETERS=\fIname\fB=\fIvalue\fB,\fR...
Parameters for the screen driver.
See the
-.B -X
-.RB "(" "--screen-parameters=" ")"
+.B \-X
+.RB "(" "\-\-screen\-parameters=" ")"
option for details.
.TP
\fBBRLTTY_SPEECH_DRIVER=\fIdriver\fB,\fR...|\fBauto\fR
The driver for the speech synthesizer.
See the
-.B -s
-.RB "(" "--speech-driver=" ")"
+.B \-s
+.RB "(" "\-\-speech\-driver=" ")"
option for details.
.TP
\fBBRLTTY_SPEECH_INPUT=\fIname\fR
@@ -501,22 +519,22 @@ The file system object which gives other
.BR brltty 's
speech driver for text-to-speech conversion.
See the
-.B -i
-.RB "(" "--speech-input=" ")"
+.B \-i
+.RB "(" "\-\-speech\-input=" ")"
option for details.
.TP
\fBBRLTTY_SPEECH_PARAMETERS=\fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR...
Parameters for the speech synthesizer driver.
See the
-.B -S
-.RB "(" "--speech-parameters=" ")"
+.B \-S
+.RB "(" "\-\-speech\-parameters=" ")"
option for details.
.TP
\fBBRLTTY_TEXT_TABLE=\fItable\fR
The text table.
See the
-.B -t
-.RB "(" "--text-table=" ")"
+.B \-t
+.RB "(" "\-\-text\-table=" ")"
option for details.
.SS "The Configuration File"
Blank lines are ignored.
@@ -527,118 +545,118 @@ all characters from it to the end of tha
.PP
The following configuration directives are supported:
.TP
-\fBapi-parameters \fIname\fB=\fIvalue\fB,\fR...
+\fBapi\-parameters \fIname\fB=\fIvalue\fB,\fR...
Parameters for the application programming interface.
See the
-.B -A
-.RB "(" "--api-parameters=" ")"
+.B \-A
+.RB "(" "\-\-api\-parameters=" ")"
option for details.
.TP
-\fBattributes-table \fItable\fR
+\fBattributes\-table \fItable\fR
The attributes table.
See the
-.B -a
-.RB "(" "--attributes-table=" ")"
+.B \-a
+.RB "(" "\-\-attributes\-table=" ")"
option for details.
.TP
-\fBbraille-device \fIdevice\fB,\fR...
+\fBbraille\-device \fIdevice\fB,\fR...
The device to which the braille display is connected.
See the
-.B -d
-.RB "(" "--braille-device=" ")"
+.B \-d
+.RB "(" "\-\-braille\-device=" ")"
option for details.
.TP
-\fBbraille-driver \fIdriver\fB,\fR...|\fBauto\fR
+\fBbraille\-driver \fIdriver\fB,\fR...|\fBauto\fR
The driver for the braille display.
See the
-.B -b
-.RB "(" "--braille-driver=" ")"
+.B \-b
+.RB "(" "\-\-braille\-driver=" ")"
option for details.
.TP
-\fBbraille-parameters \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR...
+\fBbraille\-parameters \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR...
Parameters for the braille display driver.
See the
-.B -B
-.RB "(" "--braille-parameters=" ")"
+.B \-B
+.RB "(" "\-\-braille\-parameters=" ")"
option for details.
.TP
-\fBcontraction-table \fItable\fR
+\fBcontraction\-table \fItable\fR
The contraction table.
See the
-.B -c
-.RB "(" "--contraction-table=" ")"
+.B \-c
+.RB "(" "\-\-contraction\-table=" ")"
option for details.
.TP
-\fBmidi-device \fIdevice\fR
+\fBmidi\-device \fIdevice\fR
The device to use for the Musical Instrument Digital Interface.
See the
-.B -m
-.RB "(" "--midi-device=" ")"
+.B \-m
+.RB "(" "\-\-midi\-device=" ")"
option for details.
.TP
-\fBpcm-device \fIdevice\fR
+\fBpcm\-device \fIdevice\fR
The device to use for digital audio.
See the
-.B -p
-.RB "(" "--pcm-device=" ")"
+.B \-p
+.RB "(" "\-\-pcm\-device=" ")"
option for details.
.TP
The preferences file.
See the
-.B -F
-.RB "(" "--preferences-file=" ")"
+.B \-F
+.RB "(" "\-\-preferences\-file=" ")"
option for details.
.TP
-\fBrelease-device on\fR|\fBoff\fR
+\fBrelease\-device on\fR|\fBoff\fR
Release the device to which the braille display is connected
when the current screen or window can't be read.
See the
-.B -r
-.RB "(" "--release-device" ")"
+.B \-r
+.RB "(" "\-\-release\-device" ")"
option for details.
.TP
-\fBscreen-driver \fIdriver\fR
+\fBscreen\-driver \fIdriver\fR
The screen driver.
See the
-.B -x
-.RB "(" "--screen-driver=" ")"
+.B \-x
+.RB "(" "\-\-screen\-driver=" ")"
option for details.
.TP
-\fBscreen-parameters \fIname\fB=\fIvalue\fB,\fR...
+\fBscreen\-parameters \fIname\fB=\fIvalue\fB,\fR...
Parameters for the screen driver.
See the
-.B -X
-.RB "(" "--screen-parameters=" ")"
+.B \-X
+.RB "(" "\-\-screen\-parameters=" ")"
option for details.
.TP
-\fBspeech-driver \fIdriver\fB,\fR...|\fBauto\fR
+\fBspeech\-driver \fIdriver\fB,\fR...|\fBauto\fR
The driver for the speech synthesizer.
See the
-.B -s
-.RB "(" "--speech-driver=" ")"
+.B \-s
+.RB "(" "\-\-speech\-driver=" ")"
option for details.
.TP
-\fBspeech-input \name\fR
+\fBspeech\-input \name\fR
The file system object which gives other applications access to
.BR brltty 's
-speech driver for text-to-speech conversion.
+speech driver for text\-to\-speech conversion.
See the
-.B -i
-.RB "(" "--speech-input=" ")"
+.B \-i
+.RB "(" "\-\-speech\-input=" ")"
option for details.
.TP
-\fBspeech-parameters \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR...
+\fBspeech\-parameters \fR[\fIdriver\fB:\fR]\fIname\fB=\fIvalue\fB,\fR...
Parameters for the speech synthesizer driver.
See the
-.B -S
-.RB "(" "--speech-parameters=" ")"
+.B \-S
+.RB "(" "\-\-speech\-parameters=" ")"
option for details.
.TP
-\fBtext-table \fItable\fR
+\fBtext\-table \fItable\fR
The text table.
See the
-.B -t
-.RB "(" "--text-table=" ")"
+.B \-t
+.RB "(" "\-\-text\-table=" ")"
option for details.
.SS "Driver Specification"
A braille display or speech synthesizer driver