File: orca.1

package info (click to toggle)
orca 50.0.8-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 54,168 kB
  • sloc: python: 119,994; sh: 64; makefile: 5
file content (148 lines) | stat: -rw-r--r-- 4,164 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
.\" Copyright (C) 2005-2009 Sun Microsystems Inc.
.\"
.\" This is free software; you may redistribute it and/or modify
.\" it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2,
.\" or (at your option) any later version.
.\"
.\" This is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this; if not write to the Free Software Foundation, Inc.
.\" 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
'\"
.TH orca 1 "19 February 2026" "GNOME"
.SH NAME
orca \- a scriptable screen reader
.SH SYNOPSIS
.B orca
.RI [ option... ]
.SH DESCRIPTION
.B orca
is a screen reader for people with visual impairments,
it provides alternative access to the desktop by using speech synthesis and braille.
.P
.B orca
works with applications and toolkits that support
the Assistive Technology Service Provider Interface (AT-SPI), which
is the primary assistive technology infrastructure for Linux. Applications
and toolkits supporting the AT-SPI include the GNOME GTK toolkit,
the Java platform's Swing toolkit, LibreOffice, Gecko, WebKitGTK, and Qt.
.SH OPTIONS
.TP
.B \-h, \-\-help
Display help message and exit.
.TP
.B \-v, \-\-version
Print version information and exit.
.TP
.B \-r, \-\-replace
Replace a currently running
.B orca
process. By default, if
.B orca
detects an existing
.B orca
process for the same session, it will not start a new
.B orca
process. This option will kill and clean up after any existing
.B orca
process and then start a new
.B orca
in its place.
.TP
.B \-s, \-\-setup
Set up user preferences using the GUI. If
.B orca
is already running, the preferences dialog will be shown
in the running instance.
.TP
.B \-l, \-\-list\-apps
Print the known running applications. This
is used primarily for debugging purposes to see if
.B orca
can talk to the accessibility infrastructure. Note that if
.B orca
is already running, this will not kill the other
.B orca
process. It will just list the currently running applications,
and you will see
.B orca
listed twice: once for the existing
.B orca
and once for this instance.
.TP
.BI "\-p, \-\-profile " NAME
Load the specified user profile.
.TP
.BI "\-i, \-\-import\-dir " DIR
Import settings from
.I DIR
into dconf, overwriting current settings.
This is primarily intended for migration purposes.
.TP
.BI "\-\-speech\-system " NAME
Use the specified speech system.
.TP
.B \-\-debug
Enable debug output for
.B orca
and send all debug output to a file with a name of the
form 'debug\-YYYY\-MM\-DD\-HH:MM:SS.out' in the current directory.
The YYYY\-MM\-DD\-HH:MM:SS portion will be replaced with the current
date and time.
.TP
.BI "\-\-debug\-file " FILE
Enable debug output for
.B orca
and send all debug output to the given
.IR FILE .

.SH KEYBOARD SETTINGS
Orca provides two keyboard modes, Desktop and Laptop keyboard layout.
.B Orca
uses the desktop's default keyboard shortcuts to navigate and interact with
applications. Use learn mode to discover all available commands.
.P
The following key bindings use the
.B Orca_Modifier
key, which is
.B Insert
in desktop keyboard layout and
.B Caps_Lock
in laptop keyboard layout.
.TP
.B Orca_Modifier+H
Enter learn mode. Press Escape to exit.
.TP
.B Orca_Modifier+Space
Open the preferences dialog.
.TP
.B Orca_Modifier+Ctrl+Space
Open the preferences dialog for the current application.

.SH FILES
.TP
.I ~/.local/share/orca/
User preferences directory.
.TP
.I ~/.local/share/orca/orca\-customizations.py
User customizations configuration file.
.TP
.I ~/.local/share/orca/orca\-scripts/
User scripts directory.


.SH AUTHOR
.B Orca
originated as a community effort led by the Sun Microsystems Inc.
Accessibility Program Office and with contributions from many community members.
.SH SEE ALSO
.IP \(bu 2
.B Orca repository and issue tracker
.UR https://gitlab.gnome.org/GNOME/orca
<https://gitlab.gnome.org/GNOME/orca>
.UE