Keys, Files, and the Command Line

Documentation / Contents - Mouse Settings

• Overview of Mouse Settings
  • The Window
  • The Buttons
  • When Changes Take Effect
  • The Trail and Cursor Daemon
• The Pointer Page
  • Mouse Acceleration
  • Mouse Mapping
  • Click Speed
  • How the Double-Click Time Reaches Applications
• The Trail Page
  • Show mouse trail
  • Trail style
  • Trail length
  • Options for Smoke/Dust FX
    • Smolder
    • Effect spheres
    • Stray pixels
    • Effect type
• The Cursor Page
  • Style
  • Cursor size
  • What This Does and Does Not Cover
• Keys, Files, and the Command Line
  • Keys
  • Command Line
  • The Configuration File
  • Environment Variables
• What Is Not Here
  • Belongs to Another Panel
  • Not Built
  • Known Rough Edges
  • Related Books

Other cards

• Copyright Information

Keys

Two, and they work wherever the focus happens to be.

Escape           quit, without saving
Return, Enter    activate the default button

The default button is Close on the canonical face and Apply on the extended face, so Return on the extended face saves and applies.

There are no other shortcuts and no mnemonics. Everything else is done with the mouse.

Command Line

cymouse               the tabbed panel; the default
cymouse --canonical   the SGI face: presets, Finer Control disclosure
cymouse --apply       load the settings, push them to X, and exit
cymouse --paths       print the configuration path and the stored values
cymouse --selftest    the built-in checks; no display needed
cymouse --version     version
cymouse --help        usage

--apply is the login hook. It needs a display; it opens no window. Put it in your session startup so the settings you saved are in force from the start.

--selftest covers the configuration round trip and the acceleration encoding, and needs no display.

Unlike most Blueprint programs, cymouse does not take --log, --verbose or --quiet. It parses its own arguments.

The Configuration File

~/.cyanotype/cymouse.conf

Set CYMOUSE_CONF to use a different path. Unknown keys are preserved.

accel_num          with accel_den, the acceleration; 7 and 1 by default
accel_den
accel_threshold    1 to 10; 6 by default, factory 4
left_handed        off
double_click_ms    200
trail              off
trail_length       6, 14 or 26; 14 by default
trail_style        smoke, line or butterflies
trail_fade         written for older versions of the daemon
trail_smolder      off
trail_spheres      sparse, normal or dense; normal
trail_stray        few, some or lots; some
trail_color        scheme, ice, fire, dust or smoke; scheme
cursor_style       off, chrome, ice, lava, emerald, copper, sapphire,
                   obsidian or jewel; chrome
cursor_size        0 for Auto, else 48, 64, 96, 128 or 160

The acceleration is stored as a fraction. A positive setting of 7 is written as accel_num 7 and accel_den 1; a setting of -4 is written as accel_num 1 and accel_den 4.

One key the daemon understands is not written by this panel:

trail_rgb          a literal #RRGGBB trail colour

It is left over from a custom colour picker that is no longer on the panel. The daemon still honours it if you set it by hand together with a trail_color of custom.

Environment Variables

CYMOUSE_CONF            use this configuration file
CYMOUSE_ICON            override the header picture
CYMOUSE_CURSOR_SPRITE   override the cursor previews
HOME, DISPLAY           the usual

Next

• What Is Not Here
• Overview of Mouse Settings