File: BrlAPI.html

package info (click to toggle)
brltty 3.4.1-4
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 6,268 kB
  • ctags: 4,537
  • sloc: ansic: 54,295; sh: 3,470; makefile: 793; tcl: 398; yacc: 300; awk: 57; python: 29
file content (79 lines) | stat: -rw-r--r-- 3,374 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
 <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20">
 <TITLE>BrlAPI Reference manual</TITLE>
 <LINK HREF="BrlAPI-1.html" REL=next>


</HEAD>
<BODY>
<A HREF="BrlAPI-1.html">Next</A>
Previous
Contents
<HR>
<H1>BrlAPI Reference manual</H1>

<H2>Sbastien Hinderer <CODE>
<A HREF="mailto:sebastien.hinderer@libertysurf.fr">&lt;sebastien.hinderer@libertysurf.fr&gt;</A></CODE><BR></H2>
<H2>Samuel Thibault <CODE>
<A HREF="mailto:samuel.thibault@fnac.net">&lt;samuel.thibault@fnac.net&gt;</A></CODE><BR></H2>V1.0, June 2003
<HR>
<EM>This document describes how to use <CODE>BrlAPI</CODE>.</EM>
<HR>
<P>
<H2><A NAME="toc1">1.</A> <A HREF="BrlAPI-1.html">Introduction</A></H2>

<UL>
<LI><A NAME="toc1.1">1.1</A> <A HREF="BrlAPI-1.html#ss1.1">Concepts</A>
<LI><A NAME="toc1.2">1.2</A> <A HREF="BrlAPI-1.html#ss1.2">How to read this manual</A>
</UL>
<P>
<H2><A NAME="toc2">2.</A> <A HREF="BrlAPI-2.html">General description of <EM>BrlAPI</EM></A></H2>

<UL>
<LI><A NAME="toc2.1">2.1</A> <A HREF="BrlAPI-2.html#ss2.1">Historical notes.</A>
<LI><A NAME="toc2.2">2.2</A> <A HREF="BrlAPI-2.html#ss2.2">Why <EM>BrlAPI</EM> is part of <EM>brltty</EM>.</A>
<LI><A NAME="toc2.3">2.3</A> <A HREF="BrlAPI-2.html#ss2.3">How it works.</A>
</UL>
<P>
<H2><A NAME="toc3">3.</A> <A HREF="BrlAPI-3.html">Installation and configuration <EM>BrlAPI</EM></A></H2>

<P>
<H2><A NAME="toc4">4.</A> <A HREF="BrlAPI-4.html">Library description</A></H2>

<UL>
<LI><A NAME="toc4.1">4.1</A> <A HREF="BrlAPI-4.html#ss4.1">Connecting to <EM>BrlAPI</EM></A>
<LI><A NAME="toc4.2">4.2</A> <A HREF="BrlAPI-4.html#ss4.2">Getting driver id and name</A>
<LI><A NAME="toc4.3">4.3</A> <A HREF="BrlAPI-4.html#ss4.3">Getting display size</A>
<LI><A NAME="toc4.4">4.4</A> <A HREF="BrlAPI-4.html#ss4.4">Entering raw mode, immediately leaving raw mode.</A>
<LI><A NAME="toc4.5">4.5</A> <A HREF="BrlAPI-4.html#ss4.5">Getting tty control</A>
<LI><A NAME="toc4.6">4.6</A> <A HREF="BrlAPI-4.html#ss4.6">Writing something on the display</A>
<LI><A NAME="toc4.7">4.7</A> <A HREF="BrlAPI-4.html#ss4.7">Waiting for a key press</A>
<LI><A NAME="toc4.8">4.8</A> <A HREF="BrlAPI-4.html#ss4.8">Leaving tty control</A>
<LI><A NAME="toc4.9">4.9</A> <A HREF="BrlAPI-4.html#ss4.9">Disconnecting from <EM>BrlAPI</EM></A>
<LI><A NAME="toc4.10">4.10</A> <A HREF="BrlAPI-4.html#ss4.10">Putting everything together...</A>
</UL>
<P>
<H2><A NAME="toc5">5.</A> <A HREF="BrlAPI-5.html">Writing (<EM>BrlAPI</EM>-compliant) drivers for <EM>brltty</EM></A></H2>

<UL>
<LI><A NAME="toc5.1">5.1</A> <A HREF="BrlAPI-5.html#ss5.1">Overview of the driver's structure</A>
<LI><A NAME="toc5.2">5.2</A> <A HREF="BrlAPI-5.html#ss5.2">Basic driver structure</A>
<LI><A NAME="toc5.3">5.3</A> <A HREF="BrlAPI-5.html#ss5.3">Enhancements for <EM>BrlAPI</EM></A>
</UL>
<P>
<H2><A NAME="toc6">6.</A> <A HREF="BrlAPI-6.html">Protocol reference</A></H2>

<UL>
<LI><A NAME="toc6.1">6.1</A> <A HREF="BrlAPI-6.html#ss6.1">Reliable packet transmission channel</A>
<LI><A NAME="toc6.2">6.2</A> <A HREF="BrlAPI-6.html#ss6.2">Responses from the server</A>
<LI><A NAME="toc6.3">6.3</A> <A HREF="BrlAPI-6.html#ss6.3">Operating modes</A>
<LI><A NAME="toc6.4">6.4</A> <A HREF="BrlAPI-6.html#ss6.4">Details for each type of packet</A>
</UL>
<HR>
<A HREF="BrlAPI-1.html">Next</A>
Previous
Contents
</BODY>
</HTML>