Debian Codegraph @

docs/orca.1

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