mirror of
https://github.com/torvalds/linux.git
synced 2024-12-27 13:22:23 +00:00
Documentation/braille-console: convert it to ReST markup
- Fix identation for the document title; - use monotonic fonts for paths; - use quote blocks where needed; - adjust spaces to properly format paragraphs; - use :menuselection: and :kbd: for the menu item and keys; - point too the right item at the menu; - add it to the user book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
c2ffd5dafa
commit
8e7fbec662
@ -1,33 +1,37 @@
|
|||||||
Linux Braille Console
|
Linux Braille Console
|
||||||
|
=====================
|
||||||
|
|
||||||
To get early boot messages on a braille device (before userspace screen
|
To get early boot messages on a braille device (before userspace screen
|
||||||
readers can start), you first need to compile the support for the usual serial
|
readers can start), you first need to compile the support for the usual serial
|
||||||
console (see serial-console.txt), and for braille device (in Device Drivers -
|
console (see :ref:`Documentation/serial-console.txt <serial_console>`), and
|
||||||
Accessibility).
|
for braille device
|
||||||
|
(in :menuselection:`Device Drivers --> Accessibility support --> Console on braille device`).
|
||||||
|
|
||||||
Then you need to specify a console=brl, option on the kernel command line, the
|
Then you need to specify a ``console=brl``, option on the kernel command line, the
|
||||||
format is:
|
format is::
|
||||||
|
|
||||||
console=brl,serial_options...
|
console=brl,serial_options...
|
||||||
|
|
||||||
where serial_options... are the same as described in serial-console.txt
|
where ``serial_options...`` are the same as described in
|
||||||
|
:ref:`Documentation/serial-console.txt <serial_console>`.
|
||||||
|
|
||||||
So for instance you can use console=brl,ttyS0 if the braille device is connected
|
So for instance you can use ``console=brl,ttyS0`` if the braille device is connected to the first serial port, and ``console=brl,ttyS0,115200`` to
|
||||||
to the first serial port, and console=brl,ttyS0,115200 to override the baud rate
|
override the baud rate to 115200, etc.
|
||||||
to 115200, etc.
|
|
||||||
|
|
||||||
By default, the braille device will just show the last kernel message (console
|
By default, the braille device will just show the last kernel message (console
|
||||||
mode). To review previous messages, press the Insert key to switch to the VT
|
mode). To review previous messages, press the Insert key to switch to the VT
|
||||||
review mode. In review mode, the arrow keys permit to browse in the VT content,
|
review mode. In review mode, the arrow keys permit to browse in the VT content,
|
||||||
page up/down keys go at the top/bottom of the screen, and the home key goes back
|
:kbd:`PAGE-UP`/:kbd:`PAGE-DOWN` keys go at the top/bottom of the screen, and
|
||||||
|
the :kbd:`HOME` key goes back
|
||||||
to the cursor, hence providing very basic screen reviewing facility.
|
to the cursor, hence providing very basic screen reviewing facility.
|
||||||
|
|
||||||
Sound feedback can be obtained by adding the braille_console.sound=1 kernel
|
Sound feedback can be obtained by adding the ``braille_console.sound=1`` kernel
|
||||||
parameter.
|
parameter.
|
||||||
|
|
||||||
For simplicity, only one braille console can be enabled, other uses of
|
For simplicity, only one braille console can be enabled, other uses of
|
||||||
console=brl,... will be discarded. Also note that it does not interfere with
|
``console=brl,...`` will be discarded. Also note that it does not interfere with
|
||||||
the console selection mechanism described in serial-console.txt
|
the console selection mechanism described in
|
||||||
|
:ref:`Documentation/serial-console.txt <serial_console>`.
|
||||||
|
|
||||||
For now, only the VisioBraille device is supported.
|
For now, only the VisioBraille device is supported.
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _serial_console:
|
||||||
|
|
||||||
Linux Serial Console
|
Linux Serial Console
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user