Skip to content

Lokaltog/candybar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

candybar(1)

Name

candybar - WebKit-based status bar for tiling window managers

Synopsis

candybar [-d] [-c config-file] [-h height] [-m monitor] [-p position] [-t theme-uri]

Description

candybar displays a HTML-based status bar in a WebKit web view. It provides a smooth looking status bar with CSS transitions and effects, and the possibility of having a transparent background with effects without a desktop compositor running.

Screenshots are available on the candybar wiki.

Options

-d

Enable debugging mode and display the WebKit inspector window on launch.

-c config-file

Read configuration options from the specified config-file. config-file overrides CANDYBAR_CONFIG_PATH and any system-wide and per-user configuration files. The file must exist and be valid JSON.

-h height

Set the height of the status bar in pixels.

-m monitor

Define which monitor the status bar appears on.

-p position

Set the status bar position. Valid options are top and bottom.

-t theme-uri

Set the URI for a theme HTML file. Must be a valid URI, i.e. local files must be prefixed with file://.

Window manager support

bspwm

supported; requires bspwm to be configured to reserve space with bspc config top_padding 24.

dwm

supported; requires the dwm built-in bar to be enabled and set to the same position and height as candybar, candybar will be placed on top of the dwm bar.

i3

supported; desktop support requires the desktops_i3 widget to be enabled instead of the default desktops widget for desktop list support.

monsterwm

supported

qtile

supported; requires a recent version, support for desktop EWMH properties was implemented in qtile revision 02fd471.

Files

~/.config/candybar/config.json

Per-user configuration file. See candybar(5) for further details.

/etc/xdg/candybar/config.json

System-wide configuration file. See candybar(5) for further details.

Environment

CANDYBAR_CONFIG_PATH

Full path of an alternate config.json file. This variable overrides any system-wide and per-user configuration files, but does not override the -c command-line argument. The file must exist and be valid JSON.

Authors

Kim Silkebækken <kim@silkebaekken.no>

See https://github.com/Lokaltog/candybar/graphs/contributors for a list of all contributors.

See also

candybar(5)

About

WebKit-based status bar for tiling window managers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published