1<page xmlns="http://projectmallard.org/1.0/" type="topic" id="introduction">
2  <info>
3    <link type="guide" xref="index#getting_started" />
4    <link type="next" xref="howto_setting_up_orca" />
5    <title type="sort">1. Welcome to Orca</title>
6    <desc>
7      Introducing the <app>Orca</app> screen reader
8    </desc>
9    <credit type="author">
10      <name>Joanmarie Diggs</name>
11      <email>joanied@gnome.org</email>
12    </credit>
13    <license>
14      <p>Creative Commons Share Alike 3.0</p>
15    </license>
16  </info>
17  <title>Welcome to Orca</title>
18  <p>
19    <app>Orca</app> is a free, open source, flexible, and extensible
20    screen reader that provides access to the graphical desktop via
21    speech and refreshable braille.
22  </p>
23  <p>
24    <app>Orca</app> works with applications and toolkits that support
25    the Assistive Technology Service Provider Interface (AT-SPI), which
26    is the primary assistive technology infrastructure for Linux and
27    Solaris. Applications and toolkits supporting the AT-SPI include
28    Gtk+, Qt, Java Swing, LibreOffice, Gecko, WebKitGtk, and Chrome/Chromium.
29  </p>
30  <section id="launching">
31    <title>Launching <app>Orca</app></title>
32    <p>To launch <app>Orca</app>:</p>
33    <list>
34      <item>
35        <p>
36          The method for configuring <app>Orca</app> to be launched
37          automatically as your preferred screen reader will depend upon
38          which desktop environment you use.
39        </p>
40      </item>
41      <item>
42        <p>
43          To toggle <app>Orca</app> on and off in GNOME, press
44          <keyseq><key>Super</key><key>Alt</key><key>S</key></keyseq>.
45        </p>
46      </item>
47      <item>
48        <p>
49          Type <cmd>orca</cmd>, along with any optional parameters, in a
50          terminal window or within the <gui>Run</gui> dialog and then press
51          <key>Return</key>.
52        </p>
53      </item>
54    </list>
55  </section>
56    <section id="loadtime">
57      <title>Load-Time Options</title>
58      <p>
59        The following options can be specified when launching <app>Orca</app>
60	in a terminal window or within the <gui>Run</gui> dialog:
61      </p>
62      <list>
63        <item>
64          <p><cmd>-h</cmd>, <cmd>--help</cmd>: Show the help message</p>
65        </item>
66        <item>
67          <p>
68            <cmd>-v</cmd>, <cmd>--version</cmd>: Show the version of
69            <app>Orca</app>
70          </p>
71        </item>
72        <item>
73          <p>
74            <cmd>-s</cmd>, <cmd>--setup</cmd>: Set up user preferences
75          </p>
76        </item>
77        <item>
78          <p>
79            <cmd>-u</cmd>, <cmd>--user-prefs=<em>dirname</em></cmd>:
80            Use <em>dirname</em> as the alternate directory for user
81            preferences
82          </p>
83        </item>
84        <item>
85          <p>
86            <cmd>-e</cmd>, <cmd>--enable=<em>option</em></cmd>: Force use
87            of option, where the <em>option</em> can be one of the following:
88          </p>
89          <list>
90            <item><p><cmd>speech</cmd></p></item>
91            <item><p><cmd>braille</cmd></p></item>
92            <item><p><cmd>braille-monitor</cmd></p></item>
93          </list>
94        </item>
95        <item>
96          <p>
97            <cmd>-d</cmd>, <cmd>--disable=<em>option</em></cmd>: Prevent the
98            use of an option, where the <em>option</em> can be one of the
99            following:
100          </p>
101          <list>
102            <item><p><cmd>speech</cmd></p></item>
103            <item><p><cmd>braille</cmd></p></item>
104            <item><p><cmd>braille-monitor</cmd></p></item>
105          </list>
106        </item>
107        <item>
108            <p>
109              <cmd>-p</cmd>, <cmd>--profile=<em>filename</em></cmd>:
110              Import a profile from a given <app>Orca</app> profile file
111            </p>
112        </item>
113        <item>
114          <p>
115            <cmd>-r</cmd>, <cmd>--replace</cmd>: Replace a currently-running <app>Orca</app>
116          </p>
117        </item>
118        <item>
119          <p>
120            <cmd>-l</cmd>, <cmd>--list-apps</cmd>: Print the known running
121            applications
122          </p>
123        </item>
124        <item>
125          <p>
126            <cmd>--debug</cmd>: Send debug output to debug-YYYY-MM-DD-HH:MM:SS.out
127          </p>
128        </item>
129        <item>
130          <p>
131            <cmd>--debug-file=<em>filename</em></cmd>: Send debug output to
132            the specified file
133          </p>
134        </item>
135      </list>
136    </section>
137
138</page>
139