10139N/A<!
DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
11913N/A<!
ENTITY suncopy "Copyright (c) 2004,2007 Sun Microsystems, Inc. All Rights Reserved.">
10139N/A<
refmeta><
refentrytitle>orca</
refentrytitle><
manvolnum>1</
manvolnum>
11913N/A<
refmiscinfo class="date">12 Nov 2007</
refmiscinfo>
10139N/A<
refmiscinfo class="sectdesc">&man1;</
refmiscinfo>
10139N/A<
refmiscinfo class="software">&release;</
refmiscinfo>
10139N/A<
refmiscinfo class="arch">generic</
refmiscinfo>
10139N/A<
refmiscinfo class="copyright">&suncopy;</
refmiscinfo>
10139N/A<
indexterm><
primary>orca</
primary></
indexterm>
10139N/A<
indexterm><
primary></
primary></
indexterm>
10139N/A<
refnamediv id="orca-1-name"><
refname>orca</
refname><
refpurpose>a screen reader / magnifier</
refpurpose></
refnamediv>
10139N/A<
refsynopsisdiv id="orca-1-synp"><
title>&synp-tt;</
title>
10139N/A<
cmdsynopsis><
command>&cmd;</
command>
10139N/A<
arg><
option>-gui-setup</
option></
arg>
10139N/A<
arg><
option>-text-setup</
option></
arg>
10139N/A<
arg><
option>-no-setup</
option></
arg>
11913N/A<
arg><
option>-disable=<
replaceable>options</
replaceable></
arg>
11913N/A<
arg><
option>-enable=<
replaceable>options</
replaceable></
arg>
11913N/A<
arg><
option>-user-prefs-dir</
option></
arg>
10139N/A<
arg><
option>-help</
option></
arg>
10139N/A<
arg><
option>-version</
option></
arg>
10139N/A<
arg><
option>-quit</
option></
arg>
10139N/A<
refsect1 id="orca-1-desc"><
title>&desc-tt;</
title>
11913N/A<
para>&cmd; is a screen reader for people with visual impairments,
10139N/Aand provides alternative access to the desktop by making use
10139N/Aof speech synthesis, braille, and magnification support on
11913N/A<
para>In addition, &cmd; only provides access to
10139N/Aservice provide interface (AT-SPI), which include GTK,
10139N/AMozilla, Firefox, Evolution, OpenOffice, StarOffice,
10139N/A<
refsect1 id="orca-1-opts"><
title>&opts-tt;</
title>
10139N/A<
para>The following options are supported:</
para>
11913N/A<
variablelist termlength="fullscreen">
11913N/A<
term><
option>s</
option>, <
option>-gui-setup</
option>, <
option>-setup</
option></
term>
11913N/AWhen starting &cmd; bring up the GUI configuration dialog.
11913N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>t</
option>, <
option>-text-setup</
option></
term>
11913N/AWhen starting &cmd; initiate the text-based configuration.
10139N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>n</
option>, <
option>-no-setup</
option></
term>
11913N/AWhen starting &cmd; force the application to be started without
11913N/Aconfiguration, even though it might have needed it. This is useful
11913N/Awhen starting &cmd; via something like gdm.
11913N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>u</
option>, <
option>-user-prefs-dir=<
replaceable>directory</
replaceable></
option></
term>
11913N/AWhen starting &cmd;, specify the <
replaceable>directory</
replaceable> as
11913N/Aan alternate directory for the user preferences.
10139N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>e</
option>, <
option>-enable=<
replaceable>speech|braille-monitor|magnifier|main-window</
replaceable></
option></
term>
11913N/AWhen starting &cmd;, force the enabling of the supplied options.
11913N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>d</
option>, <
option>-disable=<
replaceable>speech|braille-monitor|magnifier|main-window</
replaceable></
option></
term>
11913N/AWhen starting &cmd;, force the disabling of the supplied options.
10139N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>?</
option>, <
option>h</
option>, <
option>-help</
option></
term>
11913N/AShow the help message of this release of the &cmd; program.
10139N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>v</
option>, <
option>-version</
option></
term>
11913N/AReturn the &cmd; version number.
10139N/A</
para></
listitem></
varlistentry>
11913N/A<
term><
option>q</
option>, <
option>-quit</
option></
term>
10139N/A</
para></
listitem></
varlistentry>
10139N/A<
refsect1 id="orca-1-exde"><
title>&exde-tt;</
title>
11913N/AIn order for the "Accessible GNOME Desktop" to be accessible
10139N/Ato users who are blind or have low vision, users will need to
10139N/Aemploy an assistive technology (AT) that exposes the graphical
10139N/Adesktop information encoded in the GNOME Accessibility Framework.
10139N/Ato adapt and customize their assistive technology solutions - both
10139N/Ato improve the efficiency of their blind users (to help make up for
10139N/Adisadvantages inherent in not being able to "see" the entire screen
10139N/Aimmediately at a glace), and also to "work around" poorly designed
10139N/Aand not particularly accessible applications that their blind users
11913N/A&cmd; is an extensible assistive technology that provides end-user
10139N/Aaccess to applications and toolkits that support the GNOME
10139N/AAccessibility Framework. It has been designed with direct continual
10139N/Afeedback from its disability user community.
11913N/A&cmd; uses a "scripting" approach to easily allow customization
10139N/Aper application and provides the ability for each user to further
10139N/Acustomize their AT environment based on their own preferences.
11913N/AThe "scripting" approach of &cmd; provides a much more adaptable
10139N/Aand compelling assistive technology solution than existing AT
11913N/AFunctionally &cmd; does 4 major things:
10139N/APresent information to the user via speech synthesis
10139N/A(text-to-speech), or refreshable braille (hardware connected
10139N/Ato serial or USB port), or a magnified image on the user's display.
10139N/AAcquire information from the applications and desktop
10139N/Agraphical display via the GNOME Accessibility Framework.
10139N/ATrack events occurring in the applications and desktop
10139N/Agraphical display via the GNOME Accessibility Framework.
10139N/AIntercept and optionally consume user input events from
10139N/Athe system keyboard and the buttons on a refreshable braille
11913N/Adisplay. Based on the input, &cmd; will either pass the
10139N/Aevent on to the application for normal processing, execute
11913N/A&cmd;-specific commands (such as reading the next line in the
10139N/Adisplay or panning the braille display), or perform operations
10139N/Aon application objects (such as clicking buttons or modifying text areas).
10139N/Abe a collection of building blocks that comprise screen reading and
10139N/Amagnification technology, including use of text-to-speech, braille
10139N/Aand mouse interception modules, and event coalescing.
10139N/Abe developed with the standard GNOME build environment.
10139N/Asupport multiple braille displays.
10139N/Asupport the gnome-speech module for text-to-speech.
10139N/Aintercept keyboard & mouse events through the GNOME
10139N/AAccessibility Framework and other supported X mechanisms.
10139N/Asupport the gnome-mag module to provide end-user magnification
10139N/Aof the screen between 2 and 16 times magnification in integer increments.
10139N/Arender its own graphical user interface using GTK+ widgets.
10139N/Aprovide a scripting mechanism, giving it the ability to customize how
11913N/Aeach application on the JDS desktop is handled by &cmd;.
10139N/Aprovide further customization on a per-user basis.
11913N/A<
para>&cmd; provides a set of its own keyboard commands.
11913N/ANote that you can always enter &cmd;'s "learn mode" while running &cmd; by
11913N/Apressing Insert+F1. When in learn mode, &cmd; will intercept all keyboard
10139N/Aand braille input events and will tell you what the effect of them would
10139N/Abe. To exit learn mode, press the escape key.
10139N/A<
para>Commands for adjusting speech parameters</
para>
10139N/A<
variablelist termlength="small">
10139N/A<
varlistentry><
term><
option> Insert-right arrow</
option></
term>
10139N/A<
listitem><
para>increase speech rate</
para></
listitem>
10139N/A<
varlistentry><
term><
option> Insert-left arrow</
option></
term>
10139N/A<
listitem><
para>decrease speech rate</
para></
listitem>
10139N/A<
varlistentry><
term><
option> Insert-up arrow</
option></
term>
10139N/A<
listitem><
para>raise the pitch</
para></
listitem>
10139N/A<
varlistentry><
term><
option> Insert-down arrow</
option></
term>
10139N/A<
listitem><
para>decrease the pitch</
para></
listitem>
10139N/A<
para>Flat review commands</
para>
10139N/A<
variablelist termlength="narrow">
10139N/A<
varlistentry><
term><
option> Numpad-7</
option></
term>
10139N/A<
para>move the flat review cursor to the previous line, and read it.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-8</
option></
term>
10139N/A<
para>read the current line.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-9</
option></
term>
10139N/A<
para>move the flat review cursor to the next line, and read it.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-4</
option></
term>
10139N/A<
para>move the flat review cursor to the previous word, and read it.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-5</
option></
term>
10139N/A<
para>read the current word.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-6</
option></
term>
10139N/A<
para>move the flat review cursor to the next word, and read it.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-1</
option></
term>
10139N/A<
para>move the flat review cursor to the previous character, and read it.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-2</
option></
term>
10139N/A<
para>read the current character.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-3</
option></
term>
10139N/A<
para>move the flat review cursor to the next character, and read it.</
para>
10139N/A<
varlistentry><
term><
option> Numpad-slash</
option></
term>
10139N/A<
para>perform a left mouse click at the location of the flat review
10139N/A<
varlistentry><
term><
option> Numpad-star</
option></
term>
10139N/A<
para>perform a right mouse click at the location of the flat review
10139N/ANote: the above commands apply when working with objects as well as when
10139N/Aworking with text. For example, if the flat review cursor were positioned
10139N/Aon a menu bar, pressing the read current line command would speak the
10139N/Anames of all visible menus. Similarly, pressing read next word would
10139N/Aspeak the object to the right of the flat review cursor on the same line,
10139N/Aor move flat review to the next line if no more objects were found.
10139N/A<
para>Miscellaneous functions</
para>
10139N/A<
variablelist termlength="small">
10139N/A<
varlistentry><
term><
option> Insert-F1</
option></
term>
10139N/A<
para>enter learn mode (press escape to exit)</
para>
10139N/A<
varlistentry><
term><
option> Insert-f</
option></
term>
10139N/A<
para>speak font and attribute information for the current character.</
para>
10139N/A<
varlistentry><
term><
option> Insert-space</
option></
term>
11913N/A<
para>launch the &cmd; Configuration dialog.</
para>
10139N/A<
varlistentry><
term><
option> Insert-Control-space</
option></
term>
10139N/A<
para>reload user settings and reinitialize services as necessary.</
para>
10139N/A<
varlistentry><
term><
option> Insert-s</
option></
term>
10139N/A<
para>toggle speech on and off</
para>
10139N/A<
varlistentry><
term><
option> Insert-F11</
option></
term>
10139N/A<
para>toggle the reading of tables, either by single cell, or whole row.</
para>
10139N/A<
varlistentry><
term><
option>Insert-q</
option></
term>
10139N/A<
para>Commands for debugging</
para>
10139N/A<
variablelist termlength="narrow">
10139N/A<
varlistentry><
term><
option> Insert-F3</
option></
term>
10139N/A<
para>report information on the currently active script.</
para>
10139N/A<
varlistentry><
term><
option> Insert-F4</
option></
term>
11913N/A<
para>cycle through &cmd;'s various debug levels.</
para>
10139N/A<
varlistentry><
term><
option> Insert-F5</
option></
term>
10139N/A<
para>prints a debug listing of all known applications to the console
10139N/A<
varlistentry><
term><
option> Insert-F7</
option></
term>
10139N/A<
para>prints debug information about the ancestry of the object with
10139N/A<
varlistentry><
term><
option> Insert-F8</
option></
term>
10139N/A<
para>prints debug information about the application with focus.</
para>
11913N/A<
para>Note, in order for the last three commands to be of use, &cmd; needs
10139N/Ato be started from a virtual console or via gnome-terminal. Output is sent
10139N/Ato the console only (
i.e., it is not sent to speech or braille).</
para>
10139N/A<
refsect1 id="orca-1-exit"><
title>&exit-tt;</
title>
10139N/A<
para>The following exit values are returned:</
para>
10139N/A<
variablelist termlength="xtranarrow">
10139N/A<
varlistentry><
term><
returnvalue>0</
returnvalue></
term><
listitem><
para>
10139N/AApplication exited successfully</
para>
10139N/A<
varlistentry><
term><
returnvalue>1</
returnvalue></
term><
listitem><
para>
10139N/AApplication exited with error</
para>
10139N/A<
varlistentry><
term><
returnvalue>2</
returnvalue></
term><
listitem><
para>
11913N/A&cmd; cannot parse its command line options.
10139N/A<
refsect1 id="orca-1-file"><
title>&file-tt;</
title>
10139N/A<
para>The following files are used by this application:</
para>
10139N/A<
variablelist termlength="wide">
10139N/A<
varlistentry><
term><
filename>/
usr/
bin/&cmd;</
filename></
term><
listitem><
para>
11913N/Auser's personal configuration settings for &cmd;</
para>
10139N/A<
refsect1 id="orca-1-attr"><
title>&attr-tt;</
title>
10139N/A<
para>See <
olink targetdocent="REFMAN5" localinfo="attributes-5"><
citerefentry>
10139N/A<
refentrytitle>attributes</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry></
olink>
10139N/Afor descriptions of the following attributes:</
para>
10139N/A<
tgroup cols="2" colsep="1" rowsep="1"><
colspec colname="COLSPEC0" colwidth="1*">
10139N/A<
colspec colname="COLSPEC1" colwidth="1*">
10139N/A<
row><
entry align="center" valign="middle">ATTRIBUTE TYPE</
entry><
entry align="center" 10139N/Avalign="middle">ATTRIBUTE VALUE</
entry></
row>
10139N/A<
row><
entry><
para>Availability</
para></
entry><
entry><
para>SUNWgnome-a11y-orca</
para></
entry>
10139N/A<
row><
entry colname="COLSPEC0"><
para>Interface stability</
para></
entry><
entry 10139N/Acolname="COLSPEC1"><
para>External</
para></
entry></
row>
10139N/A<
refsect1 id="orca-1-also"><
title>&also-tt;</
title>
11913N/A<
citerefentry><
refentrytitle>attributes</
refentrytitle><
manvolnum>5</
manvolnum></
citerefentry>
11913N/A<
para>&cmd; online reference manual.</
para>
10139N/A<
para>Latest version of the <
citetitle>GNOME Accessibility Guide</
citetitle>
10139N/A<
para>Latest version of the <
citetitle>GNOME Desktop User Guide</
citetitle>
10139N/A5</
manvolnum></
citerefentry></
para>
10139N/A<
refsect1 id="orca-1-note"><
title>¬e-tt;</
title>
11913N/A<
para>Written by Rich Burridge, Sun Microsystems Inc., 2006, 2007.</
para>