9 Commits
Author SHA1 Message Date
deedra 6754c8ef6c Fix Wine window title announcements on foreground switches
Wine review establishes navigation ownership and stores the window title
without speaking an activation. The native title controller treated that
metadata as an already announced title, suppressing the introduction when
review focus arrived first. Frame-to-control focus updates also reset the
window title controller, cancelling pending introductions and discarding
duplicate history.

Distinguish Wine review ownership from spoken AT-SPI activations when
classifying and deduplicating native introductions. Use the native Wine
application identity when waiting for committed application preferences,
so introductions remain audible with automatic title changes disabled
while subsequent title changes honor that application's settings.

Separate object focus cleanup from window title cleanup. Wine review
revisions now retain the pending title and its duplicate history; actual
foreground transitions, native window lifecycle cleanup, screen lock,
and shutdown continue to reset title state. Preserve XTerm/Fenrir handoff
and ordinary AT-SPI activation deduplication.

Add regressions for both native/review arrival orders, ordinary Wine
windows and virtual desktop children, duplicate reports, return to the
same window, and application preference handoff. Add a private D-Bus
event-loop test for a frame-to-control focus burst and document focused
verification and live acceptance procedures in tests/window_titles.md.

Validation:
- Confirmed the new title introduction, preference handoff, and private
  focus-burst regressions fail before the fix and pass afterward.
- go test ./... -count=1 passed with local socket access; the sandboxed
  attempt was blocked by Unix and loopback speech fixture sockets.
- Focused Title, WineReview, XTerm, and Foreground tests passed with
  the race detector.
- Private D-Bus TestPrivateWineTitleSurvivesReviewFocusBurst passed
  with the race detector.
- go vet ./internal/app, the reader build, and git diff --check passed.

Installed-reader behavior, real Wine/X11 switching, physical Alt+Tab,
audible speech, and physical Braille acceptance remain pending. The
private fixture uses copied foreground metadata and a real registry,
not a real Wine window. No installed reader was replaced.
2026-10-14 16:38:37 -04:00
Storm Dragon 7f78177786 libreoffice support started, still broken. Some updates to how wine-access gets called. 2026-10-14 16:24:49 -04:00
Storm Dragon 8e76d2341c Fix panning sounds after scrolling. 2026-10-14 12:50:44 -04:00
Storm Dragon b2f558c26c Fixed some tests. 2026-10-14 01:22:04 -04:00
Storm Dragon 6613237233 Code fixes from old cthulhu-go name. 2026-10-14 01:08:50 -04:00
Storm Dragon ee4d50cacc Updated some docs. 2026-10-14 00:55:22 -04:00
Storm Dragon e5049b9f5e Version bump. 2026-10-14 00:22:42 -04:00
Storm Dragon 069fc674dc Cthulhu is no longer a fork. Now it is a screen reader written in Golang. 2026-10-14 00:16:34 -04:00
Storm Dragon a998fe67de Create testing branch with distro packaging only 2026-10-13 22:25:51 -04:00
2182 changed files with 114437 additions and 1361081 deletions

No files matched your search

+16 -49
View File
@@ -1,49 +1,16 @@
ABOUT-NLS
INSTALL
Makefile
Makefile.in
aclocal.m4
autom4te.cache
compile
config.h
config.h.in
config.guess
config.log
config.rpath
config.status
config.sub
configure
debug.out
depcomp
install-sh
intltool-extract.in
intltool-extract
intltool-merge.in
intltool-merge
intltool-update.in
intltool-update
libtool
ltmain.sh
missing
mkinstalldirs
omf.make
orca-autostart.desktop
orca.desktop
orca.spec
py-compile
stamp-h1
xmldocs.make
core
bld
*~
patch.*
[0-9][0-9][0-9][0-9][-]*
# /help
/help/*.omf
/help/*/*.page
!/help/C/*.page
/help/*/*.xml
!/help/C/*.xml
/help/*/*.mo
/help/*/*.stamp
.cache/
build/
dist/
coverage.out
/cthulhu
/cthulhu-braille
/parityledger
__pycache__/
*.py[cod]
.aider.tags.cache.*/
.pytest_cache/
/.codex
/distro-packages/**/*.log
/distro-packages/**/*.pkg.tar.zst
/distro-packages/**/*.pkg.tar.xz
/distro-packages/Arch-Linux/cthulhu-git/*/
+43
View File
@@ -0,0 +1,43 @@
# Repository Guidelines
## Project Structure & Module Organization
Cthulhu is a Go Linux screen reader. `cmd/` contains executables; `internal/` owns reader subsystems. Embedded audio lives in `assets/sounds/`, Tentacle libraries in `sdk/`, native harnesses in `tests/`, and parity records in `testdata/`. Go tests sit beside implementation files. Arch packaging lives in `distro-packages/Arch-Linux/cthulhu-git/`.
## Build, Test, and Development Commands
Use Go 1.24+ with CGO and development libraries listed by the Arch `PKGBUILD`.
- `go build -o build/cthulhu ./cmd/cthulhu`: build the reader.
- `go build -tags brlapi -o build/cthulhu-braille ./cmd/cthulhu-braille`: build the Braille helper.
- `go test ./... -count=1`: run default tests; native cases may skip.
- `go test -tags brlapi ./... -count=1`: run packaging checks.
- `go vet ./...`: check common Go errors.
- `go run ./cmd/parityledger validate testdata/parity-ledger.csv`: validate parity records.
- `./build/cthulhu --check-config`: validate settings; `./build/cthulhu` starts the reader.
## Coding Style & Naming Conventions
Use `gofmt`, exported PascalCase identifiers, private camelCase identifiers, and lowercase packages. Preserve license headers. Follow existing Python conventions; run `shellcheck` for edited shell scripts. Keep complete user-facing messages separate from internal identifiers and preserve deliberate speech/Braille segmentation.
## Behavior & Accessibility Safeguards
Read [CONTRIBUTING.md](CONTRIBUTING.md) for detailed safeguards. Compare accepted behavior with Python on `legacy`; use current Orca as the primary reference for Mozilla and LibreOffice support. Follow [LIBREOFFICE_SUPPORT.md](LIBREOFFICE_SUPPORT.md) for Office integration boundaries. Preserve unrelated work and active diagnostic logs; obtain authorization before replacing a running reader.
Fix regressions in the shared subsystem when appropriate. Identify state ownership, lifetime, reset, and cancellation; keep native callbacks and input/focus handling bounded. Preserve Xorg correctness while allowing capability-based Wayland degradation. Keep Tentacles external and responsive.
Prefer core Go implementations for features users expect from the reader itself; use Tentacles for extensions.
Expose GUI controls through accessibility APIs. Keep outer preferences combo widgets `can-focus=False`; verify Tab/Shift+Tab, popup selection, and Apply/reload. Validate versioned TOML settings through persistence and runtime consumption. Protect passwords; redact private debug output before sharing.
## Testing Guidelines
Use Go's `testing` package, `*_test.go`, and `TestBehavior` functions. Start with the affected package. Use deterministic synchronization and generic fixtures. Native checks need their relevant harness, such as `python3 tests/native_atspi.py`. No numeric coverage target is configured. Report automated, installed-binary, physical-input, audible-speech, and Braille-display checks separately.
## Commit & Pull Request Guidelines
Use short descriptive subjects consistent with history. Confirm the intended target branch; `legacy` preserves Python. Describe behavior, issues, regressions checked, skipped checks, and remaining live acceptance. Human diff review and testing precede submission under the policy in `CONTRIBUTING.md`.
## Guide Maintenance
Update this guide when working rules, repository layout, commands, or verification requirements change. Replace stale guidance instead of appending progress reports; keep detailed procedures in `CONTRIBUTING.md`.
+3 -12
View File
@@ -1,14 +1,5 @@
Cthulhu Authors
Marc Mulcahy
Willie Walker
Mike Pedersen
Rich Burridge
Joanmarie Diggs
Eitan Isaacson
Scott Haeger
Cthulhu authors
Cthulhu authors:
Storm Dragon
Angus Kola
Deedra Waters
+122
View File
@@ -0,0 +1,122 @@
# Contributing to Cthulhu
Read [README.md](README.md) and [AGENTS.md](AGENTS.md) first. Start with a user-visible behavior and reproduce the issue in the current code. The maintained repository is `git.stormux.org/storm/cthulhu`; confirm the intended target branch with the maintainer. The `legacy` branch preserves Python Cthulhu; the current checkout is the Go implementation.
## Proposing a Change
Keep each change to one complete behavior. Describe the reproduction, expected result, affected subsystem, and plausible regressions. A reported application or page is a reproduction case: fix the shared layer when it explains the defect. Use an application-specific script only when a shared fix would be wrong; document and test the exception.
State the Xorg impact. Regressions in Xorg input, focus, event ordering, browser handling, or lifecycle block the change. Wayland support is welcome: use capability checks and graceful degradation, and restrict only features that cannot work correctly. Missing Wayland support alone should not block startup or a contribution preserving Xorg behavior.
Record changed behavior and remaining acceptance gaps in the contribution description; update `testdata/parity-ledger.csv` when relevant. The old Cthulhu-Go migration plan and documentation index are absent here; avoid references to those missing files. Keep durable guidance focused on working rules rather than dated progress reports.
## Development and Architecture
Use Go 1.24 or newer, CGO, `pkg-config`, and development libraries for GTK3, AT-SPI, GStreamer, and X11. Braille builds also require BRLTTY/BrlAPI and liblouis. The Arch `PKGBUILD` lists runtime and build dependencies.
```sh
go build -o build/cthulhu ./cmd/cthulhu
go build -tags brlapi -o build/cthulhu-braille ./cmd/cthulhu-braille
go test ./... -count=1
go test -race ./... -count=1
go test -tags brlapi ./... -count=1
go vet ./...
go build ./cmd/...
go run ./cmd/parityledger validate testdata/parity-ledger.csv
```
Start verification with the affected packages; run broader checks when the change affects shared behavior or before submission where practical. Format edited Go files with `gofmt`; run `shellcheck` for edited shell scripts. Use deterministic tests and synchronization instead of timing sleeps. Keep fixtures generic, without real usernames or personal identifiers.
Before extending application orchestration, an event loop, native callback, or settings mapper, identify the subsystem responsible for the policy. Keep ordering and routing in coordinators and feature policy with its existing owner. Specify the owner, lifetime, reset conditions, and cancellation of new mutable state. Prefer cohesive files in existing packages; avoid unnecessary interfaces or packages. If responsibilities need separating, use a behavior-preserving change. Record any urgent-fix follow-up in the contribution description.
Preserve event order, GLib/cgo ownership, and native lifetimes. Balance key grabs and releases, recover from dead AT-SPI objects, and clean up on shutdown. Keep core input and focus handling bounded and responsive.
Tentacles already use an external process protocol: preserve existing host safeguards and author APIs. Keep runnable implementations in external repositories and leave a new installation's catalog empty until repositories are added. Tentacles must not block input, focus, or speech. Treat cgroup-v2 containment as resource control, not a same-user security sandbox. Preserve HTTPS artifact and SHA-256 verification before atomic package installation.
## Behavioral References and User-Facing Messages
Inspect relevant settings, bindings, speech, Braille, and toolkit behavior before changing user-visible behavior. Read Python reference files without changing branches, for example:
```sh
git show legacy:src/cthulhu/settings.py
```
Use the newer Orca implementation as the first reference for Firefox, Thunderbird, and LibreOffice when available. [LibreOffice support](LIBREOFFICE_SUPPORT.md) describes its integration boundaries and remaining acceptance checks. Reference implementations guide behavior; do not mechanically copy Python class or plugin boundaries. Preserve accepted behavior unless the user chooses a deliberate difference, and describe that difference. Do not modify reference checkouts or installed readers without authorization.
Use complete messages and self-contained labels with placeholders for variable content. Keep internal states, commands, and settings identifiers independent of user-facing wording. Preserve deliberate speech/Braille segmentation, verbosity, and separate role/state announcements. Apply these rules within the change; adding translation infrastructure or sweeping existing strings requires separate scope.
## Accessibility and Settings Verification
Keep GUI controls keyboard reachable and exposed through accessibility APIs. GUI applications must let screen readers announce controls rather than calling Speech Dispatcher themselves. Associate labels with controls and provide accessible names for custom widgets.
For preferences `GtkComboBox` and `GtkComboBoxText`, keep the outer widget's `can-focus` property false so GTK focuses its internal button. Setting it true can trap Tab and Shift+Tab. Fix the property instead of adding key handlers or changing reader grabs. Preserve semantic labels and selected-value presentation; the internal button's AT-SPI `STATE_FOCUSED` alone is insufficient evidence.
For changed preferences, verify:
1. Tab and Shift+Tab through the preceding control, changed control, and following control.
2. Open the popup and change the selection using the keyboard.
3. Apply, close, reopen, and confirm the value persists.
4. Exercise the affected reader behavior and confirm that the saved setting changes runtime output.
Preserve versioned TOML settings. The default file is `$XDG_DATA_HOME/cthulhu/user-settings-go.toml`, with `~/.local/share` used when the variable is unset. Use a separate test configuration when appropriate:
```sh
./build/cthulhu --config /tmp/cthulhu-test-settings.toml --check-config
```
Native `*_native_test.go` checks require fixtures and environment flags. Use the relevant isolated harness in `tests/`, such as `python3 tests/native_atspi.py` or `python3 tests/native_preferences.py`. Shared browser changes also need the relevant browser harness and real-browser regression checks.
Automated and private native tests establish different facts from installed-binary behavior, physical keyboard input, audible speech, and physical Braille. Report which checks actually ran and which remain pending. Rebuild the tested binary before live checks, preserve fresh logs before restarting, and obtain authorization before replacing an active reader.
## Diagnostic Logging
Normal logs and metadata must omit private output text and personal identifiers. Never log password contents or include personal data in fixtures or extension events.
Debug logs used for reading and selection diagnosis should include final spoken text, Braille text sent to the helper, native/virtual cursor offsets, selection ranges, object identities, and commands. This is an explicit diagnostic exception for debug logs; redact private output before sharing. Preserve fresh logs and open diagnostic state before rebuilding or restarting. Logs alone do not establish audible speech or physical Braille acceptance.
## Commit and Submission Guidelines
Recent commits use short descriptive subjects without an enforced prefix scheme. Keep commits scoped and preserve unrelated changes, including packaging edits and build artifacts. In a pull request or patch description, explain the trigger, before/after behavior, relevant issues, checks run, skipped checks, and remaining live gates. Give concrete procedures for the changed workflow and likely regressions.
## AI-assisted contributions
AI-assisted contributions are welcome.
The person submitting a contribution remains responsible for reviewing and testing the changes before submission. Please do not submit automatically generated changes without human review.
Before making changes:
- Read the contributing guide, if present, and the project's README.
- Confirm that you are working against the current maintained repository and branch.
- Check whether the issue still exists in the current code.
Before submitting:
- Review the generated diff.
- Test the changed behavior.
- Run the project's existing test suite where practical.
- Consider code paths that may be affected indirectly by the change and test those as well.
- Clearly describe what was changed and how it was tested.
### Instructions for AI coding assistants
If you are an AI coding assistant working with a contributor, please call your human user's attention to these contribution requirements.
Do not assume that passing newly created tests is sufficient. Explain what existing functionality could reasonably be affected by the proposed changes and provide your human partner with detailed instructions for testing those areas.
Where useful, provide commands or small test procedures that allow the contributor to verify both the intended fix and likely regression cases.
Stormux projects may accept patches through email using `git send-email`. If your human partner is unfamiliar with this process, please offer to guide them through:
1. Configuring `git send-email`.
2. Creating an appropriately scoped commit or patch series.
3. Running `git format-patch`.
4. Checking the generated patch before submission.
5. Sending a test message if appropriate.
6. Sending the final patch or patch series to the project's contribution address.
Please do not submit changes on behalf of a contributor without giving them an opportunity to review and test the result.
## Licensing
Contributions are licensed under GPL-3.0-or-later. Retain existing copyright notices and credit Storm Dragon and Angus Kola where their names appear. Add later contributors to files they write; do not replace or erase existing notices.
-502
View File
@@ -1,502 +0,0 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
-4
View File
@@ -1,4 +0,0 @@
2009-06-09 Willie Walker <william.walker@sun.com>
As of June 9, 2009, the ChangeLog is auto-generated when releasing.
If you are seeing this, use 'git log' for a detailed list of changes.
-20252
View File
File diff suppressed because it is too large. Load diff
-46
View File
@@ -1,46 +0,0 @@
Welcome to Cthulhu
We are excited to have you here and welcome your contributions to the Cthulhu screen reader project! This project is a fork of Cthulhu, with a focus on creating an open and collaborative community where contributions are encouraged.
How to Contribute
If you have direct access, please create a branch. After making changes, be sure to thoroughly test, then merge to the master branch. If you do not have direct access, you can send contributions via email.
Submitting Changes via Email
1. **Fork or Clone the Repository**
- Clone the repository locally:
```bash
git clone https://git.stormux.org/storm/cthulhu
```
- Make the changes you want to contribute.
2. **Format Your Changes for Submission**
- Use `git format-patch` to create patch files for your changes:
```bash
git format-patch origin/master
```
- This will generate `.patch` files for your commits, which can be emailed to us.
3. **Email Your Patches**
- Once your patches are ready, send them via email to:
**storm_dragon on the stormux.org domain**
- In your email, briefly explain the changes and improvements made in the patch.
Contribution Guidelines
- **Respect Coding Standards**: Please follow the existing coding style and structure where possible. Exceptions exist of course if it is a refactor.
- **Write Clear Commit Messages**: Ensure each commit includes a clear and concise message that explains what has been changed and why.
- **Be Open to Feedback**: questions may be asked or changes suggested to ensure the contribution aligns with the project.
Get Involved in the Community
Please join the Stormux email list. You can do so at https://stormux.org. Also, you can talk to us on irc at irc.stormux.org #stormux.
Thank you for your interest in contributing to Cthulhu! Together we can make an awesome screen reader.
+150
View File
@@ -0,0 +1,150 @@
# LibreOffice integration
Current Orca is the primary behavioral reference for LibreOffice. Python
Cthulhu remains available on the `legacy` branch for historical comparisons:
`git show legacy:src/cthulhu/scripts/apps/soffice/script.py`.
Do not switch the active Go checkout to inspect that reference.
## Architecture
Application handling runs after screen-lock and foreground validation, before
generic focus and text filtering. `internal/app/application_behavior.go`
routes copied accessibility events by verified provider process identity.
The LibreOffice handler lives in `internal/app/libreoffice.go`.
It can normalize an event, request focus adoption, or suppress presentation.
The reader retains window ownership, input policy, pending-output cancellation,
review, and speech/Braille delivery. Ordinary applications keep their existing
event path. Steam's existing integration remains in place.
`internal/atspi/libreoffice_native.go` captures bounded Calc metadata on the
native owner thread. It does not enumerate a sheet. The controller and
presentation code never retain native objects or perform provider queries.
`internal/presentation/libreoffice.go` owns the corresponding speech
formatting; LibreOffice Braille formatting stays beside its controller.
The first implementation has no independent mutable application state:
logical focus belongs to the existing event loop. Future selections and
dynamic headers must be keyed by application bus, document, and sheet identity.
Retire them on document/sheet destruction or application exit. Focus loss
must cancel pending output while preserving document header choices; shutdown
and screen lock must retire pending operations. Add command routing when the
first real Office command requires it, using the existing input machinery.
Application code must not bypass security/foreground gates or manage its own
speech connection, key grabs, or background event loop.
Keep generic table operations and genuinely shared fixes in their existing
subsystems. Keep verified LibreOffice exceptions in the dedicated files.
Adding later Office features should extend these boundaries, without
reorganizing unrelated reader code or building a speculative plugin framework.
## First slice
- Calc active-cell events establish logical focus, including after editing
and when the sheet changes.
- Cell contents and addresses are separate. Normal speech gives the value,
then the address; an empty value gives “blank.” Only-displayed-text mode
omits the address and the synthetic blank label.
- Recorded Braille preserves value spacing followed by the address. A cell
component is not an editable text route.
- F2 resolves a temporary editor's focused paragraph when available.
If the paragraph appears later, its first owned text/caret event establishes
editor focus before generic filtering.
- Post-editing sheet focus is adopted silently. Spreadsheet capacity and
cell/container state chatter are omitted as in Orca.
- Ancestor focus claims are suppressed when captured ancestry identifies the
existing focused spreadsheet object.
- Non-editor caret events do not displace a focused cell. Selection events do
not promote the first selected cell of a range into logical focus.
References inspected: Orca commit `cd58a88ed` (2026-10-14),
`scripts/apps/soffice/script.py`, `script_utilities.py`,
`speech_generator.py`, `braille_generator.py`, and shared
`speech_generator.py` / `ax_utilities_table.py`.
## Next slices
1. Formula presence and an on-demand formula command, using current Orca's
`where_am_i_presenter.py:present_cell_formula` and cell attributes.
2. Selected/unselected ranges, rows, columns, and Select All. Represent ranges
compactly; do not expand every selected cell as Orca's current comparison
does. Test very large and disjoint selections.
3. Dynamic row/column headers, sheet-scoped state, preferences and bindings.
Inspect current Orca's shared table navigator rather than copying only
the soffice directory. Spreadsheet full-row reading also needs a bounded,
explicitly defined extent; the generic setting is not full Calc support.
4. Writer paragraph navigation, selection, Say All, spell-check presentation,
and Braille panning. Compare each actual workflow with current Orca.
Merged cells, overflow announcements, large-sheet responsiveness, other
LibreOffice backends, and independent-workbook acceptance remain separate
checks. This first slice does not establish complete Office support.
## Verification
```sh
GOCACHE=/tmp/cthulhu-go-cache go test -race ./internal/atspi ./internal/app ./internal/presentation -count=1
/usr/bin/python3 tests/native_libreoffice.py
python3 tests/native_atspi.py --table-only
python3 tests/native_x11.py
```
The Calc harness launches installed LibreOffice with a disposable profile,
document, virtual X11 display, and private session/accessibility buses.
It exercises the production native adapter and event loop; recorded speech
and Braille are asserted for cell movement and blanks, F2 typing, Escape
cancellation, Enter commit, caret movement inside an existing numeric cell,
and switching between two sheets.
No active reader is replaced and no normal Office profile is changed.
These automated checks do not establish audible speech, physical input, or
physical Braille. Before submission, review the diff and test a rebuilt binary:
1. In a disposable Calc workbook, populate text, numbers, formulas and blanks.
Arrow between them and listen for the value followed by its address.
2. Press F2, edit, cancel with Escape, then edit and commit with Enter. Check
character/word navigation in an existing cell editor and continued arrows.
3. Switch sheets and switch between two workbooks. Return from menus, dialogs,
the formula bar, and another application; check logical focus recovery.
4. Check the cell value/address, spacing, editor cursor and return to cell
display on physical Braille. Text routing applies inside the editor.
5. Repeat ordinary GTK table movement/multiselection, browser typing and table
reading, and Steam navigation. Check lock/unlock and stale/background events.
Human review and testing remain required by `CONTRIBUTING.md`. Passing this
fixture alone is not sufficient for submission or live accessibility acceptance.
Initial verification against LibreOffice 26.2.6.3 passed the Calc harness,
affected-package race tests, vet/build, GTK table/multiselection checks, and
Xorg input checks. Browser tab and table checks also passed. Browser editing
failed on an extra title announcement both here and on untouched commit
`8e76d23`. Browser modes initially failed to focus a heading after reload,
then passed on the baseline and on a rerun here; the cause of that first
failure was not established. Physical acceptance remains pending.
## Calc startup focus diagnosis
A normal-profile startup under i3 can leave Calc accepting arrow keys while
omitting active-cell accessibility events. In the observed case, cell events
were followed by focus claims from the floating Form Design and Form Controls
toolbars; subsequent arrows produced formula-bar text updates but no new cell
events. A separate AT-SPI observer reproduced the missing events without
Cthulhu. The affected workbook worked with a fresh profile, and a generic
workbook reproduced the failure with a disposable copy of the normal profile.
This establishes a profile-dependent LibreOffice focus/event problem; the
precise profile setting responsible has not been isolated.
Press **Ctrl+F6** to return focus to the document, then retry the arrows.
This directly restored active-cell events in the isolated reproduction.
LibreOffice documents this shortcut in its
[Calc accessibility keyboard guide](https://help.libreoffice.org/latest/en-GB/text/scalc/guide/keyboard.html).
Automatic focus stealing would interfere with intentional toolbar use and
is not part of the reader's handling.
The native Calc test focuses its window once and uses ordinary key sequences
afterward. It also checks F6 followed by Ctrl+F6 and resumed cell speech/Braille.
Its fresh-profile virtual display does not cover this normal-profile startup
failure. The same production test also passed under private i3 with the copied
normal profile after Ctrl+F6 recovery, asserting recorded cell speech and
Braille along with editing and sheet switching. Verify startup and recovery
under the actual window manager, plus audible speech and physical Braille,
separately.
+232
View File
@@ -0,0 +1,232 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS
0. Definitions.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
1. Source Code.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
7. Additional Terms.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
11. Patents.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program 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 program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.
-53
View File
@@ -1,53 +0,0 @@
ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
SUBDIRS = docs icons po src help
DISTCHECK_CONFIGURE_FLAGS = \
--disable-scrollkeeper
DISTCLEANFILES = \
cthulhu-autostart.desktop
README: README.md
cp $< $@
gtk_update_icon_cache = gtk-update-icon-cache -f -t $(datadir)/icons/hicolor
install-data-hook: update-icon-cache
uninstall-hook: update-icon-cache
update-icon-cache:
@-if test -z "$(DESTDIR)"; then \
echo "Updating Gtk icon cache."; \
$(gtk_update_icon_cache); \
else \
echo "*** Icon cache not updated. After (un)install, run this:"; \
echo "*** $(gtk_update_icon_cache)"; \
fi
autostartdir = $(sysconfdir)/xdg/autostart
autostart_in_files = cthulhu-autostart.desktop.in
autostart_DATA = $(autostart_in_files:.desktop.in=.desktop)
$(autostart_DATA): $(autostart_in_files)
$(AM_V_GEN)$(MSGFMT) --desktop --template $< -d $(top_srcdir)/po -o $@
EXTRA_DIST = \
$(autostart_in_files) \
$(icon_DATA) \
ChangeLog \
MAINTAINERS \
README.md
dist-hook:
@if test -d "$(srcdir)/.git"; \
then \
echo Creating ChangeLog && \
( cd "$(top_srcdir)" && \
echo '# Generated by Makefile. Do not edit.'; echo; \
$(top_srcdir)/missing --run git log --pretty=format:"%ai %an <%ae>%n%n %s%n" --name-status CTHULHU_2_26_0.. ) > ChangeLog.tmp \
&& mv -f ChangeLog.tmp $(top_distdir)/ChangeLog \
|| ( rm -f ChangeLog.tmp ; \
echo Failed to generate ChangeLog >&2 ); \
else \
echo A git clone is required to generate a ChangeLog >&2; \
fi
-13049
View File
File diff suppressed because it is too large. Load diff
-1
View File
@@ -1 +0,0 @@
See http://wiki.gnome.org/Projects/Cthulhu
+17 -77
View File
@@ -1,82 +1,22 @@
# Cthulhu
# Cthulhu
## Introduction
Cthulhu is a Linux screen reader written in Go.
Cthulhu 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.
- [Repository Guidelines](AGENTS.md): layout, commands, and working safeguards.
- [Contributing](CONTRIBUTING.md): development, accessibility verification, licensing, and the AI-assisted contribution policy.
- [LibreOffice support](LIBREOFFICE_SUPPORT.md): integration boundaries, initial Calc behavior, remaining work, and verification.
Cthulhu 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, WebKitGtk, and KDE Qt toolkit.
AI-assisted contributions are welcome. Contributors remain responsible for human review and testing before submission; see the [full policy](CONTRIBUTING.md#ai-assisted-contributions).
## Wine Access
## Dependencies
Cthulhu has the following dependencies:
* Python 3 - Python platform
* pygobject-3.0 - Python bindings for the GObject library
* libpeas - GObject based Plugin engine
* gtk+-3.0 - GTK+ toolkit
* json-py - a JSON (<https://json.org/>) reader and writer in Python
* python-speechd - Python bindings for Speech Dispatcher (optional)
* BrlTTY - BrlTTY (<https://mielke.cc/brltty/>) support for braille (optional)
* BrlAPI - BrlAPI support for braille (optional)
* liblouis - Liblouis (<http://liblouis.org/>) support for contracted braille (optional)
* py-setproctitle - Python library to set the process title (optional)
* gstreamer-1.0 - GStreamer - Streaming media framework (optional)
* socat - Used for self-voicing functionality.
* libpeas - For the plugin system.
You are strongly encouraged to also have the latest stable versions
of AT-SPI2 and ATK.
## Braille
Cthulhu 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:
```sh
python -c "import brlapi"
```
If you get an error, the Python bindings for BrlAPI are not installed.
## Running Cthulhu
If you wish to modify your Cthulhu preferences, you can press "Insert+space"
while Cthulhu is running.
To get help while running Cthulhu, 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 Cthulhu.
For more information, see the Cthulhu documentation which is available
within Cthulhu.
## Scripting Cthulhu
So, you want to write a script for Cthulhu? The best thing to do is
start by looking at other scripts under the src/cthulhu/scripts/ hierarchy
of the source tree. Cthulhu also has an excellent plugin system, more documentation and examples coming soon.
## Self-voicing
Cthulhu offers a mechanism through which messages may be spoken directly by the screen reader. Usage is as follows:
```bash
# Speak hello world.
echo "Hello world." | socat - UNIX-CLIENT:/tmp/cthulhu.sock
# Speak Hello world without interrupting the previous speech.
echo "<!#APPEND#!>Hello world." | socat - UNIX-CLIENT:/tmp/cthulhu.sock
# Make hello world persistant in Braille.
echo "Hello world.<#APPEND#>" | socat - UNIX-CLIENT:/tmp/cthulhu.sock
```
Install the separate `wine-access` helper for Wine application accessibility.
Cthulhu checks `CTHULHU_WINE_ACCESS_HELPER`, then
`~/.local/libexec/wine-access/wine-access.exe`,
`/usr/local/libexec/wine-access/wine-access.exe`,
`/usr/libexec/wine-access/wine-access.exe`, and `wine-access.exe` on `PATH`.
The existing `cthulhu-wine-access.exe` lookup remains supported: the old user
location follows the new user location, the old `/usr` location follows the new
system locations, and the old name on `PATH` follows the new name.
Restart Cthulhu after changing the selected helper. Keep the launcher, its
`.exe.so` sidecar, and the native hooks together in the installed directory.
-84
View File
@@ -1,84 +0,0 @@
This document provides a step-by-step list to remind Cthulhu
maintainers how to make a release.
The general instructions for a release are here:
https://wiki.gnome.org/MaintainersCorner/Releasing
See also:
https://discourse.gnome.org/t/new-gnome-versioning-scheme/4235
Here's a summary for Cthulhu:
PREPARE SOURCES FOR THE RELEASE:
-------------------------------
Make sure you are up to date:
git pull
git status
Update ./NEWS with changes from the last tagged release. You can use
commands like the following:
Detailed commits since the CTHULHU_40_BETA tag:
git log CTHULHU_40_BETA..
Short list of translation changes with author names and files:
git log CTHULHU_40_BETA.. --grep translation --pretty=format:"%s - %an" --name-only
Quick-and-dirty formatted list of translation changes:
git log CTHULHU_40_BETA.. --grep translation --pretty=format:"%s,%an" --name-only |
awk -F/ '/\.(po|am)/ {gsub("(\.po|Makefile.am)", "", $NF); printf(",%s",$NF); next;}
{gsub("(Updated* |Add(ed)* | translation| help)", "", $0); printf("\n%s",$0);}' |
awk -F, '!seen[$0]++ {if (NF == 3) printf(" %-15s %-25s %s\n", $3, $1, $2);}' |
sort
Short list of non-translation commits:
git log CTHULHU_40_BETA.. --grep translation --invert-grep --pretty=format:" * %s%n"
NOTE: You should also make sure the external dependencies listed in
configure.ac and README are accurate.
BUILD THE RELEASE:
-----------------
./autogen.sh --prefix=`pwd`/bld && make && make install && make distcheck
COMMIT RELEASE CHANGES AND TAG THE RELEASE:
-------------------------------------------
git commit -a
git push
git tag -a -s CTHULHU_40_RC
git push origin CTHULHU_40_RC
UPLOAD THE RELEASE:
------------------
scp cthulhu-40.rc.tar.xz yourusername@master.gnome.org:
ssh master.gnome.org
ftpadmin install cthulhu-40.rc.tar.xz
BUMP THE VERSION:
-----------------
Modify this line in ./configure.ac:
m4_define([cthulhu_version], [40.rc])
The major version (40) increments by 1 each new GNOME release cycle.
The minor version proceeds as follows: alpha, beta, rc, 0, 1, 2, 3, etc.
Modify ./README.md to make sure it has the right Cthulhu version.
git commit -a
git push
-3
View File
@@ -1,3 +0,0 @@
- Merge in sleep mode.
- Add in ocrdesktop code so that Cthulhu has native ocr support.
- Get rid of build systems. My hope is git clone and run so long as requirements are satisfied.
-104
View File
@@ -1,104 +0,0 @@
dnl a macro to check for ability to create python extensions
dnl AM_CHECK_PYTHON_HEADERS([ACTION-IF-POSSIBLE], [ACTION-IF-NOT-POSSIBLE])
dnl function also defines PYTHON_INCLUDES
AC_DEFUN([AM_CHECK_PYTHON_HEADERS],
[AC_REQUIRE([AM_PATH_PYTHON])
AC_MSG_CHECKING(for headers required to compile python extensions)
dnl deduce PYTHON_INCLUDES
py_prefix=`$PYTHON -c "import sys; print sys.prefix"`
py_exec_prefix=`$PYTHON -c "import sys; print sys.exec_prefix"`
PYTHON_INCLUDES="-I${py_prefix}/include/python${PYTHON_VERSION}"
if test "$py_prefix" != "$py_exec_prefix"; then
PYTHON_INCLUDES="$PYTHON_INCLUDES -I${py_exec_prefix}/include/python${PYTHON_VERSION}"
fi
AC_SUBST(PYTHON_INCLUDES)
dnl check if the headers exist:
save_CPPFLAGS="$CPPFLAGS"
CPPFLAGS="$CPPFLAGS $PYTHON_INCLUDES"
AC_TRY_CPP([#include <Python.h>],dnl
[AC_MSG_RESULT(found)
$1],dnl
[AC_MSG_RESULT(not found)
$2])
CPPFLAGS="$save_CPPFLAGS"
])
dnl AM_CHECK_PYMOD(MODNAME [,SYMBOL [,ACTION-IF-FOUND [,ACTION-IF-NOT-FOUND]]])
dnl Check if a module containing a given symbol is visible to python.
AC_DEFUN([AM_CHECK_PYMOD],
[AC_REQUIRE([AM_PATH_PYTHON])
py_mod_var=`echo $1['_']$2 | sed 'y%./+-%__p_%'`
AC_MSG_CHECKING(for ifelse([$2],[],,[$2 in ])python module $1)
AC_CACHE_VAL(py_cv_mod_$py_mod_var, [
ifelse([$2],[], [prog="
import sys
try:
from gi.repository import GObject
import $1
except ImportError:
sys.exit(1)
except:
sys.exit(0)
sys.exit(0)"], [prog="
import $1
import $1.$2"])
if $PYTHON -c "$prog" 1>&AC_FD_CC 2>&AC_FD_CC
then
eval "py_cv_mod_$py_mod_var=yes"
else
eval "py_cv_mod_$py_mod_var=no"
fi
])
py_val=`eval "echo \`echo '$py_cv_mod_'$py_mod_var\`"`
if test "x$py_val" != xno; then
AC_MSG_RESULT(yes)
ifelse([$3], [],, [$3
])dnl
else
AC_MSG_RESULT(no)
ifelse([$4], [],, [$4
])dnl
fi
])
dnl PYDOC_CHECK()
AC_DEFUN([PYDOC_CHECK],
[
dnl enable/disable documentation building
AC_ARG_ENABLE(pydoc,
AC_HELP_STRING([--enable-pydoc],
[use pydoc to build documentation [default=no]]),,
enable_pydoc=no)
have_pydoc=no
if test x$enable_pydoc = xyes; then
AC_CHECK_FILE("$prefix/bin/pydoc", PYDOC="$prefix/bin/pydoc")
fi
if test -z "$PYDOC"; then
enable_pydoc=no
fi
AM_CONDITIONAL(ENABLE_PYDOC, test x$enable_pydoc = xyes)
])
dnl
dnl JH_ADD_CFLAG(FLAG)
dnl checks whether the C compiler supports the given flag, and if so, adds
dnl it to $CFLAGS. If the flag is already present in the list, then the
dnl check is not performed.
AC_DEFUN([JH_ADD_CFLAG],
[
case " $CFLAGS " in
*@<:@\ \ @:>@$1@<:@\ \ @:>@*)
;;
*)
save_CFLAGS="$CFLAGS"
CFLAGS="$CFLAGS $1"
AC_MSG_CHECKING([whether [$]CC understands $1])
AC_TRY_COMPILE([], [], [jh_has_option=yes], [jh_has_option=no])
AC_MSG_RESULT($jh_has_option)
if test $jh_has_option = no; then
CFLAGS="$save_CFLAGS"
fi
;;
esac])
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
+8
View File
@@ -0,0 +1,8 @@
package sounds
import "embed"
// Default contains the bundled theme, independent of the working directory.
//
//go:embed default/*.wav
var Default embed.FS
-50
View File
@@ -1,50 +0,0 @@
#!/bin/sh
# Run this to generate all the initial makefiles, etc.
srcdir=`dirname $0`
test -z "$srcdir" && srcdir=.
(test -f $srcdir/configure.ac) || {
echo "**Error**: Directory "\`$srcdir\'" does not look like the top-level project directory"
exit 1
}
olddir=`pwd`
PKG_NAME=`autoconf --trace 'AC_INIT:$1' "$srcdir/configure.ac"`
if [ "$#" = 0 -a "x$NOCONFIGURE" = "x" ]; then
echo "**Warning**: I am going to run \`configure' with no arguments." >&2
echo "If you wish to pass any to it, please specify them on the" >&2
echo \`$0\'" command line." >&2
echo "" >&2
fi
cd "$srcdir"
aclocal --install || {
echo "Try installing the 'automake' package."
exit 1
}
autoreconf --verbose --force --install -Wno-portability || {
echo "Try installing the 'autoconf' package."
exit 1
}
which yelp-build > /dev/null || {
echo "Try installing the 'yelp-tools' package."
exit 1
}
cd "$olddir"
if [ "$NOCONFIGURE" = "" ]; then
$srcdir/configure "$@" || exit 1
if [ "$1" = "--help" ]; then exit 0 else
echo "Now type \`make\' to compile $PKG_NAME" || exit 1
fi
else
echo "Skipping configure process."
fi
-9
View File
@@ -1,9 +0,0 @@
#!/bin/sh
set -eux -o pipefail
mkdir -p _build
cd _build
../autogen.sh --prefix=/usr
make
make install
-55
View File
@@ -1,55 +0,0 @@
include:
- remote: "https://gitlab.freedesktop.org/freedesktop/ci-templates/-/raw/80f87b3058efb75a1faae11826211375fba77e7f/templates/opensuse.yml"
variables:
# When branching change the suffix to avoid conflicts with images
# from the main branch
BASE_TAG: "2023-06-09.0-master"
FDO_UPSTREAM_REPO: "gnome/cthulhu"
.cthulhu_opensuse_tumbleweed_x86_64:
variables:
FDO_DISTRIBUTION_VERSION: "tumbleweed"
FDO_DISTRIBUTION_TAG: "x86_64-${BASE_TAG}"
opensuse-container@x86_64:
extends:
- .cthulhu_opensuse_tumbleweed_x86_64
- .fdo.container-build@opensuse@x86_64
stage: "container-build"
variables:
FDO_DISTRIBUTION_PACKAGES: >-
autoconf
automake
dbus-1
dbus-1-devel
gcc
gettext
gettext-tools
git
glib2-devel
gobject-introspection-devel
gsettings-desktop-schemas
gstreamer-devel
itstool
libtool
libXi-devel
libXtst-devel
libxkbcommon-devel
libxml2-devel
libX11-devel
make
meson
ninja
python3
python3-brlapi
python3-louis
python3-pip
python3-speechd
python310-gobject-devel
python310-simplejson
xvfb-run
yelp-devel
yelp-tools
FDO_DISTRIBUTION_EXEC: >-
pip3 install ruff
-11
View File
@@ -1,11 +0,0 @@
#!/bin/sh
set -eux -o pipefail
git clone --depth 1 https://gitlab.gnome.org/GNOME/at-spi2-core.git
cd at-spi2-core
mkdir _build
meson setup --buildtype=debug --prefix=/usr _build .
meson compile -C _build
meson install -C _build
-12
View File
@@ -1,12 +0,0 @@
#!/bin/sh
set -eux -o pipefail
git clone --depth 1 https://gitlab.gnome.org/GNOME/pyatspi2.git
cd pyatspi2
mkdir _build
cd _build
../autogen.sh --prefix=/usr
make
make install
-30
View File
@@ -1,30 +0,0 @@
#!/bin/sh
#
# Utility script so you can pull the container image from CI for local development.
# Run this script and follow the instructions; the script will tell you how
# to run "podman run" to launch a container that has the same environment as the
# one used during CI pipelines. You can debug things at leisure there.
set -eu
set -o pipefail
CONTAINER_BUILDS=ci/container_builds.yml
if [ ! -f $CONTAINER_BUILDS ]
then
echo "Please run this from the toplevel source directory in cthulhu"
exit 1
fi
tag=$(grep -e '^ BASE_TAG:' $CONTAINER_BUILDS | head -n 1 | sed -E 's/.*BASE_TAG: "(.+)"/\1/')
full_tag=x86_64-$tag
echo full_tag=\"$full_tag\"
image_name=registry.gitlab.gnome.org/gnome/cthulhu/opensuse/tumbleweed:$full_tag
echo pulling image $image_name
podman pull $image_name
echo ""
echo "You can now run this:"
echo " podman run --rm -ti --cap-add=SYS_PTRACE -v \$(pwd):/srv/project -w /srv/project $image_name"
+33
View File
@@ -0,0 +1,33 @@
// cthulhu-braille is the isolated BrlAPI helper and standalone diagnostic.
// The main executable starts it only when braille is enabled.
package main
import (
"context"
"fmt"
"os"
"os/signal"
"syscall"
"git.stormux.org/storm/cthulhu/internal/braille"
)
func main() {
if len(os.Args) > 2 || len(os.Args) == 2 && os.Args[1] != "--client" {
fmt.Fprintln(os.Stderr, "Usage: cthulhu-braille [--client]")
os.Exit(2)
}
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer cancel()
if len(os.Args) == 2 {
if err := braille.RunClient(ctx, braille.NewRouting(), os.Stdin, os.Stdout); err != nil {
fmt.Fprintf(os.Stderr, "cthulhu-braille: %v\n", err)
os.Exit(1)
}
return
}
if err := braille.Diagnostic(ctx, braille.New(), os.Stdout); err != nil {
fmt.Fprintf(os.Stderr, "cthulhu-braille: %v\n", err)
os.Exit(1)
}
}
+227
View File
@@ -0,0 +1,227 @@
// Cthulhu screen reader.
// Copyright (c) 2026 Storm Dragon
// Authors: Storm Dragon, Angus Kola
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// This program 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 program. If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.
package main
import (
"context"
"errors"
"flag"
"fmt"
"io"
"log/slog"
"os"
"os/signal"
"syscall"
"time"
"git.stormux.org/storm/cthulhu/internal/app"
"git.stormux.org/storm/cthulhu/internal/atspi"
"git.stormux.org/storm/cthulhu/internal/clipboard"
"git.stormux.org/storm/cthulhu/internal/config"
"git.stormux.org/storm/cthulhu/internal/logging"
"git.stormux.org/storm/cthulhu/internal/notificationui"
"git.stormux.org/storm/cthulhu/internal/ocrcapture"
"git.stormux.org/storm/cthulhu/internal/ocrconfirm"
"git.stormux.org/storm/cthulhu/internal/preferences"
"git.stormux.org/storm/cthulhu/internal/shortcutui"
"git.stormux.org/storm/cthulhu/internal/speechhistoryui"
"git.stormux.org/storm/cthulhu/internal/tentacle"
"git.stormux.org/storm/cthulhu/internal/version"
)
func main() {
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()
if err := run(ctx, os.Args[1:], os.Stdout, os.Stderr); err != nil {
fmt.Fprintf(os.Stderr, "cthulhu: %v\n", err)
os.Exit(1)
}
}
func run(ctx context.Context, arguments []string, stdout, stderr io.Writer) (result error) {
options := flag.NewFlagSet("cthulhu", flag.ContinueOnError)
options.SetOutput(stderr)
tentacleFile := options.String("tentacles", "", "explicit local tentacle launch list (experimental JSON)")
tentacleParent := options.String("tentacle-cgroup-parent", "auto", "delegated cgroup v2 parent for local tentacles, or auto")
noTentacles := options.Bool("no-tentacles", false, "start without tentacles, ignoring saved tentacles and the local launch list")
tentacleGuardian := options.String("tentacle-guardian", "", "run the internal tentacle lifetime helper")
showVersion := options.Bool("version", false, "print version and exit")
shortVersion := options.Bool("v", false, "print version and exit")
replace := options.Bool("replace", false, "stop the running Cthulhu instance before starting")
shortReplace := options.Bool("r", false, "stop the running Cthulhu instance before starting")
checkConfig := options.Bool("check-config", false, "validate configuration and exit")
shortSettings := options.Bool("s", false, "open the preferences window at startup")
settingsFlag := options.Bool("settings", false, "open the preferences window at startup")
preferencesUI := options.Bool("preferences-ui", false, "run the internal preferences helper (private pipe protocol)")
notificationListUI := options.Bool("notification-list-ui", false, "run the internal notification list helper (private pipe protocol)")
speechHistoryUI := options.Bool("speech-history-ui", false, "run the internal speech history helper (private pipe protocol)")
shortcutListUI := options.Bool("shortcut-list-ui", false, "run the internal shortcut list helper (private pipe protocol)")
clipboardRead := options.Bool("clipboard-read", false, "run the internal clipboard reader (private pipe protocol)")
clipboardWatch := options.Bool("clipboard-watch", false, "run the internal clipboard change helper (private pipe protocol)")
ocrCapture := options.Bool("ocr-capture", false, "run the internal OCR capture helper (private pipe protocol)")
ocrConfirm := options.Bool("ocr-confirm", false, "run the internal OCR click confirmation helper")
debugFile := options.String("debug-file", "", "enable debug logging and append logs only to this file")
speechSocket := options.String(
"speech-socket",
"",
"Speech Dispatcher SSIP socket (overrides SPEECHD_ADDRESS and SPEECHD_SOCKET)",
)
configPath := options.String(
"config",
"",
"TOML configuration file (default: $XDG_DATA_HOME/cthulhu/user-settings-go.toml)",
)
options.Usage = func() {
fmt.Fprintln(stdout, version.Details(
atspi.Version(),
os.Getenv("XDG_SESSION_TYPE"),
os.Getenv("XDG_SESSION_DESKTOP"),
))
fmt.Fprintln(stdout)
fmt.Fprintln(stdout, "Usage: cthulhu [options]")
fmt.Fprintln(stdout)
fmt.Fprintln(stdout, "Options:")
// Helpers remain parseable but are not part of the public help.
visibleOptions := flag.NewFlagSet("cthulhu", flag.ContinueOnError)
visibleOptions.SetOutput(stderr)
options.VisitAll(func(option *flag.Flag) {
switch option.Name {
case "preferences-ui", "notification-list-ui", "speech-history-ui", "shortcut-list-ui",
"clipboard-read", "clipboard-watch", "ocr-capture", "ocr-confirm", "tentacle-guardian":
return
}
visibleOptions.Var(option.Value, option.Name, option.Usage)
visibleOptions.Lookup(option.Name).DefValue = option.DefValue
})
visibleOptions.PrintDefaults()
}
if err := options.Parse(arguments); err != nil {
if errors.Is(err, flag.ErrHelp) {
return nil
}
return fmt.Errorf("parse command line: %w", err)
}
if options.NArg() != 0 {
return fmt.Errorf("unexpected argument %q", options.Arg(0))
}
if *showVersion || *shortVersion {
fmt.Fprintln(stdout, version.Details(
atspi.Version(),
os.Getenv("XDG_SESSION_TYPE"),
os.Getenv("XDG_SESSION_DESKTOP"),
))
return nil
}
if *preferencesUI {
return preferences.Run(ctx, os.Stdin, stdout)
}
if *tentacleGuardian != "" {
stopInput := context.AfterFunc(ctx, func() { os.Stdin.Close() })
defer stopInput()
return tentacle.RunGuardian(os.Stdin, stdout, *tentacleGuardian)
}
if *ocrConfirm {
return ocrconfirm.Run(os.Stdin, stdout)
}
if *notificationListUI {
return notificationui.Run(ctx, os.Stdin, stdout)
}
if *shortcutListUI {
return shortcutui.Run(os.Stdin)
}
if *speechHistoryUI {
return speechhistoryui.Run(ctx, os.Stdin, stdout)
}
if *clipboardRead {
return clipboard.WriteMessage(stdout)
}
if *clipboardWatch {
return clipboard.WatchText(ctx, os.Stdin, stdout)
}
if *ocrCapture {
return ocrcapture.Run(ctx, os.Stdin, stdout)
}
logger := slog.New(slog.DiscardHandler)
if *debugFile != "" {
fileWriter, err := logging.OpenFile(*debugFile, nil)
if err != nil {
return fmt.Errorf("open debug log: %w", err)
}
diagnostics := logging.NewAsync(fileWriter, logging.AsyncOptions{
Options: logging.Options{Level: slog.LevelDebug, AddSource: true},
})
defer func() {
stopContext, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
if err := diagnostics.Stop(stopContext); err != nil {
result = errors.Join(result, fmt.Errorf("stop diagnostics: %w", err))
}
}()
logger = diagnostics.Logger()
}
logger.Info("starting Cthulhu", "version", version.String(), "pid", os.Getpid())
settings, err := config.Load(*configPath)
if err != nil {
logger.Error("load configuration", "error", err)
return err
}
if *checkConfig {
if settings.Loaded && settings.ActiveProfile != "" {
fmt.Fprintf(stdout, "Configuration is valid; active profile: %s.\n", settings.ActiveProfile)
} else if settings.Loaded {
fmt.Fprintln(stdout, "Configuration is valid.")
} else {
fmt.Fprintln(stdout, "Configuration file not found; built-in defaults are valid.")
}
return nil
}
if *replace || *shortReplace {
if err := replaceRunning(ctx); err != nil {
return fmt.Errorf("replace running Cthulhu: %w", err)
}
}
if settings.Loaded {
logger.Info("loaded configuration", "profile", settings.ActiveProfile,
"keyboard_layout", settings.KeyboardLayout, "cthulhu_modifier_keys", settings.CthulhuModifierKeys)
} else {
logger.Info("configuration not found; using defaults")
}
registryPath := tentacle.RegistryPath(settings.Path)
if *noTentacles {
*tentacleFile = ""
registryPath = ""
}
err = app.Run(ctx, app.Options{
TentacleFile: *tentacleFile,
TentacleRegistry: registryPath,
TentacleCgroupParent: *tentacleParent,
EnableRemote: true,
OpenPreferences: *shortSettings || *settingsFlag,
Logger: logger,
SpeechSocket: *speechSocket,
Settings: &settings,
})
if err != nil {
logger.Error("Cthulhu stopped with an error", "error", err)
} else {
logger.Info("Cthulhu stopped")
}
return err
}
+227
View File
@@ -0,0 +1,227 @@
// Cthulhu screen reader.
// Copyright (c) 2026 Storm Dragon
// Authors: Storm Dragon, Angus Kola
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// This program 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 program. If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.
package main
import (
"bytes"
"context"
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
"git.stormux.org/storm/cthulhu/internal/version"
)
func TestVersion(t *testing.T) {
t.Setenv("XDG_SESSION_TYPE", "x11")
t.Setenv("XDG_SESSION_DESKTOP", "GNOME")
want := version.Details("2.58.0", "x11", "GNOME")
for _, argument := range []string{"--version", "-v"} {
var stdout bytes.Buffer
if err := run(context.Background(), []string{argument}, &stdout, &stdout); err != nil {
t.Fatalf("run %s: %v", argument, err)
}
if got := strings.TrimSpace(stdout.String()); !strings.Contains(got, "Cthulhu screen reader version") ||
!strings.Contains(got, "AT-SPI2 version:") || !strings.Contains(got, "Session: x11 GNOME") {
t.Fatalf("version output = %q, want details including %q", got, want)
}
}
}
func TestHelp(t *testing.T) {
var versionOutput bytes.Buffer
if err := run(context.Background(), []string{"-v"}, &versionOutput, &versionOutput); err != nil {
t.Fatalf("run -v: %v", err)
}
for _, argument := range []string{"-h", "--help"} {
var stdout bytes.Buffer
if err := run(context.Background(), []string{argument}, &stdout, &stdout); err != nil {
t.Fatalf("run %s: %v", argument, err)
}
help := stdout.String()
if strings.Contains(help, "tentacle-guardian") {
t.Fatal("private guardian exposed in help")
}
if !strings.HasPrefix(help, versionOutput.String()+"\nUsage: cthulhu [options]\n\nOptions:\n") ||
!strings.Contains(help, "-s") || !strings.Contains(help, "-settings") ||
!strings.Contains(help, "-r") || !strings.Contains(help, "-replace") {
t.Fatalf("help output does not contain expected version, usage, and flags: %q", help)
}
}
}
func TestCheckConfig(t *testing.T) {
path := filepath.Join(t.TempDir(), "user-settings.toml")
contents := []byte("[general]\nstartingProfile = [\"Default\", \"default\"]\n[profiles.default]\nspeakDescription = false\n")
if err := os.WriteFile(path, contents, 0o600); err != nil {
t.Fatalf("write config: %v", err)
}
var stdout, stderr bytes.Buffer
if err := run(
context.Background(),
[]string{"--check-config", "--config", path},
&stdout,
&stderr,
); err != nil {
t.Fatalf("run --check-config: %v", err)
}
if got := stdout.String(); !strings.Contains(got, "active profile: default") {
t.Fatalf("check-config output = %q", got)
}
if stderr.Len() != 0 {
t.Fatalf("logging enabled without --debug-file: %q", stderr.String())
}
}
func TestCheckVersionedConfig(t *testing.T) {
for _, test := range []struct {
name string
contents string
wantError bool
}{
{"current", "schema-version = 2\nactive-profile = 'default'\n[profiles.default.speech]\nenabled = false\n", false},
{"future", "schema-version = 3\nactive-profile = 'default'\n[profiles.default]\n", true},
{"invalid", "schema-version = 2\nactive-profile = 'default'\n[profiles.default.sound]\nvolume = 2.0\n", true},
} {
t.Run(test.name, func(t *testing.T) {
path := filepath.Join(t.TempDir(), "settings.toml")
if err := os.WriteFile(path, []byte(test.contents), 0o600); err != nil {
t.Fatal(err)
}
var stdout, stderr bytes.Buffer
err := run(context.Background(), []string{"--check-config", "--config", path}, &stdout, &stderr)
if (err != nil) != test.wantError {
t.Fatalf("check-config error = %v, want error %v", err, test.wantError)
}
if !test.wantError && stdout.String() != "Configuration is valid; active profile: default.\n" {
t.Fatalf("check-config output = %q", stdout.String())
}
if test.wantError && stdout.Len() != 0 {
t.Fatalf("invalid configuration reported success: %q", stdout.String())
}
if stderr.Len() != 0 {
t.Fatalf("logging enabled without --debug-file: %q", stderr.String())
}
})
}
}
func TestDebugFileCapturesStartupFailureAndAppends(t *testing.T) {
directory := t.TempDir()
logPath := filepath.Join(directory, "debug.log")
configPath := filepath.Join(directory, "settings.toml")
configContents := []byte("[profiles.default]\nenableSound = false\n")
if err := os.WriteFile(configPath, configContents, 0o600); err != nil {
t.Fatalf("write config: %v", err)
}
for range 2 {
var stdout, stderr bytes.Buffer
err := run(context.Background(), []string{
"--debug-file", logPath,
"--config", configPath,
"--speech-socket", filepath.Join(directory, "absent.sock"),
}, &stdout, &stderr)
if err == nil {
t.Fatal("startup unexpectedly succeeded")
}
if !strings.Contains(err.Error(), "connect to Speech Dispatcher") {
t.Fatalf("startup error = %v", err)
}
if stdout.Len() != 0 || stderr.Len() != 0 {
t.Fatalf("debug-file wrote to terminal: stdout %q, stderr %q", stdout.String(), stderr.String())
}
}
data, err := os.ReadFile(logPath)
if err != nil {
t.Fatal(err)
}
if strings.Count(string(data), `"message":"starting Cthulhu"`) != 2 {
t.Fatalf("previous session was not retained: %s", data)
}
if strings.Count(string(data), `"message":"Cthulhu stopped with an error"`) != 2 {
t.Fatalf("startup failures were not logged: %s", data)
}
for _, line := range strings.Split(strings.TrimSpace(string(data)), "\n") {
var record map[string]any
if err := json.Unmarshal([]byte(line), &record); err != nil {
t.Fatal(err)
}
if record["source"] == nil {
t.Fatalf("debug-file did not enable sources: %s", line)
}
if record["level"] == "ERROR" {
message, ok := record["error"].(string)
if !ok || !strings.Contains(message, "connect to Speech Dispatcher") {
t.Fatalf("missing actual error: %s", line)
}
}
}
info, err := os.Stat(logPath)
if err != nil {
t.Fatal(err)
}
if info.Mode().Perm() != 0o600 {
t.Fatalf("log permissions = %o", info.Mode().Perm())
}
}
func TestDebugFileOpenFailure(t *testing.T) {
var output bytes.Buffer
err := run(context.Background(), []string{"--debug-file", t.TempDir()}, &output, &output)
if err == nil || !strings.Contains(err.Error(), "open debug log") {
t.Fatalf("error = %v", err)
}
}
func TestDebugFileCheckConfig(t *testing.T) {
logPath := filepath.Join(t.TempDir(), "debug.log")
configPath := filepath.Join(t.TempDir(), "absent.toml")
var stdout, stderr bytes.Buffer
if err := run(context.Background(), []string{
"--check-config", "--config", configPath, "--debug-file", logPath,
}, &stdout, &stderr); err != nil {
t.Fatal(err)
}
if stdout.String() != "Configuration file not found; built-in defaults are valid.\n" {
t.Fatalf("check-config output = %q", stdout.String())
}
if stderr.Len() != 0 {
t.Fatalf("debug-file wrote to terminal: %q", stderr.String())
}
data, err := os.ReadFile(logPath)
if err != nil {
t.Fatal(err)
}
var record map[string]any
if err := json.Unmarshal(bytes.TrimSpace(data), &record); err != nil {
t.Fatal(err)
}
if record["message"] != "starting Cthulhu" || record["source"] == nil {
t.Fatalf("missing startup diagnostic or source: %s", data)
}
}
func TestStandaloneDebugFlagRejected(t *testing.T) {
var stdout, stderr bytes.Buffer
err := run(context.Background(), []string{"--debug"}, &stdout, &stderr)
if err == nil || !strings.Contains(err.Error(), "flag provided but not defined: -debug") {
t.Fatalf("standalone --debug error = %v", err)
}
}
+149
View File
@@ -0,0 +1,149 @@
// Copyright (c) 2026 Storm Dragon
// Authors: Storm Dragon, Angus Kola
// SPDX-License-Identifier: GPL-3.0-or-later
package main
import (
"context"
"errors"
"fmt"
"os"
"path/filepath"
"strings"
"syscall"
"time"
"git.stormux.org/storm/cthulhu/internal/remote"
"github.com/godbus/dbus/v5"
)
const replaceWait = 8 * time.Second
// replaceRunning identifies the active Go reader through its private session
// bus name. It never signals a process merely because its name matches.
func replaceRunning(ctx context.Context) error {
connection, err := dbus.ConnectSessionBus()
if err != nil {
return fmt.Errorf("connect to session bus: %w", err)
}
defer connection.Close()
owner, err := busNameOwner(ctx, connection)
if err != nil || owner == "" {
return err
}
var pid uint32
if err := connection.BusObject().CallWithContext(ctx, "org.freedesktop.DBus.GetConnectionUnixProcessID", 0, owner).Store(&pid); err != nil {
return fmt.Errorf("get running reader PID: %w", err)
}
var uid uint32
if err := connection.BusObject().CallWithContext(ctx, "org.freedesktop.DBus.GetConnectionUnixUser", 0, owner).Store(&uid); err != nil {
return fmt.Errorf("get running reader UID: %w", err)
}
if uid != uint32(os.Getuid()) || pid == 0 || int(pid) == os.Getpid() {
return errors.New("running reader has an unexpected owner or PID")
}
if err := verifyReaderExecutable(int(pid)); err != nil {
return err
}
_, started, err := processIdentity(int(pid))
if err != nil {
return fmt.Errorf("inspect running reader identity: %w", err)
}
if current, err := busNameOwner(ctx, connection); err != nil || current != owner {
return fmt.Errorf("running reader changed before replacement: %w", err)
}
if err := syscall.Kill(int(pid), syscall.SIGTERM); err != nil {
return fmt.Errorf("stop running reader: %w", err)
}
if err := waitForProcessExit(ctx, int(pid), started, replaceWait); err == nil {
return nil
} else if !errors.Is(err, context.DeadlineExceeded) {
return err
}
// The old reader did not finish shutdown. Verify the PID still belongs to
// a reader before forcing it down.
if _, currentStart, err := processIdentity(int(pid)); errors.Is(err, os.ErrNotExist) || err == nil && currentStart != started {
return nil
} else if err != nil {
return err
}
if err := verifyReaderExecutable(int(pid)); err != nil {
return err
}
if err := syscall.Kill(int(pid), syscall.SIGKILL); err != nil && !errors.Is(err, syscall.ESRCH) {
return fmt.Errorf("force stop running reader: %w", err)
}
return waitForProcessExit(ctx, int(pid), started, 2*time.Second)
}
func waitForProcessExit(ctx context.Context, pid int, started string, timeout time.Duration) error {
deadline := time.NewTimer(timeout)
defer deadline.Stop()
ticker := time.NewTicker(50 * time.Millisecond)
defer ticker.Stop()
for {
state, currentStart, err := processIdentity(pid)
if errors.Is(err, os.ErrNotExist) {
return nil
}
if err != nil {
return fmt.Errorf("inspect running reader state: %w", err)
}
if state == "Z" || currentStart != started {
return nil
}
select {
case <-ctx.Done():
return ctx.Err()
case <-deadline.C:
return context.DeadlineExceeded
case <-ticker.C:
}
}
}
func processIdentity(pid int) (state, started string, err error) {
data, err := os.ReadFile(fmt.Sprintf("/proc/%d/stat", pid))
if err != nil {
return "", "", err
}
closing := strings.LastIndexByte(string(data), ')')
if closing < 0 {
return "", "", errors.New("invalid process status")
}
fields := strings.Fields(string(data[closing+1:]))
if len(fields) <= 19 {
return "", "", errors.New("incomplete process status")
}
return fields[0], fields[19], nil
}
func busNameOwner(ctx context.Context, connection *dbus.Conn) (string, error) {
var owner string
err := connection.BusObject().CallWithContext(ctx, "org.freedesktop.DBus.GetNameOwner", 0, remote.BusName).Store(&owner)
if err == nil {
return owner, nil
}
var busError dbus.Error
if errors.As(err, &busError) && busError.Name == "org.freedesktop.DBus.Error.NameHasNoOwner" {
return "", nil
}
return "", fmt.Errorf("query running reader: %w", err)
}
func verifyReaderExecutable(pid int) error {
running, err := os.Readlink(fmt.Sprintf("/proc/%d/exe", pid))
if err != nil {
return fmt.Errorf("inspect running reader: %w", err)
}
current, err := os.Executable()
if err != nil {
return fmt.Errorf("inspect current reader: %w", err)
}
running = strings.TrimSuffix(running, " (deleted)")
if filepath.Base(running) != filepath.Base(current) {
return fmt.Errorf("D-Bus owner is %q, not %q", running, filepath.Base(current))
}
return nil
}
+95
View File
@@ -0,0 +1,95 @@
// Copyright (c) 2026 Storm Dragon
// Authors: Storm Dragon, Angus Kola
// SPDX-License-Identifier: GPL-3.0-or-later
package main
import (
"bufio"
"context"
"fmt"
"os"
"os/exec"
"os/signal"
"syscall"
"testing"
"time"
"git.stormux.org/storm/cthulhu/internal/remote"
"github.com/godbus/dbus/v5"
)
func TestReplaceHelper(t *testing.T) {
if os.Getenv("CTHULHU_REPLACE_HELPER") != "1" {
return
}
connection, err := dbus.ConnectSessionBus()
if err != nil {
t.Fatal(err)
}
defer connection.Close()
reply, err := connection.RequestName(remote.BusName, dbus.NameFlagDoNotQueue)
if err != nil || reply != dbus.RequestNameReplyPrimaryOwner {
t.Fatalf("own reader bus name: %v, %v", reply, err)
}
fmt.Println("READY")
signals := make(chan os.Signal, 1)
signal.Notify(signals, syscall.SIGTERM)
defer signal.Stop(signals)
<-signals
}
func TestReplaceRunningNative(t *testing.T) {
if os.Getenv("CTHULHU_NATIVE_REPLACE") != "1" {
t.Skip("requires isolated session bus")
}
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := replaceRunning(ctx); err != nil {
t.Fatalf("replace with no reader: %v", err)
}
command := exec.CommandContext(ctx, os.Args[0], "-test.run=^TestReplaceHelper$")
command.Env = append(os.Environ(), "CTHULHU_REPLACE_HELPER=1")
output, err := command.StdoutPipe()
if err != nil {
t.Fatal(err)
}
command.Stderr = os.Stderr
if err := command.Start(); err != nil {
t.Fatal(err)
}
defer func() {
if command.ProcessState == nil {
command.Process.Kill()
command.Wait()
}
}()
ready := make(chan bool, 1)
go func() {
scanner := bufio.NewScanner(output)
for scanner.Scan() {
if scanner.Text() == "READY" {
ready <- true
return
}
}
ready <- false
}()
select {
case started := <-ready:
if !started {
t.Fatal("helper did not claim bus name")
}
case <-ctx.Done():
t.Fatal("helper did not claim bus name")
}
if err := replaceRunning(ctx); err != nil {
t.Fatal(err)
}
if err := command.Wait(); err != nil {
t.Fatalf("running reader did not exit cleanly: %v", err)
}
if err := replaceRunning(ctx); err != nil {
t.Fatalf("replace after reader exit: %v", err)
}
}
+65
View File
@@ -0,0 +1,65 @@
// Cthulhu screen reader.
// Copyright (c) 2026 Storm Dragon
// Authors: Storm Dragon, Angus Kola
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// This program 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 program. If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.
package main
import (
"fmt"
"io"
"os"
"git.stormux.org/storm/cthulhu/internal/parity"
)
func main() {
if err := run(os.Args[1:], os.Stdout, os.Stderr); err != nil {
fmt.Fprintf(os.Stderr, "parityledger: %v\n", err)
os.Exit(1)
}
}
func run(arguments []string, stdout, stderr io.Writer) error {
if len(arguments) == 1 && (arguments[0] == "-h" || arguments[0] == "--help") {
writeUsage(stdout)
return nil
}
if len(arguments) != 2 || arguments[0] != "validate" {
writeUsage(stderr)
return fmt.Errorf("expected validate LEDGER")
}
file, err := os.Open(arguments[1])
if err != nil {
return fmt.Errorf("open parity ledger: %w", err)
}
defer file.Close()
records, err := parity.Load(file)
if err != nil {
return fmt.Errorf("validate parity ledger: %w", err)
}
fmt.Fprintf(stdout, "Validated %d parity ledger rows.\n", len(records))
return nil
}
func writeUsage(writer io.Writer) {
fmt.Fprintln(writer, "Usage: parityledger validate LEDGER")
fmt.Fprintln(writer)
fmt.Fprintln(writer, "Validates the schema, required fields, statuses, and duplicate row IDs.")
fmt.Fprintln(writer)
fmt.Fprintf(writer, "Allowed statuses: %s.\n", parity.FormatStatuses())
}
+47
View File
@@ -0,0 +1,47 @@
// Cthulhu screen reader.
// Copyright (c) 2026 Storm Dragon
// Authors: Storm Dragon, Angus Kola
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// This program 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 program. If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.
package main
import (
"bytes"
"path/filepath"
"strings"
"testing"
)
func TestValidateFixture(t *testing.T) {
var stdout bytes.Buffer
ledgerPath := filepath.Join("..", "..", "testdata", "parity-ledger.csv")
if err := run([]string{"validate", ledgerPath}, &stdout, &stdout); err != nil {
t.Fatalf("validate fixture: %v", err)
}
if !strings.HasPrefix(stdout.String(), "Validated ") ||
!strings.Contains(stdout.String(), " parity ledger rows.") {
t.Fatalf("unexpected validation output: %q", stdout.String())
}
}
func TestUsage(t *testing.T) {
var stdout bytes.Buffer
if err := run([]string{"--help"}, &stdout, &stdout); err != nil {
t.Fatalf("run --help: %v", err)
}
if !strings.Contains(stdout.String(), "Usage: parityledger validate LEDGER") {
t.Fatalf("unexpected usage output: %q", stdout.String())
}
}
+84
View File
@@ -0,0 +1,84 @@
// Copyright (c) 2026 Storm Dragon
// SPDX-License-Identifier: GPL-3.0-or-later
// A host diagnostic tool for external Tentacles, independent of the running reader.
package main
import (
"context"
"encoding/json"
"errors"
"flag"
"fmt"
"os"
"time"
"git.stormux.org/storm/cthulhu/internal/tentacle"
)
func main() {
if err := run(); err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
}
func run() (runError error) {
options := flag.NewFlagSet("host", flag.ContinueOnError)
cgroupParent := options.String("cgroup-parent", "", "delegated cgroup v2 parent for resource containment")
presentation := options.Bool("presentation", false, "grant command speech/braille result capability (prints JSON only)")
interactive := options.Bool("interaction", false, "grant internal form/clipboard/focused-item capability (prints initial JSON only)")
command := options.String("command", "echo", "registered command to invoke")
if err := options.Parse(os.Args[1:]); err != nil {
return err
}
if options.NArg() < 1 {
return fmt.Errorf("usage: host [-cgroup-parent /delegated/parent] /absolute/program [arguments...]")
}
var manager *tentacle.Manager
var err error
if *cgroupParent == "" {
manager, err = tentacle.NewManager(tentacle.DefaultLimits(), nil)
} else {
manager, err = tentacle.NewContainedManager(tentacle.DefaultLimits(), nil, *cgroupParent, tentacle.DefaultResourceLimits())
}
if err != nil {
return err
}
defer func() {
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
defer cancel()
runError = errors.Join(runError, manager.Shutdown(ctx))
}()
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
session, err := manager.Start(ctx, tentacle.Spec{ID: "local-example", Program: options.Args(), Presentation: *presentation, Interaction: *interactive})
if err != nil {
return err
}
select {
case <-session.Ready():
case <-ctx.Done():
return ctx.Err()
}
if state, err := session.Status(); state != tentacle.Ready {
return fmt.Errorf("startup %s: %v", state, err)
}
if err := session.Activate(); err != nil {
return err
}
pending, err := session.Invoke(ctx, *command, json.RawMessage(`{"text":"Hello, é猫😀é"}`))
if err != nil {
return err
}
select {
case result := <-pending:
if result.Err != nil {
return result.Err
}
fmt.Println(string(result.Value))
return nil
case <-ctx.Done():
return ctx.Err()
}
}
-177
View File
@@ -1,177 +0,0 @@
m4_define([get_version], [m4_esyscmd_s([
grep "^version = " src/cthulhu/cthulhuVersion.py | sed 's/version = "\(.*\)"/\1/'
])])
m4_define([cthulhu_version], [get_version])
m4_define(pygobject_required_version, 3.18)
m4_define(atspi_required_version, 2.48)
m4_define(atkbridge_required_version, 2.26)
AC_INIT([cthulhu],[cthulhu_version],[https://gitlab.gnome.org/GNOME/cthulhu/-/issues/],[cthulhu])
AC_CONFIG_MACRO_DIR([m4])
AM_INIT_AUTOMAKE([1.11 tar-ustar no-dist-gzip dist-xz])
AM_MAINTAINER_MODE([enable])
dnl Gettext stuff
# FIXME: Remove AM_GNU_GETTEXT_VERSION once autoreconf supports REQUIRE_VERSION
AM_GNU_GETTEXT_VERSION([0.19.8])
AM_GNU_GETTEXT_REQUIRE_VERSION([0.19.8])
AM_GNU_GETTEXT([external])
GETTEXT_PACKAGE=AC_PACKAGE_TARNAME
AC_SUBST(GETTEXT_PACKAGE)
AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE,"$GETTEXT_PACKAGE", [gettext package])
# User Documentation
YELP_HELP_INIT
PKG_CHECK_MODULES([PYGOBJECT], [pygobject-3.0 >= pygobject_required_version])
PKG_CHECK_MODULES([ATSPI2], [atspi-2 >= atspi_required_version])
PKG_CHECK_MODULES([ATKBRIDGE], [atk-bridge-2.0 >= atkbridge_required_version])
PKG_CHECK_MODULES([GSTREAMER], [gstreamer-1.0], [gstreamer="yes"], [gstreamer="no"])
PKG_CHECK_MODULES([LIBPEAS], [libpeas-1.0])
dnl Needed programs
AC_PROG_INSTALL
dnl Check for python and python modules needed by Cthulhu
dnl TODO: check for incompatibilities between Cthulhu and liblouis
dnl per http://live.gnome.org/Cthulhu/Braille
AM_PATH_PYTHON(3.3)
# Don't require the DISPLAY to be set - the gtk checking will fail
# if DISPLAY is not set, and we don't like that.
AM_CHECK_PYMOD(gi,,,[AC_MSG_ERROR(Could not find python module: gi)])
AM_CHECK_PYMOD(json,,,[AC_MSG_ERROR(Could not find python module: json)])
AM_CHECK_PYMOD(pluggy,,[pluggy_available="yes"],[pluggy_available="no"])
AM_CHECK_PYMOD(brlapi,,[brlapi_available="yes"],[brlapi_available="no"])
AM_CHECK_PYMOD(speechd,,[speechd_available="yes"],[speechd_available="no"])
AC_ARG_WITH([liblouis],
AS_HELP_STRING([--without-liblouis], [Disable liblouis support]))
AS_IF([test "x$with_liblouis" != xno],
[AM_CHECK_PYMOD(louis,,[louis_available="yes"],[louis_available="no"])],
[louis_available=no])
if test "x$with_liblouis" = xyes -a "x$louis_available" = xno; then
AC_MSG_ERROR([Liblouis was requested but could not be found])
fi
LOUIS_TABLE_DIR=""
if test x$louis_available = "xyes"; then
LOUIS_TABLE_DIR=`pkg-config --variable=tablesdir liblouis`
fi
AC_SUBST(LOUIS_TABLE_DIR)
REVISION=`git rev-parse --short HEAD 2> /dev/null`
AC_SUBST(REVISION)
dnl Check for the OS. On *Solaris systems the PATH must be set
PLATFORM=`uname -a`
case "${PLATFORM}" in
*SunOS*)
PLATFORM_PATH=":/usr/ccs/bin:/usr/bin:/usr/sbin:/bin:/usr/sfw/bin:/usr/openwin/bin:/usr/X11R6/bin"
;;
*Linux*)
PLATFORM_PATH=":/usr/bin:/usr/sbin:/bin"
;;
esac
AC_SUBST(PLATFORM_PATH)
AC_CONFIG_FILES([
Makefile
docs/Makefile
docs/man/Makefile
po/Makefile.in
help/Makefile
icons/Makefile
src/Makefile
src/cthulhu/Makefile
src/cthulhu/scripts/Makefile
src/cthulhu/scripts/apps/Makefile
src/cthulhu/scripts/apps/Banshee/Makefile
src/cthulhu/scripts/apps/Eclipse/Makefile
src/cthulhu/scripts/apps/epiphany/Makefile
src/cthulhu/scripts/apps/evince/Makefile
src/cthulhu/scripts/apps/evolution/Makefile
src/cthulhu/scripts/apps/gajim/Makefile
src/cthulhu/scripts/apps/gcalctool/Makefile
src/cthulhu/scripts/apps/gedit/Makefile
src/cthulhu/scripts/apps/gnome-documents/Makefile
src/cthulhu/scripts/apps/gnome-shell/Makefile
src/cthulhu/scripts/apps/kwin/Makefile
src/cthulhu/scripts/apps/notification-daemon/Makefile
src/cthulhu/scripts/apps/notify-osd/Makefile
src/cthulhu/scripts/apps/pidgin/Makefile
src/cthulhu/scripts/apps/soffice/Makefile
src/cthulhu/scripts/apps/SeaMonkey/Makefile
src/cthulhu/scripts/apps/smuxi-frontend-gnome/Makefile
src/cthulhu/scripts/apps/Thunderbird/Makefile
src/cthulhu/scripts/apps/xfwm4/Makefile
src/cthulhu/scripts/sleepmode/Makefile
src/cthulhu/scripts/switcher/Makefile
src/cthulhu/scripts/terminal/Makefile
src/cthulhu/scripts/web/Makefile
src/cthulhu/scripts/toolkits/Makefile
src/cthulhu/scripts/toolkits/Chromium/Makefile
src/cthulhu/scripts/toolkits/Gecko/Makefile
src/cthulhu/scripts/toolkits/J2SE-access-bridge/Makefile
src/cthulhu/scripts/toolkits/clutter/Makefile
src/cthulhu/scripts/toolkits/GAIL/Makefile
src/cthulhu/scripts/toolkits/Qt/Makefile
src/cthulhu/scripts/toolkits/WebKitGtk/Makefile
src/cthulhu/scripts/toolkits/gtk/Makefile
src/cthulhu/plugins/Makefile
src/cthulhu/plugins/ByeCthulhu/Makefile
src/cthulhu/plugins/HelloCthulhu/Makefile
src/cthulhu/plugins/PluginManager/Makefile
src/cthulhu/plugins/Clipboard/Makefile
src/cthulhu/plugins/DisplayVersion/Makefile
src/cthulhu/plugins/hello_world/Makefile
src/cthulhu/plugins/CapsLockHack/Makefile
src/cthulhu/plugins/self_voice/Makefile
src/cthulhu/plugins/Date/Makefile
src/cthulhu/plugins/Time/Makefile
src/cthulhu/plugins/MouseReview/Makefile
src/cthulhu/plugins/SimplePluginSystem/Makefile
src/cthulhu/backends/Makefile
src/cthulhu/cthulhu_bin.py
src/cthulhu/cthulhu_i18n.py
src/cthulhu/cthulhu_platform.py
])
AC_CONFIG_COMMANDS([default],[cp src/cthulhu/cthulhu_bin.py src/cthulhu/cthulhu],[])
AC_OUTPUT
if test "x$brlapi_available" = "xno" ; then
echo
echo "NOTE: Braille support requires BrlTTY >= 3.9 and BrlAPI >= 0.5.1."
fi
if test "x$wnck_available" = "xno" ; then
echo
echo "NOTE: Mouse review requires wnck, which was not found."
fi
if test "x$speechd_available" = "xno" ; then
echo
echo "NOTE: Speech support requires speech-dispatcher >= 0.8."
fi
if test "x$gstreamer" = "xno" ; then
echo
echo "NOTE: Sound support requires gstreamer-1.0."
fi
if test "$have_libpeas" = "no"; then
AC_MSG_ERROR([libpeas-1.0 >= 1.20 is required])
fi
echo
echo Use pluggy: $pluggy_available
echo Use speech-dispatcher: $speechd_available
echo Use brltty: $brlapi_available
echo Use liblouis: $louis_available
echo Use gstreamer: $gstreamer
echo
-20
View File
@@ -1,20 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<schemalist gettext-domain="slint">
<schema id="toggle.screenreader" path="/toggle/screenreader/">
<key name="binding" type="s">
<default>'&lt;Shift&gt;&lt;Alt&gt;v'</default>
<summary>Keybinding</summary>
<description>Keybinding associated to toggle screen reader.</description>
</key>
<key name="action" type="s">
<default>'/opt/I38/scripts/toggle_screenreader.sh 1>/dev/null'</default>
<summary>Command</summary>
<description>Command to toggle the screen reader between orca and cthulhu.</description>
</key>
<key name="name" type="s">
<default>'Toggle screenreader'</default>
<summary>Name</summary>
<description>Description associated to toggle screen reader.</description>
</key>
</schema>
</schemalist>
-46
View File
@@ -1,46 +0,0 @@
[Desktop Entry]
Type=Application
Name[an]=Lector de pantalla Cthulhu
Name[ast]=Llector de pantalla Cthulhu
Name[be]=ÐÑÑÐÑÑÐ Cthulhu
Name[bg]=Cthulhu âÐÐÐ ÑÑÑName[bs]=Cthulhu ÄtaÄekrana
Name[ca]=Lector de pantalla Cthulhu
Name[cs]=ÄeÄa obrazovky Cthulhu
Name[da]=SkÃmlÃeren Cthulhu
Name[de]=Cthulhu-Bildschirmleser
Name[el]=ÎÎÎÏÎ ÎÏÎ Cthulhu
Name[en_GB]=Cthulhu Screen Reader
Name[eo]=Ekranlegilo Cthulhu
Name[es]=Lector de pantalla Cthulhu
Name[eu]=Cthulhu pantaila-irakurlea
Name[fa]=ØØâØ Cthulhu
Name[fi]=Cthulhu-nÃtÃlukija
Name[fr]=Lecteur dâran Cthulhu
Name[gl]=Lector da pantalla Cthulhu
Name[he]=××××× Cthulhu
Name[hi]=Cthulhu àààà
Name[hu]=Cthulhu kÃernyÅlvasÃName[id]=Pembaca Layar Cthulhu
Name[is]=Cthulhu skjÃestur
Name[it]=Lettore schermo Cthulhu
Name[ka]=Cthulhu - ááááááName[kk]=Cthulhu ÑÑÐÐ ÐÐÑ ÒÐÐÐÑ
Name[lt]=Cthulhu ekrano skaityklÄName[lv]=Cthulhu ekrÄa lasÄÄs
Name[mk]=Cthulhu ÑÑÑÐ ÐÑÐÑName[nb]=Cthulhu skjermleser
Name[ne]=Cthulhu àà ààame[nl]=Cthulhu schermlezer
Name[oc]=Lector d'ecran Cthulhu
Name[pa]=Cthulhu ààààame[pl]=Czytnik ekranowy Cthulhu
Name[pt]=Leitor de ecrÃCthulhu
Name[pt_BR]=Leitor de tela Cthulhu
Name[ro]=Cititorul de ecran Cthulhu
Name[ru]=ÐÑÐÑ ÐÐÐ Cthulhu
Name[sl]=Zaslonski bralnik Cthulhu
Name[sr]=ÐÑÑÐÑÐ Cthulhu
Name[sv]=Cthulhu skÃmlÃare
Name[ta]=Cthulhu àààà
Name[te]=Cthulhu ààà
Name[tg]=ÐÐÐÐ ÑÑÐ Cthulhu
Name[tr]=Cthulhu Ekran Okuyucu
Name[ug]=Cthulhu ØÙØ ØÙØ
Name[uk]=ÐÑÑÐÐ ÑÑÐÑÐÐÑÐ ÂthulhuÂName[zh_CN]=Cthulhu åèName[zh_HK]=Cthulhu èèName=Cthulhu Screen Reader
Exec=cthulhu
NoDisplay=true
X-GNOME-AutoRestart=true
-9
View File
@@ -1,9 +0,0 @@
[Desktop Entry]
Type=Application
Name=Cthulhu Screen Reader
Exec=cthulhu
NoDisplay=true
AutostartCondition=GSettings org.gnome.desktop.a11y.applications screen-reader-enabled
X-GNOME-AutoRestart=true
#X-GNOME-Autostart-Phase=Initialization
OnlyShowIn=GNOME;MATE;Unity;Cinnamon;
-30
View File
@@ -1,30 +0,0 @@
<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xmlns:foaf="http://xmlns.com/foaf/0.1/"
xmlns:gnome="http://api.gnome.org/doap-extensions#"
xmlns="http://usefulinc.com/ns/doap#">
<name xml:lang="en">cthulhu</name>
<shortdesc xml:lang="en">Screen reader for individuals who are blind or visually impaired</shortdesc>
<description xml:lang="en">Screen reader for individuals who are blind or visually impaired</description>
<homepage rdf:resource="https://wiki.gnome.org/Projects/Cthulhu" />
<mailing-list rdf:resource="https://www.freelists.org/list/cthulhu" />
<download-page rdf:resource="https://download.gnome.org/sources/cthulhu/" />
<bug-database rdf:resource="https://gitlab.gnome.org/GNOME/cthulhu/issues" />
<category rdf:resource="http://api.gnome.org/doap-extensions#apps" />
<programming-language>Python</programming-language>
<maintainer>
<foaf:Person>
<foaf:name>Joanmarie Diggs</foaf:name>
<foaf:mbox rdf:resource="mailto:jdiggs@igalia.com" />
<gnome:userid>joanied</gnome:userid>
</foaf:Person>
</maintainer>
<maintainer>
<foaf:Person>
<foaf:name>Federico Mena Quintero</foaf:name>
<foaf:mbox rdf:resource="mailto:federico@gnome.org" />
<gnome:userid>federico</gnome:userid>
</foaf:Person>
</maintainer>
</Project>
-63
View File
@@ -1,63 +0,0 @@
# Maintainer: Storm Dragon <storm_dragon@stormux.org>
pkgname=cthulhu
pkgver=0.4
pkgrel=1
pkgdesc="Screen reader for individuals who are blind or visually impaired forked from Orca"
url="https://git.stormux.org/storm/cthulhu"
arch=(any)
license=(LGPL)
depends=(
at-spi2-core
brltty
gobject-introspection-runtime
gsettings-desktop-schemas
gstreamer
gst-plugins-base # playbin, audiotestsrc, basic decoders
gst-plugins-good # pulsesink, more decoders
gtk3
hicolor-icon-theme
liblouis
libpeas
libwnck3
pango
python
python-atspi
python-cairo
python-gobject
python-setproctitle
socat
speech-dispatcher
xorg-xkbcomp
xorg-xmodmap
)
makedepends=(
git
itstool
yelp-tools
)
source=("git+https://git.stormux.org/storm/cthulhu.git")
b2sums=('SKIP')
prepare() {
cd cthulhu
NOCONFIGURE=1 ./autogen.sh
}
pkgver() {
cd cthulhu
grep "^version = " src/cthulhu/cthulhuVersion.py | sed 's/version = "\(.*\)"/\1/'
}
build() {
cd cthulhu
./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
make
}
package() {
cd cthulhu
make DESTDIR="$pkgdir" install
}
# vim:set sw=2 sts=-1 et:
@@ -0,0 +1,42 @@
pkgbase = cthulhu-git
pkgdesc = Desktop-agnostic screen reader with speech, Braille, and Tentacle support
pkgver = 2026.10.14.r3.ge5049b9
pkgrel = 1
url = https://git.stormux.org/storm/cthulhu
arch = x86_64
arch = aarch64
arch = armv7h
license = GPL-3.0-or-later
makedepends = git
makedepends = go
makedepends = pkgconf
depends = glibc
depends = at-spi2-core
depends = glib2
depends = gdk-pixbuf2
depends = gtk3
depends = speech-dispatcher
depends = gstreamer
depends = gst-plugins-base
depends = gst-plugins-good
depends = brltty
depends = liblouis
depends = libx11
depends = libxtst
depends = libxfixes
depends = libxkbcommon
depends = xclip
depends = dbus
depends = systemd
optdepends = git: Discover and update Tentacle repositories
optdepends = tesseract: OCR engine for text recognition
optdepends = tesseract-data-eng: English OCR language data
provides = cthulhu=2026.10.14.r3.ge5049b9
conflicts = cthulhu
options = !debug
options = !lto
source = cthulhu::git+https://git.stormux.org/storm/cthulhu.git#branch=master
sha512sums = SKIP
optdepends_x86_64 = wine-access: Wine, Proton, NVDA Controller, and Tolk integration
pkgname = cthulhu-git
@@ -0,0 +1,109 @@
# Maintainer: Storm Dragon <storm_dragon@stormux.org>
# shellcheck shell=bash disable=SC2034,SC2154,SC2164
pkgbase=cthulhu-git
pkgname=cthulhu-git
_pkgname=cthulhu
pkgver=2026.10.14.r6.gb2f558c
pkgrel=1
pkgdesc="Desktop-agnostic screen reader with speech, Braille, and Tentacle support"
url="https://git.stormux.org/storm/cthulhu"
arch=(x86_64 aarch64 armv7h)
license=(GPL-3.0-or-later)
provides=("${_pkgname}=${pkgver}")
conflicts=("${_pkgname}")
depends=(
# Native accessibility and user interface
glibc
at-spi2-core
glib2
gdk-pixbuf2
gtk3
# Audio and speech
speech-dispatcher
gstreamer
gst-plugins-base # playbin, audiotestsrc, basic decoders
gst-plugins-good # pulsesink, more decoders
# Braille support
brltty
liblouis
# Xorg input, window capture, and clipboard operations
libx11
libxtst
libxfixes
libxkbcommon
xclip
# Private D-Bus services and contained Tentacle processes
dbus
systemd
)
optdepends=(
'git: Discover and update Tentacle repositories'
'tesseract: OCR engine for text recognition'
'tesseract-data-eng: English OCR language data'
)
optdepends_x86_64=(
# Wine accessibility helpers are supported on x86_64.
'wine-access: Wine, Proton, NVDA Controller, and Tolk integration'
)
makedepends=(
git
go
pkgconf
)
options=(!debug !lto)
source=("${_pkgname}::git+https://git.stormux.org/storm/${_pkgname}.git#branch=master")
sha512sums=('SKIP')
prepare() {
cd "${_pkgname}"
git checkout -B testing origin/testing
}
pkgver() {
cd "${_pkgname}"
local projectVersion revisionCount commitHash
projectVersion=$(sed -n 's/^const Version = "\([^"]*\)"/\1/p' internal/version/version.go)
[[ -n "${projectVersion}" ]] || return 1
revisionCount=$(git rev-list --count HEAD)
commitHash=$(git rev-parse --short=7 HEAD)
echo "${projectVersion}.r${revisionCount}.g${commitHash}"
}
build() {
cd "${_pkgname}"
export CGO_ENABLED=1
export CGO_CPPFLAGS="${CPPFLAGS}"
export CGO_CFLAGS="${CFLAGS}"
export CGO_CXXFLAGS="${CXXFLAGS}"
export CGO_LDFLAGS="${LDFLAGS}"
export GOPATH="${srcdir}/go"
export GOCACHE="${GOCACHE:-${srcdir}/go-build}"
export GOFLAGS="-buildmode=pie -trimpath -ldflags=-linkmode=external -mod=readonly -modcacherw"
go build -o build/cthulhu ./cmd/cthulhu
go build -tags brlapi -o build/cthulhu-braille ./cmd/cthulhu-braille
}
check() {
cd "${_pkgname}"
export CGO_ENABLED=1
export GOPATH="${srcdir}/go"
export GOCACHE="${GOCACHE:-${srcdir}/go-build}"
go test -tags brlapi ./... -count=1
}
package() {
cd "${_pkgname}"
install -Dm755 build/cthulhu "${pkgdir}/usr/bin/cthulhu"
install -Dm755 build/cthulhu-braille "${pkgdir}/usr/bin/cthulhu-braille"
install -Dm644 LICENSE "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE"
install -Dm644 AUTHORS "${pkgdir}/usr/share/doc/${pkgname}/AUTHORS"
}
# vim:set sw=2 sts=-1 et:
@@ -1,98 +0,0 @@
#!/bin/bash
# Slackware build script for cthulhu
# Created based on PKGBUILD from Storm Dragon <storm_dragon@stormux.org>
cd $(dirname $0) ; CWD=$(pwd)
PRGNAM=cthulhu
VERSION=${VERSION:-0.4}
BUILD=${BUILD:-1}
TAG=storm
PKGTYPE=txz
export PYTHON=/usr/bin/python3.11
if [ -z "$ARCH" ]; then
case "$( uname -m )" in
i?86) ARCH=i586 ;;
arm*) ARCH=arm ;;
*) ARCH=$( uname -m ) ;;
esac
fi
# If the variable PRINT_PACKAGE_NAME is set, then this script will report what
# the name of the created package would be, and then exit. This information
# could be useful to other scripts.
if [ ! -z "${PRINT_PACKAGE_NAME}" ]; then
echo "$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE"
exit 0
fi
TMP=$CWD
PKG=$TMP/package-$PRGNAM
OUTPUT=$CWD
if [ "$ARCH" = "i586" ]; then
SLKCFLAGS="-O2 -march=i586 -mtune=i686"
LIBDIRSUFFIX=""
elif [ "$ARCH" = "i686" ]; then
SLKCFLAGS="-O2 -march=i686 -mtune=i686"
LIBDIRSUFFIX=""
elif [ "$ARCH" = "x86_64" ]; then
SLKCFLAGS="-O2 -fPIC"
LIBDIRSUFFIX="64"
else
SLKCFLAGS="-O2"
LIBDIRSUFFIX=""
fi
set -e
rm -rf $PKG
mkdir -p $TMP $PKG $OUTPUT
cd $TMP
rm -rf $PRGNAM-$VERSION
git clone https://git.stormux.org/storm/cthulhu.git $PRGNAM-$VERSION
cd $PRGNAM-$VERSION
chown -R root:root .
find -L . \
\( -perm 777 -o -perm 775 -o -perm 750 -o -perm 711 -o -perm 555 \
-o -perm 511 \) -exec chmod 755 {} \; -o \
\( -perm 666 -o -perm 664 -o -perm 640 -o -perm 600 -o -perm 444 \
-o -perm 440 -o -perm 400 \) -exec chmod 644 {} \;
# Prepare the source
NOCONFIGURE=1 ./autogen.sh
CFLAGS="$SLKCFLAGS" \
CXXFLAGS="$SLKCFLAGS" \
./configure \
--prefix=/usr \
--libdir=/usr/lib${LIBDIRSUFFIX} \
--sysconfdir=/etc \
--localstatedir=/var \
--mandir=/usr/man \
--docdir=/usr/doc/$PRGNAM-$VERSION \
--build=$ARCH-slackware-linux
make
make install DESTDIR=$PKG
find $PKG -print0 | xargs -0 file | grep -e "executable" -e "shared object" | grep ELF \
| cut -f 1 -d : | xargs strip --strip-unneeded 2> /dev/null || true
mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION
cp -a AUTHORS COPYING ChangeLog NEWS README.md \
$PKG/usr/doc/$PRGNAM-$VERSION
cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
mkdir -p $PKG/install
cat $CWD/slack-desc > $PKG/install/slack-desc
cat $CWD/doinst.sh > $PKG/install/doinst.sh
cd $PKG
# let's avoid a "bad interpreter error
sed "s,#!python3.11,#!/usr/bin/python3.11," usr/bin/cthulhu > dummy
mv dummy usr/bin/cthulhu
chmod 755 usr/bin/cthulhu
/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE
-28
View File
@@ -1,28 +0,0 @@
Cthulhu is a screen reader for individuals who are blind or visually impaired,
forked from Orca. It provides access to applications and toolkits that support
the AT-SPI (e.g., the GNOME desktop).
This screen reader helps users navigate their desktop environment and applications
through speech synthesis and braille output.
After installation, you can start Cthulhu through the GNOME desktop environment
or by running 'cthulhu' from the command line.
DEPENDENCIES:
This package requires the following packages, all available from SlackBuilds.org:
- at-spi2-core
- brltty
- gobject-introspection
- gsettings-desktop-schemas
- gstreamer
- gst-plugins-base
- gst-plugins-good
- gtk3
- liblouis
- libpeas
- libwnck3
- python3-atspi
- python3-cairo
- python3-gobject
- python3-setproctitle
- speech-dispatcher
-10
View File
@@ -1,10 +0,0 @@
PRGNAM="cthulhu"
VERSION="0.4"
HOMEPAGE="https://git.stormux.org/storm/cthulhu"
DOWNLOAD="https://git.stormux.org/storm/cthulhu.git"
MD5SUM="SKIP"
DOWNLOAD_x86_64=""
MD5SUM_x86_64=""
REQUIRES="at-spi2-core brltty gobject-introspection gsettings-desktop-schemas gstreamer gst-plugins-base gst-plugins-good gtk3 liblouis libpeas libwnck3 python3-atspi python3-cairo python3-gobject python3-setproctitle speech-dispatcher"
MAINTAINER="Storm Dragon"
EMAIL="storm_dragon@stormux.org"
-98
View File
@@ -1,98 +0,0 @@
#!/bin/bash
# Slackware build script for cthulhu
# Created based on PKGBUILD from Storm Dragon <storm_dragon@stormux.org>
cd $(dirname $0) ; CWD=$(pwd)
PRGNAM=cthulhu
VERSION=${VERSION:-0.4}
BUILD=${BUILD:-1}
TAG=storm
PKGTYPE=txz
export PYTHON=/usr/bin/python3.11
if [ -z "$ARCH" ]; then
case "$( uname -m )" in
i?86) ARCH=i586 ;;
arm*) ARCH=arm ;;
*) ARCH=$( uname -m ) ;;
esac
fi
# If the variable PRINT_PACKAGE_NAME is set, then this script will report what
# the name of the created package would be, and then exit. This information
# could be useful to other scripts.
if [ ! -z "${PRINT_PACKAGE_NAME}" ]; then
echo "$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE"
exit 0
fi
TMP=$CWD
PKG=$TMP/package-$PRGNAM
OUTPUT=$CWD
if [ "$ARCH" = "i586" ]; then
SLKCFLAGS="-O2 -march=i586 -mtune=i686"
LIBDIRSUFFIX=""
elif [ "$ARCH" = "i686" ]; then
SLKCFLAGS="-O2 -march=i686 -mtune=i686"
LIBDIRSUFFIX=""
elif [ "$ARCH" = "x86_64" ]; then
SLKCFLAGS="-O2 -fPIC"
LIBDIRSUFFIX="64"
else
SLKCFLAGS="-O2"
LIBDIRSUFFIX=""
fi
set -e
rm -rf $PKG
mkdir -p $TMP $PKG $OUTPUT
cd $TMP
rm -rf $PRGNAM-$VERSION
git clone https://git.stormux.org/storm/cthulhu.git $PRGNAM-$VERSION
cd $PRGNAM-$VERSION
chown -R root:root .
find -L . \
\( -perm 777 -o -perm 775 -o -perm 750 -o -perm 711 -o -perm 555 \
-o -perm 511 \) -exec chmod 755 {} \; -o \
\( -perm 666 -o -perm 664 -o -perm 640 -o -perm 600 -o -perm 444 \
-o -perm 440 -o -perm 400 \) -exec chmod 644 {} \;
# Prepare the source
NOCONFIGURE=1 ./autogen.sh
CFLAGS="$SLKCFLAGS" \
CXXFLAGS="$SLKCFLAGS" \
./configure \
--prefix=/usr \
--libdir=/usr/lib${LIBDIRSUFFIX} \
--sysconfdir=/etc \
--localstatedir=/var \
--mandir=/usr/man \
--docdir=/usr/doc/$PRGNAM-$VERSION \
--build=$ARCH-slackware-linux
make
make install DESTDIR=$PKG
find $PKG -print0 | xargs -0 file | grep -e "executable" -e "shared object" | grep ELF \
| cut -f 1 -d : | xargs strip --strip-unneeded 2> /dev/null || true
mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION
cp -a AUTHORS COPYING ChangeLog NEWS README.md \
$PKG/usr/doc/$PRGNAM-$VERSION
cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
mkdir -p $PKG/install
cat $CWD/slack-desc > $PKG/install/slack-desc
cat $CWD/doinst.sh > $PKG/install/doinst.sh
cd $PKG
# let's avoid a "bad interpreter error
sed "s,#!python3.11,#!/usr/bin/python3.11," usr/bin/cthulhu > dummy
mv dummy usr/bin/cthulhu
chmod 755 usr/bin/cthulhu
/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE
-9
View File
@@ -1,9 +0,0 @@
if [ -x /usr/bin/update-desktop-database ]; then
/usr/bin/update-desktop-database -q usr/share/applications >/dev/null 2>&1
fi
if [ -e usr/share/icons/hicolor/icon-theme.cache ]; then
if [ -x /usr/bin/gtk-update-icon-cache ]; then
/usr/bin/gtk-update-icon-cache usr/share/icons/hicolor >/dev/null 2>&1
fi
fi
-19
View File
@@ -1,19 +0,0 @@
# HOW TO EDIT THIS FILE:
# The "handy ruler" below makes it easier to edit a package description.
# Line up the first '|' above the ':' following the base package name, and
# the '|' on the right side marks the last column you can put a character in.
# You must make exactly 11 lines for the formatting to be correct. It's also
# customary to leave one space after the ':' except on otherwise blank lines.
|-----handy-ruler------------------------------------------------------|
cthulhu: cthulhu (Screen reader for blind or visually impaired users)
cthulhu:
cthulhu: Cthulhu is a screen reader for individuals who are blind or visually
cthulhu: impaired, forked from Orca. It provides a way to access applications
cthulhu: and toolkits that support the AT-SPI (e.g., the GNOME desktop).
cthulhu:
cthulhu: Homepage: https://git.stormux.org/storm/cthulhu
cthulhu:
cthulhu:
cthulhu:
cthulhu:
-1
View File
@@ -1 +0,0 @@
SUBDIRS = man
-5
View File
@@ -1,5 +0,0 @@
man1_MANS = cthulhu.1
EXTRA_DIST = \
$(man1_MANS)
-334
View File
@@ -1,334 +0,0 @@
.\" 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 cthulhu 1 "20 September 2013" "GNOME"
.SH NAME
cthulhu \- a scriptable screen reader
.SH SYNOPSIS
.B cthulhu
.RI [ option... ]
.SH DESCRIPTION
.B cthulhu
is a screen reader for people with visual impairments,
it provides alternative access to the desktop by using speech synthesis and braille.
.P
.B cthulhu
works with applications and toolkits that support
the Assistive Technology Service Provider Interface (AT-SPI), which
is the primary assistive technology infrastructure for Linux and
Solaris. Applications and toolkits supporting the AT-SPI include the
GNOME Gtk+ toolkit, the Java platform's Swing toolkit, LibreOffice,
Gecko, and WebKitGtk. AT-SPI support for the KDE Qt toolkit is being
pursued.
.SH OPTIONS
.TP
.B \-s, --setup
When starting
.BR cthulhu ,
initiate the GUI-based configuration.
.TP
.BI "\-u, --user-prefs-dir=" dirname
When starting
.BR cthulhu ,
use
.I dirname
as an alternate directory for the user preferences.
.TP
.BI "\-e, \-\-enable=" speech|braille|braille\-monitor
When starting
.BR cthulhu ,
force the enabling of the supplied options.
.TP
.BI "\-d, \-\-disable=" speech|braille|braille\-monitor
When starting
.BR cthulhu ,
force the disabling of the supplied options.
.TP
.B \-l, --list-apps
Prints the names of all the currently running applications. This
is used primarily for debugging purposes to see if
.B cthulhu
can talk to the accessibility infrastructure. Note that if
.B cthulhu
is already running, this will not kill the other
.B cthulhu
process. It will just list the currently running applications,
and you will see
.B cthulhu
listed twice: once for the existing
.B cthulhu
and once for this instance.
.TP
.B \--debug
Enables debug output for
.B cthulhu
and sends 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=" filename
Enables debug output for
.B cthulhu
and sends all debug output to the given filename.
.TP
.B \-v, --version
outputs
.B cthulhu
version number and exits.
.TP
.B \-h, \--help
displays
.B cthulhu
help and exits.
.TP
.B \--replace
Replace a currently running
.BR cthulhu
process. By default, if
.BR cthulhu
detects an existing
.BR cthulhu
process for the same session, it will not start a new
.BR cthulhu
process. This option will kill and cleanup after any existing
.BR cthulhu
process and then start a new
.BR cthulhu
in its place.
.TP
.SH KEYBOARD SETTINGS
Cthulhu provides two keyboard modes, Desktop and Laptop keyboard layout. The
.B Cthulhu_Modifier
key is
.B Insert
in desktop keyboard layout and
.B Caps_Lock
in laptop keyboard layout.
.B Cthulhu
uses default GNOME keyboard shortcuts to navigate the desktop and interact with various applications. The flat review commands provide an alternative method of interaction in certain inaccessible applications. It should not be confused with flat review functionality provided by other screen readers.
.SH Desktop Mode
.B Flat review commands
.B "Numpad-7"
move the flat review cursor to the previous line and read it.
.B "Numpad-8"
read the current line.
.B "Numpad-9"
move the flat review cursor to the next line and read it.
.B "Numpad-4"
move the flat review cursor to the previous word and read it.
.B "Numpad-5"
read the current word.
.B "Numpad-6"
move the flat review cursor to the next word and read it.
.B "Numpad-1"
move the flat review cursor to the previous character and read it.
.B "Numpad-2"
read the current character.
.B "Numpad-3"
move the flat review cursor to the next character and read it.
.B "Numpad-slash"
perform a left mouse click at the location of the flat review cursor.
.B "Numpad-star"
perform a right mouse click at the location of the flat review cursor.
.B Bookmark commands
.B "Alt+Insert+[1-6]"
assign a bookmark to a numbered slot. If a bookmark already exists in the slot it will be replaced with the new one.
.B "Insert+[1-6]"
go to the position pointed to by the bookmark bound to this numbered slot.
.B "Insert+B and Insert+Shift+B"
move between the given bookmarks for the given application or page.
.B "Alt+Insert+B"
save the defined bookmarks for the current application or page.
.B Miscellaneous functions
.B "Numpad+Plus"
'say all' command; reads from the current position of the caret to the end of the document.
.B "Numpad+Enter"
'Where am I' command; speaks information such as the title of the current application window, as well as the name of the control that currently has focus.
.B "Insert+H"
enter into cthulhu's 'learn mode'; press Escape to exit.
.B "Insert+Shift+Backslash"
toggle live regions monitoring on and off.
.B "Insert+F"
speak font and attribute information for the current character.
.B "Insert+Space"
Launch the cthulhu Configuration dialog.
.B "Insert+Ctrl+Space"
reload user settings and reinitialize services as necessary. Also launches the cthulhu Configuration dialog for the current application.
.B "Insert+S"
toggle speech on and off.
.B "Insert+F11"
toggle the reading of tables, either by single cell or whole row.
.SH Laptop Mode
.B Flat review commands
.B "Caps_Lock+U"
move the flat review cursor to the previous line and read it. Double-click to move flat review to the top of the current window.
.B "Caps_Lock+I"
read the current line. Double-click to read the current line along with formatting and capitalization details.
.B "Caps_Lock+O"
move the flat review cursor to the next line and read it. Double- click to move flat review to the bottom of the current window.
.B "Caps_Lock+J"
move the flat review cursor to the previous word and read it. Double-click to move flat review to the word above the current word.
.B "Caps_Lock+K"
read the current word. Double-click to spell the word. Triple-click to hear the word spelled phonetically.
.B "Caps_Lock+L"
move the flat review cursor to the next word and read it. Double- click to move flat review to the word below the current word.
.B "Caps_Lock+M"
move the flat review cursor to the previous character and read it. Double-click to move flat review to the end of the current line.
.B "Caps_Lock+Comma"
read the current character. Double-click to pronounce the character phonetically if it is a letter.
.B "Caps_Lock+Period"
move the flat review cursor to the next character and read it.
.B "Caps_Lock+7"
perform a left mouse click at the location of the flat review cursor.
.B "Caps_Lock+8"
perform a right mouse click at the location of the flat review cursor.
.B Bookmark commands
.B "Alt+Caps_Lock+[1-6]"
add a bookmark to the numbered slot. If a bookmark already exists for the slot it will be replaced with the new one.
.B "Caps_Lock+[1-6]"
go to the position pointed to by the bookmark bound to this numbered slot.
.B "Caps_Lock+Band Caps_Lock+Shift+B"
move between the given bookmarks for the given application or page.
.B "Alt+Caps_Lock+B"
save the defined bookmarks for the current application or page.
.B Miscellaneous functions
.B "Caps_Lock+Semicolon"
'Say all' command; reads from the current position of the caret to the end of the document.
.B "Caps_Lock+Enter"
'Where am I' command; speaks information such as the title of the current application window, as well as the name of the control that currently has focus.
.B "Caps_Lock+H"
enter learn mode (press Escape to exit).
.B "Caps_Lock+Shift+Backslash"
toggle live regions monitoring on and off.
.B "Caps_Lock+F"
speak font and attribute information for the current character.
.B "Caps_Lock+Space"
launch the cthulhu Configuration dialog.
.B "Caps_Lock+Ctrl+Space"
reload user settings and reinitialize services as necessary; also launches the cthulhu Configuration dialog for the current application.
.B "Caps_Lock+S"
toggle speech on and off.
.B "Caps_Lock+F11"
toggle the reading of tables, either by single cell or whole row.
.SH FILES
.TP
.BI ~/.local/share/cthulhu
.B Cthulhu
user preferences directory
.TP
.BI ~/.local/share/cthulhu/user-settings.conf
.B Cthulhu
user preferences configuration file.
.TP
.BI ~/.local/share/cthulhu/cthulhu-customizations.py
.B Cthulhu
user customizations configuration file
.TP
.BI ~/.local/share/cthulhu/cthulhu-scripts
.B Cthulhu
user cthulhu scripts directory
.TP
.BI ~/.local/share/cthulhu/bookmarks
.B Cthulhu
user bookmarks directory
.TP
.BI ~/.local/share/cthulhu/app-settings
.B Cthulhu
user application specific settings directory
.SH AUTHOR
.B Cthulhu
originated as a community effort led by the Sun Microsystems Inc.
Accessibility Program Office and with contributions from many community members.
.SH SEE ALSO
For more information please visit
.B cthulhu
wiki at
.UR http://live.gnome.org/Cthulhu
<http://live.gnome.org/Cthulhu>
.UE
.P
The
.B cthulhu
mailing list
.UR http://mail.gnome.org/mailman/listinfo/cthulhu-list
<http://mail.gnome.org/mailman/listinfo/cthulhu-list>
To post a message to all
.B cthulhu
list, send a email to cthulhu-list@gnome.org
+9
View File
@@ -0,0 +1,9 @@
module git.stormux.org/storm/cthulhu
go 1.24.0
require github.com/pelletier/go-toml/v2 v2.4.3
require github.com/godbus/dbus/v5 v5.1.0
require github.com/gorilla/websocket v1.5.3
+6
View File
@@ -0,0 +1,6 @@
github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk=
github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/pelletier/go-toml/v2 v2.4.3 h1:GTRvJQutkOSftxIFD5xw9aepkYNuPWmVJpffdDPYVpY=
github.com/pelletier/go-toml/v2 v2.4.3/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
-34
View File
@@ -1,34 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="guide" id="commands">
<info>
<link type="next" xref="commands_controlling_cthulhu" />
<link type="guide" xref="index#quick_reference" />
<title type="sort">4. <app>Cthulhu</app>'s Commands</title>
<title type="link">Commands</title>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title><app>Cthulhu</app>'s Commands</title>
<section id="getting_started" style="2column">
<title>Getting Started</title>
</section>
<section id="speech_braille" style="2column">
<title>Speech and Braille</title>
</section>
<section id="reading_documents" style="2column">
<title>Reading Web Pages and Other Documents</title>
</section>
<section id="reviewing_screen_contents" style="2column">
<title>Reviewing and Interacting with Screen Contents</title>
</section>
<section id="accessing_dynamic_information" style="2column">
<title>Accessing Dynamic Information</title>
</section>
<section id="troubleshooting">
<title>Troubleshooting</title>
</section>
</page>
-57
View File
@@ -1,57 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_bookmarks">
<info>
<link type="next" xref="commands_live_regions" />
<link type="guide" xref="commands#reviewing_screen_contents" />
<link type="seealso" xref="howto_bookmarks" />
<title type="sort">4. Bookmarks</title>
<title type="link">Bookmarks</title>
<desc>
Commands to bookmark and retrieve objects
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Bookmark Commands</title>
<p>
<app>Cthulhu</app> provides several commands which can be used to "bookmark"
a given object for the purpose of navigating back to it later.
</p>
<list>
<item>
<p>
Save a bookmark to the numbered slot: <keyseq><key>Cthulhu Modifier</key>
<key>Alt</key><key>1</key></keyseq>-<key>6</key>
</p>
</item>
<item>
<p>
Save the defined bookmarks for the application or page:
<keyseq><key>Cthulhu Modifier</key><key>Alt</key><key>B</key></keyseq>
</p>
</item>
<item>
<p>
Go to a specific, numbered bookmark: <keyseq><key>Cthulhu Modifier</key>
<key>1</key></keyseq>-<key>6</key>
</p>
</item>
<item>
<p>
Go to the previous bookmark for the application or page:
<keyseq><key>Cthulhu Modifier</key><key>Shift</key><key>B</key>
</keyseq>
</p>
</item>
<item>
<p>
Go to the next bookmark for the application or page:
<keyseq><key>Cthulhu Modifier</key><key>B</key></keyseq>
</p>
</item>
</list>
</page>
-40
View File
@@ -1,40 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_braille">
<info>
<link type="next" xref="commands_reading" />
<link type="guide" xref="commands#speech_braille" />
<link type="seealso" xref="preferences_braille" />
<title type="sort">2. Braille</title>
<title type="link">Braille</title>
<desc>
Commands executable on braille displays
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Braille Commands</title>
<p>
The following commands allow you to control <app>Cthulhu</app> from your
refreshable braille display rather than your keyboard:
</p>
<list>
<item><p>Pan braille display to the left: Line Left</p></item>
<item><p>Pan braille display to the right: Line Right</p></item>
<item><p>Toggle flat review mode: Freeze</p></item>
<item><p>Review the word above: Line Up</p></item>
<item><p>Review the word below: Line Down</p></item>
<item><p>Review bottom left: Bottom Right</p></item>
<item><p>Review the home position: Top Left</p></item>
<item><p>Contracted braille: Six Dots</p></item>
<item><p>Marks the beginning of a text selection: Cut Begin</p></item>
<item><p>Marks the end of a text selection: Cut Line</p></item>
<item><p>Processes a cursor routing key: Cursor Routing</p></item>
<item><p>Returns to object with keyboard focus: Cursor Position</p></item>
</list>
</page>
-52
View File
@@ -1,52 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_chat">
<info>
<link type="next" xref="commands_debugging" />
<link type="guide" xref="commands#accessing_dynamic_information" />
<link type="seealso" xref="preferences_chat" />
<title type="sort">2. Chat</title>
<title type="link">Chat</title>
<desc>
Commands for use with IM and IRC clients
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Chat Commands</title>
<p>
The following commands can be used to access information in the
instant messaging and internet relay chat clients supported by
<app>Cthulhu</app>. You will notice that several of these commands
are "unbound." Please see <link xref="howto_key_bindings">Modifying
Keybindings</link> for information on how to bind these commands to
keystrokes.
</p>
<list>
<item>
<p>
Present previous chat room messages:
<keyseq><key>Cthulhu Modifier</key><key>F1</key></keyseq> through <key>F9</key>
</p>
</item>
<item>
<p>
Enable/disable announcement of room name with messages: (Unbound)
</p>
</item>
<item>
<p>Enable/disable announcement of buddy typing status: (Unbound)</p>
</item>
<item>
<p>Enable/disable room-specific histories: (Unbound)</p>
</item>
</list>
</page>
-86
View File
@@ -1,86 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_controlling_cthulhu">
<info>
<link type="next" xref="commands_where_am_i" />
<link type="guide" xref="commands#getting_started" />
<title type="sort">1. Controlling and Learning to Use Cthulhu</title>
<title type="link">Controlling and Learning to Use Cthulhu</title>
<desc>
Commands for interacting with <app>Cthulhu</app>
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Controlling and Learning to Use Cthulhu</title>
<section id="controlling">
<title>Commands for Controlling <app>Cthulhu</app></title>
<p>
The following commands can be used to get into <app>Cthulhu</app>'s
Preferences dialogs, toggle <app>Cthulhu</app> on and off, and bypass
<app>Cthulhu</app> commands to avoid shortcut conflicts within the
application being accessed.
</p>
<list>
<item>
<p>
Toggle <app>Cthulhu</app> on and off in GNOME:
<keyseq><key>Super</key><key>Alt</key><key>S</key></keyseq>.
</p>
<note style="tip">
<p>
If you are using <app>Cthulhu</app> in another desktop environment in which
there is no command to toggle <app>Cthulhu</app> on and off, you may find the
command to quit <app>Cthulhu</app> helpful. This command is unbound by default.
Please see <link xref="howto_key_bindings">Modifying Keybindings</link> for
information on how to bind unbound commands.
</p>
</note>
</item>
<item>
<p>
<link xref="preferences">Cthulhu Preferences</link> dialog:
<keyseq><key>Cthulhu Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>
Cthulhu's Preferences dialog for the focused application:
<keyseq><key>Ctrl</key><key>Cthulhu Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>
Pass the next command on to the current application:
<keyseq><key>Cthulhu Modifier</key><key>BackSpace</key></keyseq>
</p>
</item>
</list>
</section>
<section id="learning">
<title>Commands for Learning to Use <app>Cthulhu</app></title>
<p>
In Learn Mode, <app>Cthulhu</app> will announce each keystroke you pressed
along with any associated <app>Cthulhu</app> command that keystroke is bound
to. In this mode, you can also get a list of shortcuts containing all the
<app>Cthulhu</app> commands you can use.
</p>
<list>
<item>
<p>
Enter Learn Mode:
<keyseq><key>Cthulhu Modifier</key><key>H</key></keyseq>
</p>
</item>
<item>
<p>
Exit Learn Mode:
<keyseq><key>Esc</key></keyseq>
</p>
</item>
</list>
</section>
</page>
-29
View File
@@ -1,29 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_debugging">
<info>
<link type="guide" xref="commands#troubleshooting" />
<title type="sort">1. Debugging</title>
<title type="link">Debugging</title>
<desc>
Commands for troubleshooting
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Debugging Commands</title>
<p>
You may be asked by the developers to provide some debugging information in
order to help them identify the source of a problem you are experiencing.
The following command is not "bound" to a keystroke. If you need to bind it,
please see <link xref="howto_key_bindings">Modifying Keybindings</link>.
</p>
<list>
<item>
<p>Cycle to the next debug level: (Unbound)</p>
</item>
</list>
</page>
-76
View File
@@ -1,76 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_find">
<info>
<link type="next" xref="commands_mouse" />
<link type="guide" xref="commands#reviewing_screen_contents" />
<link type="seealso" xref="howto_cthulhu_find" />
<title type="sort">2. Cthulhu Find</title>
<title type="link">Cthulhu Find</title>
<desc>
Commands for searching window contents
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Cthulhu Find Commands</title>
<p>
<app>Cthulhu</app>'s <link xref="howto_cthulhu_find">Find feature</link> allows
you to search the <link xref="howto_flat_review">Flat Review</link> context
for elements located within the current window.
</p>
<list>
<item>
<p>Open the <app>Cthulhu</app> Find dialog:</p>
<list>
<item>
<p>Desktop: <keyseq><key>KP Delete</key></keyseq></p>
</item>
<item>
<p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Left Bracket</key></keyseq></p>
</item>
</list>
</item>
<item>
<p>Move flat review to the next instance of a string:</p>
<list>
<item>
<p>
Desktop:
<keyseq><key>Cthulhu Modifier</key><key>KP Delete</key></keyseq>
</p>
</item>
<item>
<p>
Laptop:
<keyseq><key>Cthulhu Modifier</key><key>Right Bracket</key></keyseq>
</p>
</item>
</list>
</item>
<item>
<p>Move flat review to the previous instance of a string:</p>
<list>
<item>
<p>
Desktop:
<keyseq>
<key>Cthulhu Modifier</key><key>Shift</key><key>KP Delete</key>
</keyseq>
</p>
</item>
<item>
<p>
Laptop:
<keyseq>
<key>Cthulhu Modifier</key><key>Ctrl</key><key>Right Bracket</key>
</keyseq>
</p>
</item>
</list>
</item>
</list>
</page>
-199
View File
@@ -1,199 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_flat_review">
<info>
<link type="next" xref="commands_find" />
<link type="guide" xref="commands#reviewing_screen_contents" />
<link type="seealso" xref="howto_flat_review" />
<title type="sort">1. Flat Review</title>
<title type="link">Flat Review</title>
<desc>
Commands for spatially reviewing windows
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Flat Review Commands</title>
<p>
Cthulhu's <link xref="howto_flat_review">Flat Review</link> commands are
designed for spatially reviewing elements displayed on the screen. They
also provide a means for reading the current line, word, and character
when navigating in the text of a document. Most of these commands are
"bound" to keystrokes. Please see <link xref="howto_key_bindings">Modifying
Keybindings</link> for information on how to bind unbound commands.
</p>
<section id="line">
<title>Commands for Reviewing by Line</title>
<list>
<item>
<p>First line (The "home" position):</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP 7</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Ctrl</key><key>U</key></keyseq></p></item>
</list>
</item>
<item>
<p>Previous line:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 7</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>U</key></keyseq></p></item>
</list>
</item>
<item>
<p>Current line:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 8</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>I</key></keyseq></p></item>
</list>
</item>
<item><p>Spell current line:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 8</key></keyseq> (double-clicked)</p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>I</key></keyseq> (double-clicked)</p></item>
</list>
</item>
<item><p>Phonetically spell current line:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 8</key></keyseq> (triple-clicked)</p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>I</key></keyseq> (triple-clicked)</p></item>
</list>
</item>
<item><p>Next line:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 9</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>O</key></keyseq></p></item>
</list>
</item>
<item><p>Last line (The "end" position):</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP 9</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Ctrl</key><key>O</key></keyseq></p></item>
</list>
</item>
</list>
</section>
<section id="word">
<title>Commands for Reviewing by Word</title>
<list>
<item><p>Word above:</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP 4</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Ctrl</key><key>J</key></keyseq></p></item>
</list>
</item>
<item><p>Previous word:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 4</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>J</key></keyseq></p></item>
</list>
</item>
<item><p>Current word:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 5</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>K</key></keyseq></p></item>
</list>
</item>
<item><p>Spell current word:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 5</key></keyseq> (double-clicked)</p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>K</key></keyseq> (double-clicked)</p></item>
</list>
</item>
<item><p>Phonetically spell current word:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 5</key></keyseq> (triple-clicked)</p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>K</key></keyseq> (triple-clicked)</p></item>
</list>
</item>
<item><p>Next word:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 6</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>L</key></keyseq></p></item>
</list>
</item>
<item><p>Word below:</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP 6</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Ctrl</key><key>L</key></keyseq></p></item>
</list>
</item>
</list>
</section>
<section id="character">
<title>Commands for Reviewing by Character</title>
<list>
<item><p>Previous character:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 1</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>M</key></keyseq></p></item>
</list>
</item>
<item><p>Current character:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 2</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Comma</key></keyseq></p></item>
</list>
</item>
<item><p>Phonetically speak current character:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 2</key></keyseq> (double-clicked)</p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Comma</key></keyseq> (double-clicked)</p></item>
</list>
</item>
<item><p>Speak Unicode value of current character:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 2</key></keyseq> (triple-clicked)</p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Comma</key></keyseq> (triple-clicked)</p></item>
</list>
</item>
<item><p>Next character:</p>
<list>
<item><p>Desktop: <keyseq><key>KP 3</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Period</key></keyseq></p></item>
</list>
</item>
<item><p>Last character on current line:</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP 1</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Ctrl</key><key>M</key></keyseq></p></item>
</list>
</item>
</list>
</section>
<section id="other">
<title>Additional Commands</title>
<list>
<item><p>Toggle flat review (refreshes the flat review context):</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP Subtract</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>P</key></keyseq></p></item>
</list>
</item>
<item><p>Review current item/widget:</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP 5</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Ctrl</key><key>K</key></keyseq></p></item>
</list>
</item>
<item><p>Use Say All to review the current dialog or window:</p>
<list>
<item><p>Desktop: <key>KP Plus</key> (double-clicked)</p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Semicolon</key></keyseq> (double-clicked)</p></item>
</list>
</item>
<item>
<p>
Copy the contents under flat review to the clipboard: (Unbound)
</p>
</item>
<item>
<p>
Append the contents under flat review to the clipboard: (Unbound)
</p>
</item>
</list>
</section>
</page>
-62
View File
@@ -1,62 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_live_regions">
<info>
<link type="next" xref="commands_chat" />
<link type="guide" xref="commands#accessing_dynamic_information" />
<link type="seealso" xref="howto_live_regions" />
<title type="sort">1. Live Regions</title>
<title type="link">Live Regions</title>
<desc>
Commands for accessing web live regions
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0
</p>
</license>
</info>
<title>Live Region Commands</title>
<p>
The following commands can be used to access dynamically-updated
content on web pages which have been made accessible through ARIA.
</p>
<list>
<item>
<p>
Monitor live regions:
<keyseq><key>Cthulhu Modifier</key><key>Shift</key><key>Backslash</key></keyseq>
</p>
</item>
<item>
<p>
Advance live region politeness setting: <key>Backslash</key>
</p>
</item>
<item>
<p>
Set default politeness level to off:
<keyseq><key>Shift</key><key>Backslash</key></keyseq>
</p>
</item>
<item>
<p>
Go to next/previous live region:
<keyseq><key>D</key></keyseq>/<keyseq><key>Shift</key><key>D</key></keyseq>
</p>
</item>
<item>
<p>
Go to last live region which made an announcement:
<keyseq><key>Y</key></keyseq>
</p>
</item>
<item>
<p>
Review live region announcements:
<keyseq><key>Cthulhu Modifier</key><key>F1</key></keyseq> through <key>F9</key>
</p>
</item>
</list>
</page>
-72
View File
@@ -1,72 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_mouse">
<info>
<link type="next" xref="commands_bookmarks" />
<link type="guide" xref="commands#reviewing_screen_contents" />
<title type="sort">3. Mouse/Pointer-Related</title>
<title type="link">Mouse/Pointer-Related</title>
<link type="seealso" xref="howto_flat_review" />
<link type="seealso" xref="howto_mouse_review" />
<desc>
Commands for manipulating the pointer
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Mouse/Pointer-Related Commands</title>
<p>
<app>Cthulhu</app> provides several commands which can be used to manipulate
the mouse pointer and read the contents under it. All of the commands are
"bound" to keystrokes with one exception: Toggling Mouse Review Mode.
Please see <link xref="howto_key_bindings">Modifying Keybindings</link>
for information on how to bind this command to a keystroke.
</p>
<note style="tip">
<p>
Below you will see several references to "KP". All
"KP" keys are located on the numeric keypad. You will also notice that
there are different keystrokes depending upon whether you are using a
desktop or a laptop -- or more accurately, whether you are using
<app>Cthulhu</app>'s Desktop keyboard layout or its Laptop keyboard layout.
For additional information, please see the
<link xref="howto_keyboard_layout">Keyboard Layout</link> topic.
</p>
</note>
<list>
<item>
<p>Left-click on current item:</p>
<list>
<item><p>Desktop: <keyseq><key>KP Divide</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>7</key></keyseq></p></item>
</list>
</item>
<item>
<p>Right-click on current item:</p>
<list>
<item><p>Desktop: <keyseq><key>KP Multiply</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>8</key></keyseq></p></item>
</list>
</item>
<item>
<p>Route pointer to current item:</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP Divide</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>9</key></keyseq></p></item>
</list>
</item>
<item>
<p>Move focus into or away from the current mouse over (web only):</p>
<list>
<item><p>Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP Multiply</key></keyseq></p></item>
<item><p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>0</key></keyseq></p></item>
</list>
</item>
<item>
<p>Enable/disable mouse review mode: (Unbound)</p>
</item>
</list>
</page>
-35
View File
@@ -1,35 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_profiles">
<info>
<link type="next" xref="commands_speech_settings" />
<link type="guide" xref="commands#getting_started" />
<link type="seealso" xref="howto_profiles" />
<title type="sort">5. Profiles</title>
<title type="link">Profiles</title>
<desc>
Commands to access saved configurations
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Profile Commands</title>
<p>
Profiles allow you to save and load multiple configurations so that you
can quickly access the settings you need.
</p>
<p>
The following command is not "bound" to a keystroke. If you would like to
bind it, please see <link xref="howto_key_bindings">Modifying Keybindings</link>.
</p>
<list>
<item>
<p>
Cycle to the next profile: (Unbound)
</p>
</item>
</list>
</page>
-294
View File
@@ -1,294 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_reading">
<info>
<link type="next" xref="commands_structural_navigation" />
<link type="guide" xref="commands#reading_documents" />
<link type="seealso" xref="howto_documents" />
<link type="seealso" xref="howto_text_attributes" />
<link type="seealso" xref="howto_whereami" />
<title type="sort">1. Reading</title>
<title type="link">Reading</title>
<desc>
Commands for accessing document content
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Reading Commands</title>
<p>
In addition to the caret navigation commands which are part of GNOME,
<app>Cthulhu</app> provides a number of commands which you can use to read a
document.
</p>
<note style="tip">
<p>
Below you will see several references to "KP". All
"KP" keys are located on the numeric keypad. You will also notice that
there are different keystrokes depending upon whether you are using a
desktop or a laptop -- or more accurately, whether you are using
<app>Cthulhu</app>'s Desktop keyboard layout or its Laptop keyboard layout.
For additional information, please see the
<link xref="howto_keyboard_layout">Keyboard Layout</link> topic.
</p>
</note>
<section id="flat_review">
<title>Reading Your Current Location</title>
<p>
The following <app>Cthulhu</app> <link xref="commands_flat_review">Flat
Review Commands</link> can be used to read your current location:
</p>
<list>
<item>
<p>Read the current line:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>KP 8</key></keyseq>
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>I</key></keyseq>
</p>
</item>
</list>
</item>
<item>
<p>Read the current word:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>KP 5</key></keyseq>
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>K</key></keyseq>
</p>
</item>
</list>
</item>
<item>
<p>Spell the current word:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>KP 5</key></keyseq> (double-clicked)
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>K</key></keyseq>
(double-clicked)
</p>
</item>
</list>
</item>
<item>
<p>Phonetically spell the current word:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>KP 5</key></keyseq> (triple-clicked)
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>K</key></keyseq>
(triple-clicked)
</p>
</item>
</list>
</item>
<item>
<p>Read the current character:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>KP 2</key></keyseq>
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Comma</key></keyseq>
</p>
</item>
</list>
</item>
<item>
<p>Phonetically speak the current character:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>KP 2</key></keyseq> (double-clicked)
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Comma</key></keyseq>
(double-clicked)
</p>
</item>
</list>
</item>
<item>
<p>Speak the Unicode value of current character:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>KP 2</key></keyseq> (triple-clicked)
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Comma</key></keyseq>
(triple-clicked)
</p>
</item>
</list>
</item>
</list>
</section>
<section id="say_all">
<title>Say All</title>
<p>
Cthulhu's Say All command will cause <app>Cthulhu</app> to speak the
entire document beginning from your current location.
</p>
<list>
<item>
<p>Desktop: <key>KP Plus</key></p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Semicolon</key></keyseq>
</p>
</item>
</list>
</section>
<section id="attributes_and_selection">
<title>Text Attributes and Selected Text</title>
<p>
<app>Cthulhu</app> has a dedicated command for obtaining the attributes of the
text at the caret location. In addition, if you use <app>Cthulhu</app>'s
Where Am I commands from within a text object in which text has been
selected, <app>Cthulhu</app> will announce the selected text. <app>Cthulhu</app>'s
command to speak the current selection will also perform this function in a
text object.
</p>
<list>
<item>
<p>
Present the text attributes:
<keyseq><key>Cthulhu Modifier</key><key>F</key></keyseq>
</p>
</item>
<item>
<p>Perform basic Where Am I:</p>
<list>
<item>
<p>
Desktop: <key>KP Enter</key>
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Return</key></keyseq>
</p>
</item>
</list>
</item>
<item>
<p>Perform detailed Where Am I:</p>
<list>
<item>
<p>
Desktop: <key>KP Enter</key> (double-clicked)
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Return</key></keyseq>
(double-clicked)
</p>
</item>
</list>
</item>
<item>
<p>
Speak current selection:
<keyseq><key>Cthulhu Modifier</key><key>Shift</key><key>Up</key></keyseq>
</p>
</item>
</list>
</section>
<section id="link_details">
<title>Link Details</title>
<p>
If you are on a link, <app>Cthulhu</app>'s Basic Where Am I command can be
used to announce the details associated with the link such as the link type,
if the link is visited, the site description, and file size. If you would
instead prefer a dedicated command for this purpose, you can bind <app>Cthulhu</app>'s
Speak Link Details command to a keystroke. Please see <link xref="howto_key_bindings">
Modifying Keybindings</link> for information on how to do so.
</p>
<list>
<item>
<p>Speak the link details: (Unbound)</p>
</item>
</list>
</section>
<section id="browse_and_focus_modes">
<title>Browse and Focus Modes</title>
<p>
<app>Cthulhu</app>'s Browse and Focus modes let you switch between reading and
interacting with web content.
</p>
<list>
<item>
<p>
Switch between browse mode and focus mode:
<keyseq><key>Cthulhu Modifier</key><key>A</key></keyseq>
</p>
</item>
<item>
<p>
Enable sticky focus mode:
<keyseq><key>Cthulhu Modifier</key><key>A</key></keyseq> (double-clicked)
</p>
</item>
<item>
<p>
Enable sticky browse mode:
<keyseq><key>Cthulhu Modifier</key><key>A</key></keyseq> (triple-clicked)
</p>
</item>
</list>
</section>
<section id="toggling_layout_mode">
<title>Toggling Layout Mode</title>
<p>
When Layout mode is enabled, <app>Cthulhu</app>'s caret navigation will respect
the on-screen layout of the content and present the full line, including any
links or form fields on that line. When Layout mode is disabled, <app>Cthulhu</app>
will treat objects such as links and form fields as if they were on separate
lines, both for presentation and navigation.
</p>
<p>
<app>Cthulhu</app> provides a command to switch between Layout mode and Object mode.
This command is unbound by default. Please see <link xref="howto_key_bindings">Modifying
Keybindings</link> for information on how to bind unbound commands.
</p>
<list>
<item>
<p>
Switch between Layout mode and Object mode: (Unbound)
</p>
</item>
</list>
</section>
</page>
-83
View File
@@ -1,83 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_speech_settings">
<info>
<link type="next" xref="commands_braille" />
<link type="guide" xref="commands#speech_braille" />
<link type="seealso" xref="preferences_speech" />
<title type="sort">2. Speech Settings</title>
<title type="link">Speech</title>
<desc>
Commands for customizing <app>Cthulhu</app>'s output
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Speech Settings Commands</title>
<p>
The following commands can be used to customize <app>Cthulhu</app>'s
speech output. You will notice that a number of these commands are
"unbound." Please see <link xref="howto_key_bindings">Modifying
Keybindings</link> for information on how to bind these commands
to keystrokes.
</p>
<list>
<item>
<p>
Enable/disable speech: <keyseq><key>Cthulhu Modifier</key><key>S</key></keyseq>
</p>
</item>
<item>
<p>
Toggle between cell and row reading in a table:
<keyseq><key>Cthulhu Modifier</key><key>F11</key></keyseq>
</p>
</item>
<item>
<p>
Toggle between verbose and brief verbosity levels:
<keyseq><key>Cthulhu Modifier</key><key>V</key></keyseq>
</p>
</item>
<item>
<p>
Enable/disable speaking of indentation and justification: (Unbound)
</p>
</item>
<item>
<p>Change the spoken number style: (Unbound)</p>
</item>
<item>
<p>Cycle to the next spoken punctuation level: (Unbound)</p>
</item>
<item>
<p>Cycle to the next key echo level: (Unbound)</p>
</item>
<item>
<p>Cycle to the next capitalization style: (Unbound)</p>
</item>
<item>
<p>Decrease the rate: (Unbound)</p>
</item>
<item>
<p>Increase the rate: (Unbound)</p>
</item>
<item>
<p>Decrease the pitch: (Unbound)</p>
</item>
<item>
<p>Increase the pitch: (Unbound)</p>
</item>
<item>
<p>Decrease the volume: (Unbound)</p>
</item>
<item>
<p>Increase the volume: (Unbound)</p>
</item>
</list>
</page>
-443
View File
@@ -1,443 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_structural_navigation">
<info>
<link type="next" xref="commands_table" />
<link type="guide" xref="commands#reading_documents" />
<link type="seealso" xref="howto_forms" />
<title type="sort">2. Structural Navigation</title>
<title type="link">Structural Navigation</title>
<desc>
Commands for navigating by elements
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Structural Navigation Commands</title>
<p>
The following commands can be used to navigate by headings, links,
and other elements found in applications for which <app>Cthulhu</app>
provides structural navigation support.
</p>
<list>
<item>
<p>
Enable/disable Structural Navigation keys:
<keyseq><key>Cthulhu Modifier</key><key>Z</key></keyseq>
</p>
</item>
</list>
<section id="headings">
<title>Headings</title>
<list>
<item>
<p>
Next and previous heading:
<keyseq><key>H</key></keyseq> and
<keyseq><key>Shift</key><key>H</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of headings:
<keyseq><key>Alt</key><key>Shift</key><key>H</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous heading at level 1:
<keyseq><key>1</key></keyseq> and
<keyseq><key>Shift</key><key>1</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of headings at level 1:
<keyseq><key>Alt</key><key>Shift</key><key>1</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous heading at level 2:
<keyseq><key>2</key></keyseq> and
<keyseq><key>Shift</key><key>2</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of headings at level 2:
<keyseq><key>Alt</key><key>Shift</key><key>2</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous heading at level 3:
<keyseq><key>3</key></keyseq> and
<keyseq><key>Shift</key><key>3</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of headings at level 3:
<keyseq><key>Alt</key><key>Shift</key><key>3</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous heading at level 4:
<keyseq><key>4</key></keyseq> and
<keyseq><key>Shift</key><key>4</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of headings at level 4:
<keyseq><key>Alt</key><key>Shift</key><key>4</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous heading at level 5:
<keyseq><key>5</key></keyseq> and
<keyseq><key>Shift</key><key>5</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of headings at level 5:
<keyseq><key>Alt</key><key>Shift</key><key>5</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous heading at level 6:
<keyseq><key>6</key></keyseq> and
<keyseq><key>Shift</key><key>6</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of headings at level 6:
<keyseq><key>Alt</key><key>Shift</key><key>6</key></keyseq>
</p>
</item>
</list>
</section>
<section id="forms">
<title>Forms</title>
<list>
<item>
<p>
Next and previous form field:
<keyseq><key>F</key></keyseq> and
<keyseq><key>Shift</key><key>F</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of form fields:
<keyseq><key>Alt</key><key>Shift</key><key>F</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous button:
<keyseq><key>B</key></keyseq> and
<keyseq><key>Shift</key><key>B</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of buttons:
<keyseq><key>Alt</key><key>Shift</key><key>B</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous combo box:
<keyseq><key>C</key></keyseq> and
<keyseq><key>Shift</key><key>C</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of combo boxes:
<keyseq><key>Alt</key><key>Shift</key><key>C</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous entry:
<keyseq><key>E</key></keyseq> and
<keyseq><key>Shift</key><key>E</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of entries:
<keyseq><key>Alt</key><key>Shift</key><key>E</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous radio button:
<keyseq><key>R</key></keyseq> and
<keyseq><key>Shift</key><key>R</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of radio buttons:
<keyseq><key>Alt</key><key>Shift</key><key>R</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous checkbox:
<keyseq><key>X</key></keyseq> and
<keyseq><key>Shift</key><key>X</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of checkboxes:
<keyseq><key>Alt</key><key>Shift</key><key>X</key></keyseq>
</p>
</item>
</list>
</section>
<section id="links">
<title>Links</title>
<list>
<item>
<p>
Next and previous link:
<keyseq><key>K</key></keyseq> and
<keyseq><key>Shift</key><key>K</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of links:
<keyseq><key>Alt</key><key>Shift</key><key>K</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous unvisited link:
<keyseq><key>U</key></keyseq> and
<keyseq><key>Shift</key><key>U</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of unvisited links:
<keyseq><key>Alt</key><key>Shift</key><key>U</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous visited link:
<keyseq><key>V</key></keyseq> and
<keyseq><key>Shift</key><key>V</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of visited links:
<keyseq><key>Alt</key><key>Shift</key><key>V</key></keyseq>
</p>
</item>
</list>
</section>
<section id="lists">
<title>Lists</title>
<list>
<item>
<p>
Next and previous list:
<keyseq><key>L</key></keyseq> and
<keyseq><key>Shift</key><key>L</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of lists:
<keyseq><key>Alt</key><key>Shift</key><key>L</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous list item:
<keyseq><key>I</key></keyseq> and
<keyseq><key>Shift</key><key>I</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of list items:
<keyseq><key>Alt</key><key>Shift</key><key>I</key></keyseq>
</p>
</item>
</list>
</section>
<section id="tables">
<title>Tables</title>
<list>
<item>
<p>
Next and previous table:
<keyseq><key>T</key></keyseq> and
<keyseq><key>Shift</key><key>T</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of tables:
<keyseq><key>Alt</key><key>Shift</key><key>T</key></keyseq>
</p>
</item>
<item>
<p>
Cell on left:
<keyseq><key>Alt</key><key>Shift</key><key>Left</key></keyseq>
</p>
</item>
<item>
<p>
Cell on right:
<keyseq><key>Alt</key><key>Shift</key><key>Right</key></keyseq>
</p>
</item>
<item>
<p>
Cell above:
<keyseq><key>Alt</key><key>Shift</key><key>Up</key></keyseq>
</p>
</item>
<item>
<p>
Cell below:
<keyseq><key>Alt</key><key>Shift</key><key>Down</key></keyseq>
</p>
</item>
<item>
<p>
First cell in table:
<keyseq><key>Alt</key><key>Shift</key><key>Home</key></keyseq>
</p>
</item>
<item>
<p>
Last cell in table:
<keyseq><key>Alt</key><key>Shift</key><key>End</key></keyseq>
</p>
</item>
</list>
</section>
<section id="text_blocks">
<title>Text Blocks</title>
<list>
<item>
<p>
Next and previous paragraph:
<keyseq><key>P</key></keyseq> and
<keyseq><key>Shift</key><key>P</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of paragraphs:
<keyseq><key>Alt</key><key>Shift</key><key>P</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous blockquote:
<keyseq><key>Q</key></keyseq> and
<keyseq><key>Shift</key><key>Q</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of blockquotes:
<keyseq><key>Alt</key><key>Shift</key><key>Q</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous "large object":
<keyseq><key>O</key></keyseq> and
<keyseq><key>Shift</key><key>O</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of "large objects":
<keyseq><key>Alt</key><key>Shift</key><key>O</key></keyseq>
</p>
</item>
</list>
</section>
<section id="other">
<title>Other Elements</title>
<list>
<item>
<p>
Next and previous landmark:
<keyseq><key>M</key></keyseq> and
<keyseq><key>Shift</key><key>M</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of landmarks:
<keyseq><key>Alt</key><key>Shift</key><key>M</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous separator:
<keyseq><key>S</key></keyseq> and
<keyseq><key>Shift</key><key>S</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous "clickable":
<keyseq><key>A</key></keyseq> and
<keyseq><key>Shift</key><key>A</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of "clickables":
<keyseq><key>Alt</key><key>Shift</key><key>A</key></keyseq>
</p>
</item>
<item>
<p>
Next and previous image:
<keyseq><key>G</key></keyseq> and
<keyseq><key>Shift</key><key>G</key></keyseq>
</p>
</item>
<item>
<p>
Display a list of images:
<keyseq><key>Alt</key><key>Shift</key><key>G</key></keyseq>
</p>
</item>
<item>
<p>
Start and end of current container:
<keyseq><key>Shift</key><key>Comma</key></keyseq> and
<keyseq><key>Comma</key></keyseq>
</p>
</item>
</list>
</section>
</page>
-57
View File
@@ -1,57 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_table">
<info>
<link type="next" xref="commands_flat_review" />
<link type="guide" xref="commands#reading_documents" />
<link type="seealso" xref="howto_tables" />
<title type="sort">3. Table Navigation</title>
<title type="link">Table Navigation</title>
<desc>
Commands for accessing tabular information
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Table Navigation Commands</title>
<p>
Cthulhu's support for navigation by table cell is part of its
<link xref="commands_structural_navigation#tables">Structural Navigation
commands</link>. In addition you can:
</p>
<list>
<item>
<p>
Set dynamic row headers to current column:
<keyseq><key>Cthulhu Modifier</key><key>C</key></keyseq>
</p>
</item>
<item>
<p>
Set dynamic column headers to current row:
<keyseq><key>Cthulhu Modifier</key><key>R</key></keyseq>
</p>
</item>
<item>
<p>
Clear dynamic row headers:
<keyseq><key>Cthulhu Modifier</key><key>C</key></keyseq> (double-clicked)
</p>
</item>
<item>
<p>
Clear dynamic column headers:
<keyseq><key>Cthulhu Modifier</key><key>R</key></keyseq> (double-clicked)
</p>
</item>
<item>
<p>
Toggle between cell and row reading in a table:
<keyseq><key>Cthulhu Modifier</key><key>F11</key></keyseq>
</p>
</item>
</list>
</page>
@@ -1,63 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_time_date_notifications">
<info>
<link type="next" xref="commands_profiles" />
<link type="guide" xref="commands#getting_started" />
<link type="seealso" xref="howto_notifications" />
<title type="sort">4. Time, Date, and Notification</title>
<title type="link">Time, Date, and Notification</title>
<desc>
Commands for getting the time, date, and notification messages
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Time, Date, and Notification Commands</title>
<p>
The following commands can be used to obtain the current time and date
and to review previously-displayed notification messages:
</p>
<section id="time_and_date">
<title>Obtaining the Time and Date</title>
<list>
<item>
<p>
Present the time: <keyseq><key>Cthulhu Modifier</key><key>T</key></keyseq>
</p>
</item>
<item>
<p>
Present the date: <keyseq><key>Cthulhu Modifier</key><key>T</key></keyseq>
(double-clicked)
</p>
</item>
</list>
</section>
<section id="notifications">
<title>Reviewing Notification Messages</title>
<p>
Cthulhu has three unbound commands for accessing previously-displayed
<link xref="howto_notifications">notification messages</link>. Please
see <link xref="howto_key_bindings">Modifying Keybindings</link> for
information on how to bind these commands to keystrokes.
</p>
<list>
<item>
<p>Present the last (most recent) notification message: (Unbound)</p>
</item>
<item>
<p>Present the previous notification message: (Unbound)</p>
</item>
<item>
<p>Present the next notification message: (Unbound)</p>
</item>
<item>
<p>Present list of all notification messages: (Unbound)</p>
</item>
</list>
</section>
</page>
-97
View File
@@ -1,97 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="commands_where_am_i">
<info>
<link type="next" xref="commands_time_date_notifications" />
<link type="guide" xref="commands#getting_started" />
<link type="seealso" xref="howto_whereami" />
<title type="sort">3. Where Am I</title>
<title type="link">Where Am I</title>
<desc>
Commands to learn about your location
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Where Am I Commands</title>
<p>
<app>Cthulhu</app>'s Where Am I feature gives you context-sensitive details
about your present location. For instance, in tables, Where Am I will give
you details about the table cell you are in, but in text it will present
the current line along with any text which happens to be selected. The full
list of what you can expect <app>Cthulhu</app> to present can be found in the
<link xref="howto_whereami">Introduction to Where Am I</link>.
</p>
<p><app>Cthulhu</app> provides the following Where Am I commands:</p>
<list>
<item>
<p>Perform basic Where Am I:</p>
<list>
<item>
<p>Desktop: <key>KP Enter</key></p>
</item>
<item>
<p>Laptop: <keyseq><key>Cthulhu Modifier</key><key>Return</key></keyseq></p>
</item>
</list>
</item>
<item>
<p>Perform detailed Where Am I:</p>
<list>
<item>
<p>Desktop: <key>KP Enter</key> (double-clicked)</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Return</key></keyseq>
(double-clicked)
</p>
</item>
</list>
</item>
</list>
<p>
In addition to the dedicated Where Am I commands, <app>Cthulhu</app> has
additional commands related to obtaining information about your present location:
</p>
<list>
<item>
<p>Present the title bar:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP Enter</key></keyseq>
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Slash</key></keyseq>
</p>
</item>
</list>
</item>
<item>
<p>Present the status bar:</p>
<list>
<item>
<p>
Desktop: <keyseq><key>Cthulhu Modifier</key><key>KP Enter</key></keyseq>
(double-clicked)
</p>
</item>
<item>
<p>
Laptop: <keyseq><key>Cthulhu Modifier</key><key>Slash</key></keyseq>
(double-clicked)
</p>
</item>
<item>
<p>Present size and location of current object in pixels: (Unbound)</p>
</item>
</list>
</item>
</list>
</page>
Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 KiB

-54
View File
@@ -1,54 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_bookmarks">
<info>
<link type="guide" xref="index#reviewing"/>
<title type="sort">6. Bookmarks</title>
<desc>Storing and retrieving objects</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Bookmarks</title>
<p>
<app>Cthulhu</app>'s Bookmarks support allows you to indicate that an object
is of interest. It includes the following features:
</p>
<list>
<item>
<p>
You are not limited to a single object: You can set up to six bookmarks
per environment. You can also save bookmarks so that they will persist
from Cthulhu session to Cthulhu session.
</p>
</item>
<item>
<p>
Having set a bookmark you can navigate to it later, and do so regardless
of whether or not you have chosen to permanently save the bookmarks
associated with your current environment. Navigation can be based on the
number of the bookmark should you wish to jump directly to a specific
item. Alternatively, you can navigate to the next or previous bookmark
just like you can a <link xref="howto_structural_navigation">Structural
Navigation</link> object.
</p>
</item>
<item>
<p>
Bookmarkable objects can be widgets within an application or objects on
the web page you are reading. Which environment you are in determines
what happens as you navigate amongst bookmarks: If you are in web
content, the caret will be moved to the bookmark so that you can
continue reading; otherwise, <link xref="howto_flat_review">Flat
Review</link> will be activated with the bookmark becoming the current
review item.
</p>
</item>
</list>
<p>
The specific keybindings associated with each of the above tasks can be
found in <link xref="commands_bookmarks">Bookmark Commands</link>.
</p>
</page>
-112
View File
@@ -1,112 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_cthulhu_find">
<info>
<link type="guide" xref="index#reviewing"/>
<link type="next" xref="howto_mouse_review" />
<title type="sort">3. Cthulhu Find</title>
<desc>Searching a window for objects</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Cthulhu Find</title>
<p>
<app>Cthulhu</app>'s Find feature is a
<link xref="howto_flat_review">Flat-Review</link>-based search designed to
help you quickly locate objects that are visible on-screen within the
current window.
</p>
<note style="tip">
<title>Activating Cthulhu Find</title>
<p>
To open the Cthulhu <gui>Find</gui> dialog, use the following command based
on your chosen <link xref="howto_keyboard_layout">keyboard layout</link>:
</p>
<list>
<item>
<p>Desktop: <keyseq><key>KP Delete</key></keyseq></p>
</item>
<item>
<p>Laptop:
<keyseq><key>Cthulhu Modifier</key><key>Left Bracket</key></keyseq>
</p>
</item>
</list>
<p>
For a list of additional tasks you can perform, see the
<link xref="commands_find">Cthulhu Find commands</link>
</p>
</note>
<p>
When you activate Cthulhu Find, you will be placed in a dialog box.
</p>
<p>
Here you can specify the following items:
</p>
<list>
<item>
<p>The text to find</p>
</item>
<item>
<p>
The location from which to begin the search, which can either be
the current location or the top of the window
</p>
<p>
Default value of <gui>Start from</gui>: <gui>Current location</gui>
</p>
</item>
<item>
<p>
Whether or not capitalization should be taken into account when seeking
a match
</p>
<p>
Default value of <gui>Match case</gui>: not checked
</p>
</item>
<item>
<p>
Whether or not to limit matches to those which match the entire word
or phrase
</p>
<p>
Default value of <gui>Match entire word only</gui>: not checked
</p>
</item>
<item>
<p>
Whether Find should look down and/or to the right for the next
match or up and/or to the left.
</p>
<p>
Default value of <gui>Search backwards</gui>: not checked
</p>
</item>
<item>
<p>
Whether or not Find should wrap around to the top/bottom of the window
if there is no match found from the starting location in the direction
of the search.
</p>
<p>
Default value of <gui>Wrap around</gui>: checked
</p>
</item>
</list>
<p>
Having performed a search, you can quickly search for the next or previous
match without having to return to the Cthulhu Find dialog box.
</p>
<p>
Because it is a <link xref="howto_flat_review">Flat Review</link> feature,
when there is a match, Flat Review will automatically be activated and the
matching item or text will become the current review item. Note that focus
within the application will not be modified, nor will the caret be
repositioned. If you need to accomplish either, please see
<link xref="commands_mouse">Cthulhu's Mouse/Pointer-Related Commands</link>.
</p>
</page>
-67
View File
@@ -1,67 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_documents">
<info>
<link type="guide" xref="index#reading"/>
<link type="next" xref="howto_text_attributes" />
<title type="sort">1. Documents</title>
<desc>
Reading content
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Documents</title>
<p>
To read the contents of any document, use the application's built-in caret
navigation mode. As you navigate within the text of the document, <app>Cthulhu</app>
will present your new location. As a result, you are likely already familiar with
how to read a document using <app>Cthulhu</app>. For instance:
</p>
<list>
<item>
<p>
Use <key>Left</key> and <key>Right</key> to move and read by character.
</p>
</item>
<item>
<p>
Use <keyseq><key>Ctrl</key><key>Left</key></keyseq> and
<keyseq><key>Ctrl</key><key>Right</key></keyseq> to move and read by word.
</p>
</item>
<item>
<p>
Use <key>Up</key> and <key>Down</key> to move and read by line.
</p>
</item>
<item>
<p>
Use <key>Shift</key> in combination with the above commands to select and
unselect text.
</p>
</item>
</list>
<note style="tip">
<title>Enabling Caret Navigation in an Application</title>
<p>
Not all applications have caret navigation enabled by default. For many GNOME
applications, caret navigation can be toggled on and off by pressing <key>F7</key>.
</p>
</note>
<p>
In addition to reading a document by caret navigation, you may find it helpful
to read, spell, and obtain the Unicode value for the current text. You can do
these things through <app>Cthulhu</app>'s <link xref="howto_flat_review">Flat
Review feature</link>.
</p>
<p>
Finally, in order to have <app>Cthulhu</app> speak the entire document from your
present location, use the Say All command. It, along with a more complete
listing of <app>Cthulhu</app>'s commands for accessing document text, can
be found in the <link xref="commands_reading">Reading Commands</link> guide.
</p>
</page>
-46
View File
@@ -1,46 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_flat_review">
<info>
<link type="guide" xref="index#reviewing"/>
<link type="next" xref="howto_cthulhu_find" />
<title type="sort">2. Flat Review</title>
<desc>Examining a window spatially</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Flat Review</title>
<p>
<app>Cthulhu</app>'s Flat Review feature allows you to spatially review the
contents, both text and widgets, of the active window. In this mode,
<app>Cthulhu</app> treats the window as if it were a two-dimensional sheet of
text, eliminating any notion of widget hierarchy or other logical grouping
within the window.
</p>
<p>
The "flattened" contents, also known as the Flat Review context, can be
<link xref="commands_flat_review">navigated</link> by line, by word, by
character, and by object. In addition, you can perform a left-click or
right-click on the object being reviewed. Finally, you can use
<link xref="howto_cthulhu_find">Cthulhu Find</link>, a Flat-Review-based feature
to search the active window's contents.
</p>
<p>
Because the Flat Review context is a spatial representation of the active
window's contents, it is created when you first enter Flat Review and only
contains those objects which are visible. As a result, you will not be able
to use Flat Review to access items which are in the window but currently
off-screen. In addition, if the window's contents change of their own
accord, the Flat Review context will not automatically be updated. You can
cause a new context to be built by toggling Flat Review off and back on.
</p>
<p>
Finally, Flat Review by its nature is a mode that cannot be used at the same
time that <app>Cthulhu</app> is tracking focus. Thus if you are in Flat Review
and then use the application's navigation commands to move the caret or to
give focus to another object, you will automatically leave Flat Review.
</p>
</page>
-95
View File
@@ -1,95 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_forms">
<info>
<link type="guide" xref="index#reading"/>
<link type="next" xref="howto_live_regions" />
<title type="sort">5. Filling out forms</title>
<desc>
Accessing widgets embedded in documents
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Filling out forms</title>
<p>
When interacting with web pages and other documents using <app>Cthulhu</app>,
you are interacting with the document itself; not a buffered copy of that
document. <app>Cthulhu</app>'s browse and focus modes let you switch between
reading and filling out forms.
</p>
<section id="navigating_amongst_form_fields">
<title>Navigating Amongst Form Fields</title>
<p>
To navigate amongst form fields, you have several options:
</p>
<list>
<item>
<p>
Use <key>Tab</key> and <keyseq><key>Shift</key><key>Tab</key></keyseq>
to navigate amongst focusable objects, regardless of type.
</p>
</item>
<item>
<p>
Use <app>Cthulhu</app>'s <link xref="commands_structural_navigation#forms">
structural navigation commands for forms</link>.
</p>
</item>
<item>
<p>
Depending on the form and the application, you may also be
able to use the arrow keys to navigate to a given form field.
</p>
</item>
</list>
<note style="tip">
<p>
In order to use <app>Cthulhu</app>'s caret navigation or structural navigation
commands to navigate to a form field, you must be in browse mode. If you are
in focus mode, you can switch to browse mode by pressing <keyseq><key>Cthulhu
Modifier</key><key>A</key></keyseq>.
</p>
</note>
</section>
<section id="exiting_form_fields">
<title>Exiting Form Fields</title>
<p>
To exit a form field, you have several options:
</p>
<list>
<item>
<p>
Use <key>Tab</key>/<keyseq><key>Shift</key><key>Tab</key></keyseq>
if you wish to leave the currently-focused form field and move to the
next/previous focusable object, regardless of type.
</p>
</item>
<item>
<p>
Use <app>Cthulhu</app>'s <link xref="commands_structural_navigation#forms">
structural navigation commands for forms</link> to move to the next or
previous form field.
</p>
</item>
<item>
<p>
Depending on the form and the application, you may also be
able to use the arrow keys to navigate out of a given form field.
</p>
</item>
</list>
<note style="tip">
<p>
In order to use <app>Cthulhu</app>'s caret navigation or structural navigation
commands to exit a form field, you must be in browse mode. If you are in
focus mode, you can switch to browse mode by pressing <keyseq><key>Cthulhu
Modifier</key><key>A</key></keyseq>.
</p>
</note>
</section>
</page>
-141
View File
@@ -1,141 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_key_bindings">
<info>
<link type="guide" xref="index#getting_started"/>
<link type="next" xref="howto_profiles" />
<title type="sort">8. Keybindings</title>
<desc>Binding, rebinding, and unbinding commands</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Keybindings</title>
<p>
Cthulhu has many commands, some of which are bound to a keystroke, others
of which are unbound. You can bind, rebind, and unbind <app>Cthulhu</app>'s
commands by following the steps below.</p>
<steps>
<title>Binding an Unbound Command</title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog
by pressing <keyseq><key>Cthulhu Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>Move to the <gui>Key Bindings</gui> page.</p>
</item>
<item>
<p>
Arrow to the cell which contains the command you want to assign a
keystroke to.
</p>
</item>
<item>
<p>
Arrow once to the right. This will place focus in the <gui>Key
Binding</gui> column. Press <key>Return</key>.
</p>
</item>
<item>
<p>Press the desired key combination.</p></item>
<item>
<p>
Press <key>Return</key> to confirm the new combination. The new
keystroke will be saved and the check box in the last column (the
<gui>Modified</gui> column) will indicate that the key binding
has been modified.
</p>
</item>
<item>
<p>Press the <gui>Apply</gui> button.</p>
</item>
</steps>
<steps>
<title>Changing Existing Bindings</title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog by
pressing <keyseq><key>Cthulhu Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>Move to the <gui>Key Bindings</gui> page.</p>
</item>
<item>
<p>
Arrow to the cell which contains the binding you which to change and
press <key>Return</key>.
</p>
</item>
<item>
<p>Press the desired key combination.</p>
</item>
<item>
<p>
Press <key>Return</key> to confirm the new combination. The new
keystroke will be saved and the check box in the last column (the
<gui>Modified</gui> column) will indicate that the key binding has
been modified.
</p>
</item>
<item>
<p>Press the <gui>Apply</gui> button.</p>
</item>
</steps>
<steps>
<title>Restoring Original Bindings</title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog by
pressing <keyseq><key>Cthulhu Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>Move to the <gui>Key Bindings</gui> page.</p>
</item>
<item>
<p>Arrow to the modified column associated with the key binding.</p>
</item>
<item>
<p>Uncheck the checkbox by pressing <key>Space</key>.</p>
</item>
<item>
<p>Press the <gui>Apply</gui> button.</p>
</item>
</steps>
<steps>
<title>Unbinding Bound Commands</title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog by
pressing <keyseq><key>Cthulhu Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>Move to the <gui>Key Bindings</gui> page.</p>
</item>
<item>
<p>
Arrow to the cell which contains the binding you which to delete
and press <key>Return</key>.
</p>
</item>
<item>
<p>
When prompted for the new keybinding, press <key>Delete</key> or
<key>BackSpace</key>. You will be told that the key binding has
been removed.
</p>
</item>
<item>
<p>Press <key>Return</key> to confirm.</p>
</item>
<item>
<p>Press the <gui>Apply</gui> button.</p>
</item>
</steps>
</page>
-62
View File
@@ -1,62 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_keyboard_layout">
<info>
<link type="guide" xref="index#getting_started"/>
<link type="next" xref="howto_toggling_caps_lock" />
<title type="sort">6. Keyboard Layout</title>
<desc>Selecting the Desktop or Laptop layout</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Keyboard Layout</title>
<p>
Cthulhu has two keyboard layouts: Desktop (i.e. with a numeric keypad) and
Laptop. The layout you choose impacts which key is used as the Cthulhu Modifier.
</p>
<list>
<item>
<p>
If you are using the Laptop layout, the default Cthulhu Modifier will be
<key>CapsLock</key>
</p>
</item>
<item>
<p>
If you are using the Desktop layout, the Cthulhu Modifier will be both
<key>Insert</key> and <key>KP_Insert</key>, the latter being the
same key as <key>KP_0</key>.
</p>
</item>
</list>
<p>
The layout also determines the keystrokes associated with a number of
<app>Cthulhu</app>'s commands, especially in the areas of Flat Review,
Where Am I, and Say All.
</p>
<steps>
<title>
Changing Your Keyboard Layout
</title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog
by pressing <keyseq><key>Cthulhu Modifier</key><key>Space</key></keyseq>.
</p>
</item>
<item>
<p>
Move to the <gui>Keyboard Layout</gui> group of radio buttons.
</p>
</item>
<item>
<p>Arrow to the desired layout.</p>
</item>
<item>
<p>Press the <gui>Apply</gui> button.</p>
</item>
</steps>
</page>
-69
View File
@@ -1,69 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_learn_modes">
<info>
<link type="guide" xref="index#getting_started" />
<link type="next" xref="howto_keyboard_layout" />
<title type="sort">5. Learn Mode</title>
<desc>
Discovering <app>Cthulhu</app>'s commands
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Learn Mode</title>
<p>
In Learn Mode, <app>Cthulhu</app> will announce each keystroke you pressed
along with any associated <app>Cthulhu</app> command that keystroke is bound
to. In this mode, you can also get a list of shortcuts containing all the
<app>Cthulhu</app> commands you can use.
</p>
<steps>
<title>Using Learn Mode</title>
<item>
<p>
Get into Learn Mode by pressing <keyseq><key>Cthulhu Modifier</key>
<key>H</key></keyseq>.
</p>
</item>
<item>
<p>
Press any key or keystroke. <app>Cthulhu</app> will announce the keys and
any associated command.
</p>
</item>
<item>
<p>Press <key>Esc</key> to exit Learn Mode.</p>
</item>
</steps>
<steps>
<title>Getting a List of Shortcuts</title>
<item>
<p>
Get into Learn Mode by pressing <keyseq><key>Cthulhu Modifier</key>
<key>H</key></keyseq>.
</p>
</item>
<item>
<p>
Press <key>F2</key> if you want a list of shortcuts that apply
<app>Cthulhu</app>-wide, or press <key>F3</key> if you want a list
of shortcuts that are specifically for the application with focus.
</p>
</item>
<item>
<p>
Press <key>Up</key> or <key>Down</key> to examine the contents of the
list.
</p>
</item>
<item>
<p>
Press <key>Esc</key> to exit the list.
</p>
</item>
</steps>
</page>
-60
View File
@@ -1,60 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_live_regions">
<info>
<link type="guide" xref="index#reading"/>
<link type="next" xref="howto_whereami" />
<title type="sort">6. Live Regions</title>
<desc>
Interacting with dynamic web content
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Live Regions</title>
<p>
A live region is a dynamically-updated portion of a web page, such as a
table of sports statistics, a list of current stock prices, a log from
a chat, or an alert displayed by the page you are reading. While live
regions appear quite frequently, fully accessible web pages with live
regions are encountered less often. This problem is actively being
addressed by a number of organizations.
</p>
<section id="politeness_levels">
<title>Live Region Politeness Levels</title>
<p>
Live regions have an associated "politeness" level which is set by the
author as a means to convey the importance of the information and to
suggest when users should be informed by their assistive technology of
updates made within that region. Live regions can be "off", "polite", or
"assertive" to the point of being "rude."
</p>
</section>
<section id="cthulhu_support">
<title><app>Cthulhu</app>'s Support for Live Regions</title>
<p>
Because you might not agree with the politeness level specified by the
author whose page you are viewing, <app>Cthulhu</app> provides a number of
<link xref="commands_live_regions">live region commands</link> which
allow you to modify the level of any or all of the regions on a page.
In addition, you can:
</p>
<list>
<item>
<p>Turn live region support on or off</p>
</item>
<item>
<p>Jump to the next and previous live region spatially</p>
</item>
<item>
<p>Jump to the last live region which presented information</p>
</item>
<item>
<p>Review the last nine live region messages which were presented</p>
</item>
</list>
</section>
</page>
-50
View File
@@ -1,50 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_mouse_review">
<info>
<link type="guide" xref="index#reviewing"/>
<link type="next" xref="howto_notifications" />
<title type="sort">4. Mouse Review</title>
<desc>Using the pointer to examine the screen</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Mouse Review</title>
<p>
<app>Cthulhu</app>'s Mouse Review feature causes <app>Cthulhu</app> to present
the object under the mouse pointer. Unlike <app>Cthulhu</app>'s
<link xref="howto_flat_review">Flat Review</link> feature, Mouse Review
is not limited to the active window; instead, <app>Cthulhu</app> will attempt
to identify what accessible object, if any, is visually under the pointer
as you move the mouse. If you have moved the pointer over an accessible
object with information to present, <app>Cthulhu</app> will present that object
and its information to you.
</p>
<p>
Because enabling Mouse Review causes <app>Cthulhu</app> to listen for, and then
process, all changes in the position of the Mouse Pointer, this feature is
disabled by default. To have it always enabled, check the <gui>Speak object
under mouse</gui> checkbox found on the
<link xref="preferences_general">General page of <app>Cthulhu</app>'s
Preferences dialog</link>. In addition, you will find an unbound command
named <gui>Toggle mouse review mode</gui> on the
<link xref="preferences_key_bindings">Key Bindings page</link> of that same
dialog box. By binding this command, as described in the
<link xref="howto_key_bindings">Introduction to Key Bindings</link>,
you can enable and disable Mouse Review on an as-needed basis.
</p>
<note style="tip">
<title>
Default Settings and Keybindings Are Independent of One Another
</title>
<p>
Note that you can choose to have Mouse Review always enabled or not and
still toggle it on and off by binding and using the <gui>Toggle mouse
review mode</gui> command. It is not necessary to enable it in order to
toggle it because settings and keybindings are independent of one another.
</p>
</note>
</page>
-69
View File
@@ -1,69 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_notifications">
<info>
<link type="guide" xref="index#reviewing"/>
<link type="next" xref="howto_bookmarks" />
<title type="sort">5. Notifications</title>
<desc>Reading previously-received messages</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Notifications</title>
<p>
The GNOME Desktop includes a "notification area" which can be used by
applications to present information to the user. Examples of notifications
include incoming chat messages, the details associated with the song your
media player is starting to play, and warnings that your battery level is
getting low.
</p>
<p>
Because notifications are intended to present information to users without
interrupting what the user is doing, these messages tend to appear and
disappear relatively quickly. They are also not focusable. While
<app>Cthulhu</app> will present these messages to you as they come in, it is
far too easy to interrupt <app>Cthulhu</app>'s announcement accidentally by
continuing to type or to change focus. For this reason, <app>Cthulhu</app> has
three commands which you can use to access previously-displayed notification
messages:
</p>
<list>
<item>
<p>Present the last (most recent) notification message</p>
</item>
<item>
<p>Present the previous notification message</p>
</item>
<item>
<p>Present list of all notification messages</p>
</item>
</list>
<p>
The first two commands are designed mainly for quick access to a message
you just received. The last command is the most powerful as it stores your
notification message history.
</p>
<p>
When you enter the list of notification messages, you will be told the size
of the list and prompted with the following choices:
</p>
<list>
<item><p>Press H for help.</p></item>
<item><p>Use Up, Down, Home or End to navigate in the list.</p></item>
<item><p>Press Escape to exit.</p></item>
<item><p>Press Space to repeat the last message read.</p></item>
<item><p>Press one digit to read a specific message.</p></item>
</list>
<p>
Note that the most recently-received message is at the top of the list.
</p>
<p>
Each of <app>Cthulhu</app>'s notification review commands is unbound by
default. You can bind any or all of them to the shortcut or shortcuts
you choose. How to do so is described in the
<link xref="howto_key_bindings">Introduction to Key Bindings</link>.
</p>
</page>
-116
View File
@@ -1,116 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_profiles">
<info>
<link type="guide" xref="index#getting_started"/>
<link type="next" xref="howto_documents" />
<title type="sort">9. Profiles</title>
<desc>Maintaining multiple configurations</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Profiles</title>
<p>
Cthulhu's profiles allow you to save and load multiple configurations so
that you can quickly access the settings you need.
</p>
<steps>
<title>Saving a New Profile</title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog box.
</p>
</item>
<item>
<p>Change whatever settings you wish.</p>
</item>
<item>
<p>
On the <gui>General</gui> page, press the <gui>Save As</gui> button.
</p>
</item>
<item>
<p>
Type the new profile name in the resulting <gui>Save Profile As</gui>
dialog box.
</p>
</item>
<item>
<p>
Press the <gui>OK</gui> button in the <gui>Save Profile As</gui>
dialog box.
</p>
</item>
</steps>
<steps>
<title>Loading an Existing Profile</title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog box.
</p>
</item>
<item>
<p>
On the <gui>General</gui> page, select the profile to load from the
<gui>Active Profile</gui> combo box.
</p>
</item>
<item>
<p>Press the <gui>Load</gui> button.</p>
</item>
<item>
<p>
You will be asked to confirm. Press the <gui>Yes</gui> button.
</p>
</item>
<item>
<p>Press the <gui>OK</gui> button.</p>
</item>
</steps>
<steps>
<title>Changing an Existing Profile</title>
<item>
<p>
Follow the steps described above to load the profile you wish to change.
</p>
</item>
<item>
<p>Follow the steps described above to save a new profile.</p>
</item>
<item>
<p>
When prompted for the new profile name, type the same name as current
profile. When you press the <gui>OK</gui> button, you will be told there
is a name conflict.
</p>
</item>
<item>
<p>
Press the <gui>Yes</gui> button to confirm you wish to overwrite the
existing profile with the new settings.
</p>
</item>
</steps>
<steps>
<title>Changing the <gui>Start-up Profile</gui></title>
<item>
<p>
Get into the <link xref="preferences">Cthulhu Preferences</link> dialog box.
</p>
</item>
<item>
<p>
On the <gui>General</gui> page, select the profile to load from the
<gui>Start-up Profile</gui> combo box.
</p>
</item>
<item>
<p>Press the <gui>OK</gui> button. The next time you launch <app>Cthulhu</app>,
the newly-selected profile will be used.
</p>
</item>
</steps>
</page>
-30
View File
@@ -1,30 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="howto_setting_up_cthulhu">
<info>
<link type="seealso" xref="preferences" />
<link type="guide" xref="index#getting_started" />
<link type="next" xref="howto_the_cthulhu_modifier" />
<title type="sort">4. Cthulhu Configuration</title>
<title type="link">Configuration</title>
<desc>
Setting up <app>Cthulhu</app>
</desc>
<credit type="author">
<name>Joanmarie Diggs</name>
<email>joanied@gnome.org</email>
</credit>
<license>
<p>Creative Commons Share Alike 3.0</p>
</license>
</info>
<title>Cthulhu Configuration</title>
<p>
If you want to configure <app>Cthulhu</app>, get into the
<link xref="preferences">Preferences</link> dialog by pressing
<keyseq><key>Cthulhu Modifier</key><key>Space</key></keyseq> from
within any accessible application. Alternatively, you can type
<cmd>cthulhu</cmd> followed by either <cmd>-s</cmd> or <cmd>--setup</cmd>
in a terminal window or within the <gui>Run</gui> dialog and then press
<key>Return</key>.
</p>
</page>
Loaded 100 of 2182 files, more files were not shown because too many files have changed in this diff. Show more