BrlAPI Reference manual

Sébastien Hinderer <sebastien.hinderer@libertysurf.fr>

Samuel Thibault <samuel.thibault@fnac.net>

1. Introduction

• 1.1 Concepts
• 1.2 How to read this manual

2. General description of BrlAPI

• 2.1 Historical notes.
• 2.2 Why BrlAPI is part of brltty.
• 2.3 How it works.

3. Installation and configuration BrlAPI

4. Library description

• 4.1 Connecting to BrlAPI
• 4.2 Getting driver id and name
• 4.3 Getting display size
• 4.4 Entering raw mode, immediately leaving raw mode.
• 4.5 Getting tty control
• 4.6 Writing something on the display
• 4.7 Waiting for a key press
• 4.8 Leaving tty control
• 4.9 Disconnecting from BrlAPI
• 4.10 Putting everything together...

5. Writing (BrlAPI-compliant) drivers for brltty

• 5.1 Overview of the driver's structure
• 5.2 Basic driver structure
• 5.3 Enhancements for BrlAPI

6. Protocol reference

• 6.1 Reliable packet transmission channel
• 6.2 Responses from the server
• 6.3 Operating modes
• 6.4 Details for each type of packet