Command Line

Documentation / CyOSD

• Overview of CyOSD
  • What It Does
  • What It Is Not
• Using CyOSD
  • Say One Thing
  • Multiline Text
  • Place It Where Eyes Already Are
  • Progress Without A Dialog
  • Colour And Face
• Command Line
  • Timing And Lifetime
  • Placement
  • Look
  • Progress Meters
  • Multiline Text
• Copyright

Command Line

cyosd puts a short message on the screen and takes it away again. Most day-to-day use is one line from a script or session hook.

cyosd [options] TEXT...

Timing And Lifetime

• -t, --time SEC -- total visibility in seconds, fade included (default 1.0)
• --delay SEC -- wait before showing; not part of --time
• --no-wait -- map and exit; banner dies with the process
• -h, --help / -V, --version -- usage or version, then exit
• --selftest -- headless timing and parse checks (no display)
• --log SPEC / -v / -q -- logging (debug,stderr; info,syslog; quiet)

Placement

• -p, --pos=POS -- vertical: top, middle (default), or bottom
• -o, --offset=N -- vertical offset in pixels from edge or center
• -A, --align=ALIGN -- horizontal: left, center (default), or right
• -i, --indent=N -- horizontal indent in pixels from edge or center
• -g, --geometry=WxH -- minimum canvas; 0 = auto that dimension

Look

• -fa, --font=FACE, --face=FACE -- Xft/XLFD face (overrides scheme bold look)
• -c, --color=COLOR -- text ink: name or #RRGGBB (outline too on meters)
• --wipe=STYLE -- arrive/leave: dissolve, diagonal, blinds, or iris
• --bar=STYLE -- meter style: forge (default) or gradient
• --style=NAME -- sgi or forge: which bar the meter wears
• --frames=DIR -- dump every fade level as XPM (debug)

Progress Meters

cyosd --progress 0.45 --no-wait Rebuilding thumbnails
cyosd --progress-demo
cyosd --demo

• --progress FRAC -- show a meter filled to FRAC (0..1); TEXT is the label
• --pv -- read a progress value per stdin line (0..1 or 0..100) and drive the bar
• --progress-demo -- animate FORGE 0% to 100%, then fade
• --demo -- full default-capabilities tour

Progress labels may be multiline the same way as plain banners.

Multiline Text

Real newlines in TEXT, or a two-character \n sequence in an argument:

cyosd -t 3 $'Build complete\nAll tests green'
cyosd 'Line one\nLine two'

The chip grows to fit; long lines word-wrap. No mid-glyph clip.

Examples

cyosd -t 2 Scheme applied
cyosd --wipe=iris -t 1.5 'Emerald Mountain'
cyosd -p top -A right -o 40 -i 40 -fa 'DejaVu Sans:size=32:style=Bold' 'Volume up'
cyosd -c red -t 2 Alert
cyosd --color=#00ff88 'OK'
cyosd -p bottom -o 24 -g 480x80 Working...

See Also

• Using CyOSD
• Overview of CyOSD