Screen reader for individuals who are blind or visually impaired

Kjartan Maraas 36bef45573 Updated Norwegian bokmål translation. 1 week ago
docs 87ad4a2ea1 Fix typo in docs (pytaspi -> pyatspi). 1 year ago
help 7bbe675638 Updated Czech translation 2 weeks ago
icons 67179fbff2 Distribute symbolic icon 2 years ago
m4 05a9c58205 Add pkg.m4 and yelp.m4 to .gitignore 2 years ago
po 36bef45573 Updated Norwegian bokmål translation. 1 week ago
src cea0b75de3 Don't clear the oldFocus even if it's a Zombie when locusOfFocus changes 2 weeks ago
test 89fb65336a Python 3.6 invalid escape sequence deprecation fixes 8 months ago
.cvsignore fdf01ce7b1 Add orca.desktop. 11 years ago
.gitignore d5c72bb358 Add /help/*/*.stamp to .gitignore 4 years ago
AUTHORS fa133df521 Update AUTHORS and MAINTAINERS 7 years ago
COPYING ef3057da93 Upgrade from LGPLv2 to LGPLv2.1. 7 years ago
ChangeLog d461ff3c1e Autogenerate ChangeLog 8 years ago
ChangeLog-pre-2.27.1 d461ff3c1e Autogenerate ChangeLog 8 years ago
HACKING c96465d284 Administrivia 12 years ago
MAINTAINERS ef7c01b7d7 Updating the maintainers 5 years ago
Makefile.am 500d4ca4a9 Remove .desktop file 1 year ago
NEWS 9d1c2647d9 Prep for 3.26.0 release 2 months ago
QUICKSTART c1b2095940 doap: update URLs 3 years ago
README 3d8d7ec6fb Post-release version bump 2 months ago
RELEASE-HOWTO c1b2095940 doap: update URLs 3 years ago
TODO 8123f82da4 Prep for Orca v1.0.0. 11 years ago
acinclude.m4 0c0be16f1a Avoid incorrectly detecting python modules which are in fact not installed 5 years ago
autogen.sh 5431054194 Support non-srcdir builds in autogen.sh 1 year ago
configure.ac 3d8d7ec6fb Post-release version bump 2 months ago
orca-autostart.desktop.in efa3af6624 Tweak for the fix for bug 736237 - Enable autostart on additional DEs 3 years ago
orca.doap 7c21c1edaa doap: add <programming-language> 3 years ago
pylintrc 0ad23286db Spelling fixes 8 months ago
run_pylint.sh.in 3abf4d6c19 Updated run_pylint.sh to work with git. 8 years ago

README

Orca v3.26.1pre

Introduction
========================================================================

Orca is a free, open source, flexible, and extensible screen reader
that provides access to the graphical desktop via user-customizable
combinations of speech and/or braille.

Orca works with applications and toolkits that support the assistive
technology service provider interface (AT-SPI), which is the primary
assistive technology infrastructure for the Solaris and Linux
operating environments. Applications and toolkits supporting the
AT-SPI include the GNOME GTK+ toolkit, the Java platform's Swing
toolkit, OpenOffice/LibreOffice, Gecko, and WebKitGtk. AT-SPI support
for the KDE Qt toolkit is currently being pursued.

See also http://wiki.gnome.org/Projects/Orca for detailed English and Spanish
information on Orca, including how to run Orca, how to communicate
with the Orca user community, and where to log bugs and feature
requests.

Dependencies
========================================================================

Orca v3.26.x is supported on GNOME 3.26.x only. We highly suggest you
use the latest releases of GNOME because they contain accessibility
infrastructure and application bug fixes that help Orca work better.

Orca also has the following dependencies:

* Python - Python platform (minimum version 3.3)
* pygobject-3.0 - Python bindings for the GObject library
* gtk+-3.0 - GTK+ toolkit
* json-py - a JSON (http://json.org) reader and writer in Python
* python-speechd - Python bindings for Speech Dispatcher (optional)
* BrlTTY - BrlTTY support for braille (optional)
* BrlAPI - BrlAPI support for braille (optional)
* py-setproctitle - Python library to set the process title (optional)
* gstreamer-1.0 - GStreamer - Streaming media framework (optional)

YOU ALSO NEED THE LATEST AT-SPI2, PYATSPI2 AND ATK FOR THE GNOME 3.26.x
RELEASES. THEY CONTAIN VERY IMPORTANT BUG FIXES!

NOTE: If you have multiple versions of the Python interpreter installed
on your machine, you should set the PYTHON environment variable when
configuring Orca. For example:

PYTHON=/usr/bin/python3.3 ./autogen.sh

or

PYTHON=/usr/bin/python3.3 ./configure

NOTE FOR BRLTTY USERS:
========================================================================

Orca depends upon the Python bindings for BrlAPI available in BrlTTY v4.5
or better. You can determine if the Python bindings for BrlAPI are
installed by running the following command:

python -c "import brlapi"

If you get an error, the Python bindings for BrlAPI are not installed.

See also http://wiki.gnome.org/Projects/Orca/Braille for more information on
BrlTTY and also using liblouis for contracted braille.

Running Orca
========================================================================

If you wish to modify your Orca preferences, you can press "Insert+space"
while Orca is running.

To get help while running Orca, press "Insert+H". This will enable
"learn mode", which provides a spoken and brailled description of what
various keyboard and braille input device actions will do. To exit
learn mode, press "Escape." Finally, the preferences dialog contains
a "Key Bindings" tab that lists the keyboard binding for Orca.

For more information, see the Orca documentation which is available
within Orca as well as at: http://library.gnome.org/users/orca/stable

Scripting Orca
========================================================================

So, you want to write a script for Orca? The best thing to do is
start by looking at other scripts under the src/orca/scripts/ hierarchy
of the source tree. Also, the docs/doc-set/internals.html file contains
detailed information about the internal workings of Orca.