man-pages/man1/xbrlapi.1.html
2021-03-31 01:06:50 +01:00

101 lines
2.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XBRLAPI</TITLE>
</HEAD><BODY>
<H1>XBRLAPI</H1>
Section: BrlAPI User's Manual (1)<BR>Updated: 2019-02-22<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
xbrlapi - X11 BrlAPI helper for Linux/Unix
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>xbrlapi</B> [<I>option</I> ...]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>xbrlapi</B>
connects to a
<B>BrlAPI</B>
server in order to provide it with the ID of the
<B>X11</B>
window which currently has focus.
It also simulates
<B>X</B>
keysyms from braille key presses (else brltty would simulate them using a qwerty
keyboard).
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
Options are processed sequentially from left to right.
If an option is specified more than once,
or in case of a conflict,
the rightmost specification takes precedence.
<P>
The following options are supported:
<DL COMPACT>
<DT id="1"><B>-b</B> [<I>host</I>][:<I>port</I>] (<B>--brlapi=</B>)<DD>
The
<B>BrlAPI</B>
server to connect to.
<DT id="2"><B>-a</B> <I>string</I> (<B>--auth=</B>)<DD>
The
<B>BrlAPI</B>
authorization/authentication string.
<DT id="3"><B>-d</B> <I>display</I> (<B>--display=</B>)<DD>
The
<B>X</B>
display to connect to.
If not specified, the content of the
<B>DISPLAY</B>
environment variable is used.
<DT id="4"><B>-q</B> (<B>--quiet</B>)<DD>
Do not write any text to the braille device.
<DT id="5"><B>-h</B> (<B>--help</B>)<DD>
Print a command line usage summary and then exit.
<DT id="6"><B>-H</B> (<B>--full-help</B>)<DD>
Print a thorough command line usage summary and then exit.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
For more details on the purpose of
<B>xbrlapi</B>,
see
<B>BrlAPI</B>'s
on-line manual at
[<B><A HREF="http://brltty.app/doc/Manual-BrlAPI/English/BrlAPI-3.html">http://brltty.app/doc/Manual-BrlAPI/English/BrlAPI-3.html</A></B>].
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="7"><A HREF="#lbAB">NAME</A><DD>
<DT id="8"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="9"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="10"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="11"><A HREF="#lbAF">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:30 GMT, March 31, 2021
</BODY>
</HTML>