Command Line

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

Command Line

cysplash has one default mode (startup tracking) and several foreground faces that do not watch pids. Conf lives in ~/.cyanotype/cysplash.conf; CLI switches mirror the same keys where noted.

cysplash [options]

Standard: -h/--help, -V/--version, --selftest, --log=SPEC, -v/--verbose, -q/--quiet.

Tracking And Startup (Default)

cysplash does not start the desktop. The session script launches components and writes ~/.cyanotype/run/NAME.pid; cysplash watches those pids, paints the checklist, fades out, and exits. It self-backgrounds so the caller is not blocked while the splash is up.

• --foreground -- stay attached to the caller (no self-fork); for debugging cysplash itself
• --no-focus -- OSD banner mode: never a keyboard/click target (no KeyPress/ButtonPress in its own event mask, no Esc/click-to-dismiss grab even in preview). Safe under focus-follows-mouse PointerRoot lookup; dismisses on its own timers

Global Help Overlay

Foreground overlay; no PID tracking.

• --global-help -- large overlay: shaded splash art, raised panel, bound session hotkeys from catalog defaults + ~/.cyanotype/keys.conf. Esc or click dismisses; a second --global-help also dismisses (singleton). Customize in cykeys. Default cywm chord: Control+Alt+h (session.global_help)

End-Session Panel

Foreground window; no PID tracking.

• --end-session-panel -- centered splash-sized window with Logout, Shutdown, and Reboot. Buttons grey when unavailable (no cywm logout listener; no sudo/doas grant and no cypower for power actions). Esc / Cancel dismisses; a second spawn also dismisses (singleton). Default cywm chord: Control+Alt+Delete (session.end_session_panel)
• --logout-now -- no UI: fire Logout sound and send _CY_SESSION_LOGOUT (scripted replacement for cylogout --now)
• --from NAME -- who asked (chest / cywm / cad / cli); log only
• --check-logout -- print whether logout is available; exit 0 or 3
• --dry-run -- with --logout-now: say what would be sent; send nothing

Appearance

Named modes only (conf/CLI; no theme GUI). Each mode is a ~/.cyanotype/cysplash.conf key (wipe, bar) or its matching switch.

• --wipe=STYLE -- fade-in/out: dissolve (default), diagonal, blinds, iris
• --bar=STYLE -- progress bar: gradient (default), forge (Doom-fire along the bar length; tongues flicker past the fill edge)
• --scheme-mode -- derive the palette from the loaded .cyscheme's role colors (same color-theory path as background-sampled mode, not a literal copy). Pass a scheme path as a bare argument to pick one other than the default
• --transparent -- sample the real root wallpaper via _XROOTPMAP_ID / ESETROOT_PMAP_ID and blend the drafting sheet over it; falls back to a solid fill if no wallpaper pixmap is set. Sampled once at startup
• --transparency=N -- sheet opacity 0-255 over the wallpaper (default 230); lower shows more wallpaper. Implies --transparent

Layout

Offsets are deltas from the auto-centered position inside the fixed 800x600 frame, not absolute placement. Mirrored in conf as panel_a_offset, panel_b_offset, bar_offset (each "DX,DY").

• --panel-a-offset=DX,DY -- move SYSTEM SPECIFICATION
• --panel-b-offset=DX,DY -- move STARTUP SEQUENCE
• --bar-offset=DX,DY -- move the progress bar
• --print-geometry -- print the auto-centered baseline (x,y,w,h for each) and exit; compute offsets from that

System Info

CPU, RAM, audio, mics, and video come from the project's host-introspection probes and are cached under ~/.cyanotype/cysplash-sysinfo.cache.

• --sysinfo-cache-days=N -- cache TTL in days (default 30); 0 = always refresh. Conf key: sysinfo_cache_days

Preview And Testing

No PID tracking and no logout side effects unless you ask for them.

• --dryrun -- stand-alone preview with fixture data; Esc/click dismisses
• --demo-rows -- add fixture-only joke components (cyunicorn, ...) so the STARTUP SEQUENCE can scroll; never shown in a real session
• --dump-panels -- print both panels as TAB-separated rows and exit; no window; honours --demo-rows
• --simulate-loading-delay[=MS] -- animate the checklist over MS ms (default 5000) without a real desktop start. Implies --dryrun
• --fade-ms=MS -- fade-in/out duration (default 320); raise it to see a wipe style's shape clearly
• --wipe-demo -- cycle every wipe style (fade in, hold, fade out, next). Implies --dryrun
• --bench-wipe[=N] -- time apply_transition N times per style at mid fade (default 80); print ms and exit. Implies --dryrun
• --demo -- full tour: every wipe style and both palette modes, each announced by a brief on-screen label. Implies --dryrun; pair with --fade-ms for pacing
• --demo-label-ms=MS -- how long each --demo label holds (default 750); 0 skips the hold
• --transparency-demo -- cycle sheet transparency 0%, 20%, ... 100% so the blend can be judged at every step. Implies --transparent + --dryrun

Examples

cysplash --dryrun --wipe=iris --fade-ms=2000
cysplash --end-session-panel --from chest
cysplash --logout-now --dry-run
cysplash --global-help
cysplash --dump-panels --demo-rows

See Also

• Using CySplash
• Overview of CySplash