https://github.com/lycuid/clubar
A minialistic statusbar, inspired by xmobar and dwm's statusbar.
https://github.com/lycuid/clubar
c cluless statusbar x11 xorg
Last synced: 10 months ago
JSON representation
A minialistic statusbar, inspired by xmobar and dwm's statusbar.
- Host: GitHub
- URL: https://github.com/lycuid/clubar
- Owner: lycuid
- License: gpl-3.0
- Created: 2021-11-27T17:11:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T17:25:45.000Z (almost 2 years ago)
- Last Synced: 2025-05-03T19:39:43.483Z (about 1 year ago)
- Topics: c, cluless, statusbar, x11, xorg
- Language: C
- Homepage:
- Size: 499 KB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
cluless statusbar
-----------------
A minialistic, lightweight, customizable statusbar (formerly *xdbar*), inspired by [xmobar](https://xmobar.org/) and [dwm](https://dwm.suckless.org/)'s statusbar, for X11 Desktops (wayland in progress), that are compatible with [EWMH](https://specifications.freedesktop.org/wm-spec/latest/) specifications.
Rendering styled/clickable text, is inspired by xmobar's approach of wrapping text in XML like *tags*.
Populating statusbar is inspired by dwm statusbar's approach of using the root window's `WM_NAME` attribute text.
----
Description
-----------
```txt
+ - - - - - - - - - - - - - - - - - margin - - - - - - - - - - - - - - - - - +
¦ +------------------------------------------------------------------------+ ¦
¦ | + - - - - - - - - - - - - - - - padding - - - - - - - - - - - - - - -+ | ¦
¦ | ¦stdin WM_NAME¦ | ¦
¦ | +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + | ¦
¦ +------------------------------------------------------------------------+ ¦
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
```
- ***margin*** is the empty space outside of the bar window.
- ***padding*** is the space between the bar window edges and the drawing region.
- ***stdin*** text is typically provided by the window manager.
- ***WM_NAME*** (of the root window) can be set using the `xsetroot` command.
**Setting `WM_NAME`**
- [slstatus](https://tools.suckless.org/slstatus)
- [smolprog](https://github.com/lycuid/smolprog/) *(my personal script)*
- Custom script example:
```bash
#!/bin/bash
while true; do
xsetroot -name "$(whoami)@$(hostname) on $(uname -o) | $(date)"
sleep 1
done
```
Usage
-----
```txt
USAGE: clubar [OPTIONS]...
OPTIONS:
-h, --help print this help message.
-v, --version print version.
-t, --topbar window position (top/bottom edge of the screen).
-c file, --config[=file]
filepath for runtime configs (supports: lua).
-g values, --geometry[=values]
window geometry as 'x,y,width,height' (eg: '0,0,1280,720').
-p values, --padding[=values]
window padding as 'left,right,top,bot' (eg: '0,0,10,10').
-m values, --margin[=values]
window margin as 'left,right,top,bot' (eg: '0,0,10,10').
-f color, --foreground[=color]
set default foreground color.
-b color, --background[=color]
set default background color.
--fonts[=values]
comma seperated fonts (eg: 'arial-10,monospace-10:bold').
SIGNALS:
USR1: toggle window visibility (e.g. pkill -USR1 clubar).
USR2: Reload configurations from external config file without reloading.
```
Requirements
------------
- ***free***, ***libre*** and ***open source*** Operating System (currently doesn't support \*BSD).
- gnu make
- libx11
- libxft
**Optional**
- pkg-config (if not installed, update `config.mk` accordingly).
- lua (required if using `luaconfig` plugin).
Build
-----
**Default build**
```sh
make
```
**Build with plugins enabled**
```sh
make PLUGINS="luaconfig xrmconfig ..."
```
**Install**
```sh
sudo make install
```
**Available Plugins**
(Note: plugins are just space seperated c filenames, from [plugins](/src/clubar/plugins/) directory, without file extension, see [examples](/examples).)
- **luaconfig**: runtime config support with lua source file.
- **xrmconfig**: runtime config support with X Resources.
Styling text
------------
**Template for styling text**
```text
Text
```
| Tag | Modifiers | Value | Description |
|---------|---------------------------|-------------|---------------------------------------------------|
| Fn | - | Number | Index of 'fonts' array from configs (default: 0) |
| Fg | - | Color | Valid color name |
| Bg | - | Color | Valid color name |
| Box | Left, Right, Top, Bottom | Color:Size | valid color name and size (default: 0) in pixels |
| BtnL | Shift, Ctrl, Super, Alt | Command | Raw command |
| BtnM | Shift, Ctrl, Super, Alt | Command | Raw command |
| BtnR | Shift, Ctrl, Super, Alt | Command | Raw command |
| ScrlU | Shift, Ctrl, Super, Alt | Command | Raw command |
| ScrlD | Shift, Ctrl, Super, Alt | Command | Raw command |
Examples
--------
```xml
Colored text with background.
```
```xml
underlined text.
Boxed in text.
```
```xml
reboot
reboot w/ confirmation
```
```xml
volume
```
Licence:
--------
[GPLv3](https://gnu.org/licenses/gpl.html)