gok(1) User Commands gok(1)NAMEgok - GNOME on-screen keyboard
SYNOPSISgok [--access-method=name] [--editor] [--extras] [--geometry=geometry]
[--help] [--input-device=device] [--keyboard=keyboard] [--list-access‐
methods] [--list-actions] [--login] [--remembergeometry] [--scan-
action=string] [--select-action=string] [--settings] [--usage] [--valu‐
ator-sensitivity=double] [gnome-std-options]
DESCRIPTION
The GNOME On-screen Keyboard (GOK) is a dynamic on-screen keyboard for
UNIX and UNIX-like operating systems. gok enables users to control
their computer without having to rely on a standard keyboard or mouse.
Many individuals must control the computer using alternative input
methods. With the right hardware support and gok, individuals have full
access to applications that support the AT SPI, and therefore, full
access to the functionality that these applications provide.
OPTIONS
The following options are supported:
-a, --access-method=name Use the specified access method. name
is a string and can be found in the
various access method files (.xam)
assigned to the "name" property of the
<gok:accessmethod> tag. Note that this
is not necessarily the same as the name
of the .xam file, see --list-access‐
methods.
-e, --editor Start the GOK keyboard editor.
--extras Use special, but possibly unstable, gok
functionality.
--geometry=geometry If --geometry is not specified, gok
remembers its position between invoca‐
tions and starts in the same position
as when last shut down.
If --geometry is specified, gok posi‐
tions itself within the rectangular
area of screen described by the given
X11 geometry specification, but does
not remember its position when shut
down. This behavior can be changed
with the --remembergeometry option,
which forces gok to remember its posi‐
tion when shut down, even when started
with --geometry.
--help Displays the command line options.
-i, --input-device=device Use the specified input device.
-k, --keyboard=keyboard Start GOK with the specified keyboard.
--list-accessmethods List the access methods that can used
as options to other arguments.
--list-actions List the actions that can used as
options to other arguments.
-l, --login Specify that GOK is used to log in.
--remembergeometry Can be used with the --geometry option.
Forces GOK to remember its position
when shut down, even if started with
the --geometry option. See --geometry.
--scan-action=string Start GOK and hook this action to scan
operations. See --list-actions.
--select-action=string Start GOK and hook this action to
select operations. See --list-actions.
-s, --settings Open the settings dialog box when GOK
starts.
--usage Displays a brief usage message.
---valuator-sensitivity=double A multiplier to be applied to input
device valuator events before process‐
ing.
gnome-std-options Standard options available for use with
most GNOME applications. See gnome-
std-options(5) for more information.
EXTENDED DESCRIPTION
GOK features Direct Selection, Dwell Selection, Automatic Scanning and
Inverse Scanning access methods, and includes word completion.
GOK includes an alphanumeric keyboard and a keyboard for launching
applications. Keyboards are specified in XML, enabling existing key‐
boards to be modified and new keyboards to be created. The access meth‐
ods are also specified in XML, providing the ability to modify existing
access methods and create new ones. GOK is not limited to presenting
keyboards that have been designed by hand, and can dynamically create
keyboards to adapt to the user's current situation.
GOK can redisplay components of the user interfaces of running applica‐
tions directly within GOK as keyboards. This provides efficient access
to elements of the user interface, removing the need to navigate the
interface indirectly though keyboard accelerators. GOK supports the
redisplay of application menus and toolbars. GOK contains a window
activator keyboard that lists the current windows on the desktop and
provides the ability to switch between them.
Users have the option of setting key width, height, and spacing as well
as visual and auditory feedback on highlighting and selection. GOK can
be further customized if you have programming skills, and contributions
are welcome.
If you build GOK from source, you can find some documentation about the
internal GOK APIs in the gok/docs/reference/html directory.
Note: Although GOK can be operated via the "core pointer" device, that
is, the system mouse or a device that controls the primary onscreen
pointer, this mode of operation is not supported or recommended for
most users. This is because the operating system and primary GUI tool‐
kits reserve the core pointer for their own use, resulting in conflicts
with GOK that can "lock out" a GOK user who cannot activate the key‐
board or use the core pointer to "point and click" in the usual way.
GOK can be operated via "auxiliary" input devices, which act as sec‐
ondary or additional button or pointing devices. See the GOK online
reference manual and the GNOME Accessibility Guide for more information
on how to configure GOK to use auxiliary input devices.
EXAMPLES
Example 1: Specifying an Access Method to Use for GOK
example% gok --access-method=dwellselection
Example 2: Automatically Open the GOK Preferences Dialog When GOK
Starts
example% gok--settings
EXIT STATUS
The following exit values are returned:
0 Application exited successfully.
1 Application exited with error.
2 GOK cannot be initialized from configuration data.
FILES
The following files are used by this application:
/usr/bin/gok Executable for GNOME on-screen keyboard
/usr/share/gok/*.kbd GOK branching keyboards (C locale)
/usr/share/gok/*.xam Access Method definition files
/usr/share/gok/locale/*.kbd Localized GOK branching keyboards
/usr/share/gok/dictionary.txt Primary GOK word-completion dictionary
/usr/share/gok/*.png Image files for GOK branching keyboards
/usr/share/gok/goksound*.wav Example GOK audio feedback
/usr/share/gok.rc GtkRC file defining GOK color scheme
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌─────────────────────────────┬─────────────────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├─────────────────────────────┼─────────────────────────────┤
│Availability │gnome/accessibility/gok │
├─────────────────────────────┼─────────────────────────────┤
│Interface stability │Volatile │
└─────────────────────────────┴─────────────────────────────┘
SEE ALSOattributes(5), gnome-std-options(5)
GOK online reference manual.
Latest version of the GNOME Accessibility Guide for your platform.
Latest version of the GNOME Desktop User Guide for your platform.
create-branching-keyboard(1)NOTES
Written by Bill Haneman and David Bolter, Sun Microsystems Inc., 2004,
2006, 2007.
SunOS 5.11 12 Nov 2007 gok(1)