Using CySplash

Documentation / CySplash

• Overview of CySplash
  • What It Does
  • What It Is Not
• Using CySplash
  • Startup Splash And PID Tracking
  • Session Chords
  • End-Session Panel
  • Global Help Overlay
  • Appearance And Sysinfo
  • Preview Without A Real Session
• Command Line
  • Tracking And Startup
  • Global Help Overlay
  • End-Session Panel
  • Appearance
  • Layout
  • System Info
  • Preview And Testing
• Copyright

Using CySplash

CySplash shows up in three places in a normal day: while the desktop comes up, when you ask to leave, and when you want a reminder of the session chords. The flags for each face are in Command Line.

Startup Splash And PID Tracking

startcyanotype.sh writes ~/.cyanotype/run/session.plan, starts each component, and drops ~/.cyanotype/run/NAME.pid (or NAME.fail) as things come up or die. CySplash polls those files and ticks the checklist:

• pending -- no pidfile yet
• starting -- pidfile appeared, process alive
• ready -- alive past a short grace
• failed / skipped -- .fail, dead pid, or timed out

When every planned row has resolved, the splash lingers briefly, fades with the selected wipe style, unmaps, and exits. A hard tracking timeout forces that resolution so a hung daemon cannot trap you behind the sheet.

CySplash self-backgrounds by default so the session script is not blocked while the window is up. Use --foreground only when you are debugging the splash itself.

Session Chords

cywm is the sole root grabber. Stock bindings (edit in cykeys):

• Control+Alt+Delete -- cysplash --end-session-panel
• Control+Alt+h -- cysplash --global-help

Both faces are singletons: Esc or click dismisses; a second spawn of the same face also dismisses. Open cykeys to change the chords; the catalog ids are session.end_session_panel and session.global_help.

End-Session Panel

The panel is a centered splash-sized window with shaded splash art and three stacked buttons: Logout, Shutdown, Reboot.

Buttons grey when the action is unavailable right now:

• Logout greys when nothing is listening for _CY_SESSION_LOGOUT (no cywm logout listener on this display)
• Shutdown and Reboot grey when there is no local privilege path (no sudo/doas grant for the host shutdown tools, and no cypower)

Esc or Cancel leaves the session alone. Logout fires the Logout sound and sends _CY_SESSION_LOGOUT; cywm leaves its event loop and startcyanotype.sh ends the session because it waits on cywm.

For scripts and menus that must not open a window:

cysplash --logout-now
cysplash --check-logout
cysplash --logout-now --dry-run

cylogout is a deprecated shim that execs these CySplash flags. Prefer CySplash directly; see the CyLogout book for the old names.

Global Help Overlay

--global-help draws a large overlay over the desk: shaded splash art, a raised panel, and the bound session hotkeys from the catalog defaults plus ~/.cyanotype/keys.conf. It does not track pids and does not change the session. Customize the list by editing keys in cykeys.

Appearance And Sysinfo

Wipe style, progress-bar style, scheme-based palette, and root pseudo-transparency are conf/CLI knobs (no theme GUI). Host facts on the SYSTEM SPECIFICATION panel come from the project's host-introspection probes and are cached under ~/.cyanotype/cysplash-sysinfo.cache so a normal login does not pay a shell-fork tax every time. Details and flags are in Command Line and Command Line.

Preview Without A Real Session

--dryrun, --simulate-loading-delay, --demo, and the wipe/transparency tours paint fixture data with no pid tracking and no logout side effects. Use them on a nested X display when judging art, scroll, or fade pacing.

See Also

• Overview of CySplash
• Command Line