Name

Clickity — simulate difficult clicks and drags

Synopsis

Clickity [actions]

DESCRIPTION

Clickity is a tray-icon program for simulating mouse clicks and drags that are difficult to perform because of limited hand use or limited pointing hardware. It will run on any X or win32 system that supports tray icons; it does not require an integrated desktop environment or accessiblity framework to be installed.

Clickity displays an icon corresponding to the action it will perform when activated either by holding down and then releasing the left mouse button or by moving the pointer and letting it dwell in position (dwell mode is turned off by default). Actions include single clicks, double clicks and drags of the left, right and middle buttons, as well as single clicks of the up and down buttons (corresponding to scroll-wheel motion. When Clickity is about to activate, it starts blinking the icon; moving the pointer will cancel the activation.

The action to perform can be selected by clicking on the icon (or hovering over it in dwell mode) or by continuing to hold down the left button after the icon starts blinking. This will step through the sequence of available actions, known as a profile. Profiles are defined in Clickity's configuration file and can be selected from the icon's right-click menu. For example, you could have a main profile that includes just left and right clicks, and another one including left drag and middle click that you'd switch to if you need to do copying and pasting.

Specifying one or more actions on the command line creates an initial profile called ARGS. Another profile, ALL, is always available and will be used if there are no actions on the command line and no profile defined in the configuration file. It includes every possible action. The available actions are:

left-click
right-click
middle-click
up
down
left-double-click
right-double-click
middle-double-click
left-drag
right-drag
middle-drag
idle - Performs no action
menu - Pops up the menu when activated
back - Returns to the previously selected profile. Profiles can be stacked indefinitely

If an action ends with '+' performing it will automatically step to the next action. If it ends with '%' performing it will automatically return to the previous profile. See the "cutnpaste" profile in the sample configuration file for an example.

Dwell mode and hold mode can be used simultaneously; it is possible to have a different action for each (see the jump option). Drags are automatically released if you let the pointer stand still without moving it, and can also be released by pressing the control key. Dwelling over the icon always performs a left-click (stepping to the next action); holding over the icon always performs a right-click (bringing up the menu). This last behavior is not available on win32 systems due to a limitation in GTK's StatusIcon implementation; if using exclusively dwell mode on a win32 system, you will need to enable autoscan.

OPTIONS

-d, --delay milliseconds

Sets the time that the left button has to be held down to activate Clickity.

-s, --step-delay milliseconds

Sets the time that the left button has to be held down after activation in order to start stepping to other actions. If zero, no stepping will occur.

-r, --step-rate milliseconds

Sets the time between displaying actions when stepping.

-l, --drag-release milliseconds

Sets the time that the pointer needs to stand still after moving in order to release a drag. If set to zero, drags will not release until you press the control key.

-e, --dwell milliseconds

Sets the time that the pointer needs to stand still in order to activate the action in dwell mode. If set to zero (the default), dwell mode will not be used.

-w, --dwell-warning milliseconds

Sets the time that the icon will blink after dwell mode is activated. During this time, moving the pointer will cancel dwell mode until the pointer is moved again. If set to zero, there will be no warning period and the action will immediately take place after the time specified by --dwell.

-u, --up-down-rate milliseconds

Sets the rate at which up and down actions will repeat (auto-scroll). If zero, they are treated as clicks. Moving the pointer or pressing the control key terminates auto-scrolling.

-o, --up-down-delay milliseconds

Sets the time before auto-scrolling begins after an up or down action. During this time, moving the pointer or pressing the control key will prevent auto-scrolling. If zero, auto-scrolling starts immediately.

-t, --threshold pixels

Sets the distance the pointer needs to move to prevent activation or prevent cancelling a drag.

-a, --autoscan

When idle, step through actions at the rate set by step-rate. In dwell mode, moving the cursor will stop autoscanning until an action is performed.

-j, --jump

Holding the left button uses the next, rather than current, action in the profile if dwell mode is active. For example, if your profile is left-click right-click dwelling will perform a left click and holding will perform a right click.

-v, --revert

After performing an action that was stepped to, the selected action will be restored to the one you started from.

-p, --profile name

Use the named profile from the configuration file. If this option is not used, the profile specified by the profile option in the configuration file will be used if it exists. A profile on the command line will override this.

-h, --help

Display help for Clickity

--version

Display Clickity's version number.

FILES

Clickity looks for a configuration file (clickity/clickity.cfg) in the user configuration directory ($XDG_CONFIG_HOME or ~/.config/ or the appropriate place on win32 systems); failing that, it will look for one in the system-wide configuration directory ($XDG_CONFIG_DIRS or /etc/xdg/; not on win32 systems). The configuration file contains two sections, [settings] and [profiles]. [settings] contains name=value pairs where the names are the same as the long names for the options without the leading dashes. Options on the command line will override these settings. The jump, revert and autoscan options take "true" or "false" as their values. [profile] contains profile definitions consisting of the profile's name, an equal sign, and a list of action names separated by spaces as if they were included on the command line.

A sample configuration file, clickity/clickity.cfg.sample, is installed in the system-wide configuration directory; you can copy it to your user configuration directory and edit it to specify your preferences.

All settings and profiles can be edited using a dialog box from the Preferences item in the menu. They will be saved to a configuration file in the user configuration directory.

EXAMPLES

clickity --dwell=1000 --jump --revert left-click right-click middle-click &

Dwelling left-clicks, holding right-clicks or steps to middle-click, going back to right-click

clickity --delay=500 -profile=touchpad &

No dwell, use defined profile

AUTHORS

Clickity was written by Eric Bohlman <ericbohlman@gmail.com>