File: AttributesTables.html

package info (click to toggle)
brltty 6.8-4
links: PTS, VCS
area: main
in suites: forky, sid
size: 35,776 kB
sloc: ansic: 150,447; java: 13,484; sh: 9,667; xml: 5,702; tcl: 2,634; makefile: 2,328; awk: 713; lisp: 366; python: 321; ml: 301
file content (513 lines) | stat: -rw-r--r-- 13,038 bytes
parent folder | download | duplicates (2)
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" />
<title>Attributes Tables</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

.subscript {
  vertical-align: sub;
  font-size: smaller }

.superscript {
  vertical-align: super;
  font-size: smaller }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

table.align-center {
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

.align-top    {
  vertical-align: top }

.align-middle {
  vertical-align: middle }

.align-bottom {
  vertical-align: bottom }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="attributes-tables">
<h1 class="title">Attributes Tables</h1>

<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#description" id="toc-entry-1">Description</a></li>
<li><a class="reference internal" href="#directives" id="toc-entry-2">Directives</a><ul>
<li><a class="reference internal" href="#the-dot-directive" id="toc-entry-3">The Dot Directive</a></li>
<li><a class="reference internal" href="#the-include-directive" id="toc-entry-4">The Include Directive</a></li>
</ul>
</li>
<li><a class="reference internal" href="#attributes-table-list" id="toc-entry-5">Attributes Table List</a></li>
</ul>
</div>
<div class="section" id="description">
<h2><a class="toc-backref" href="#toc-entry-1">Description</a></h2>
<p>Files with names of the form <tt class="docutils literal">*.atb</tt> are attributes tables, and with names of
the form <tt class="docutils literal">*.ati</tt> are attributes subtables. They are used when BRLTTY is
displaying screen attributes rather than screen content. Each of the eight
braille dots represents one of the eight VGA attribute bits.</p>
<p>Attributes tables can usually be found in the <tt class="docutils literal">/etc/brltty/Attributes/</tt>
directory (see <a class="reference external" href="Customize.html">Local Customization</a> for more details). See
<a class="reference internal" href="#attributes-table-list">Attributes Table List</a> for a list of BRLTTY's attributes tables.</p>
<p>An attributes table consists of a sequence of directives, one per line, which
define how combinations of VGA attributes are to be represented in braille.
UTF-8 character encoding must be used. Whitespace (blanks, tabs) at the
beginning of a line, as well as before and/or after any operand of any
directive, is ignored. Lines containing only whitespace are ignored. If the
first non-whitespace character of a line is <tt class="docutils literal">#</tt> then that line is a comment
and is ignored.</p>
</div>
<div class="section" id="directives">
<h2><a class="toc-backref" href="#toc-entry-2">Directives</a></h2>
<div class="section" id="the-dot-directive">
<h3><a class="toc-backref" href="#toc-entry-3">The Dot Directive</a></h3>
<pre class="literal-block">
dot <em>dot</em> <em>state</em> # <em>comment</em>
</pre>
<p>Use this directive to specify what a specific dot represents. The default is
that all dots are down and not used to represent anything.</p>
<dl class="docutils">
<dt><em>dot</em></dt>
<dd>The dot being defined. It is a single digit within the range <tt class="docutils literal">1</tt>-<tt class="docutils literal">8</tt> as
defined by the standard braille dot numbering convention (see
<a class="reference external" href="BrailleDots.html">Braille Dots</a> for details).</dd>
<dt><em>state</em></dt>
<dd><p class="first">What the dot being defined represents. It may be:</p>
<dl class="last docutils">
<dt>=attribute</dt>
<dd>The dot is raised if the named attribute is on.</dd>
<dt>~attribute</dt>
<dd>The dot is raised if the named attribute is off.</dd>
</dl>
</dd>
</dl>
<p>The attributes are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="45%" />
<col width="15%" />
<col width="40%" />
</colgroup>
<tbody valign="top">
<tr><td>Name</td>
<td>Hex</td>
<td>binary</td>
</tr>
<tr><td>fg-blue</td>
<td>01</td>
<td>00000001</td>
</tr>
<tr><td>fg-green</td>
<td>02</td>
<td>00000010</td>
</tr>
<tr><td>fg-red</td>
<td>04</td>
<td>00000100</td>
</tr>
<tr><td>fg-bright</td>
<td>08</td>
<td>00001000</td>
</tr>
<tr><td>bg-blue</td>
<td>10</td>
<td>00010000</td>
</tr>
<tr><td>bg-green</td>
<td>20</td>
<td>00100000</td>
</tr>
<tr><td>bg-red</td>
<td>40</td>
<td>01000000</td>
</tr>
<tr><td>blink</td>
<td>80</td>
<td>10000000</td>
</tr>
</tbody>
</table>
<p>Examples:</p>
<pre class="literal-block">
dot 1 =fg-red
dot 2 ~bg-blue
</pre>
</div>
<div class="section" id="the-include-directive">
<h3><a class="toc-backref" href="#toc-entry-4">The Include Directive</a></h3>
<pre class="literal-block">
include <em>file</em> # <em>comment</em>
</pre>
<p>Use this directive to include the content of another file. It is recursive,
which means that an included file can itself include yet another file.
Care must be taken to ensure that an &quot;include loop&quot; is not created.</p>
<dl class="docutils">
<dt><em>file</em></dt>
<dd>The file to be included. It may be either a relative or an absolute path. If
relative, it is anchored at the directory containing the including file.</dd>
</dl>
</div>
</div>
<div class="section" id="attributes-table-list">
<h2><a class="toc-backref" href="#toc-entry-5">Attributes Table List</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">name</th>
<th class="head">description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>left_right</td>
<td>foreground colour in the left column and background colour in the right column</td>
</tr>
<tr><td>invleft_right</td>
<td>inverse foreground colour in the left column and background colour in the right column</td>
</tr>
<tr><td>upper_lower</td>
<td>foreground colour in the upper square and background colour in the lower square</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>