You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
103 lines
3.2 KiB
103 lines
3.2 KiB
# i3blocks-gaps
|
|
|
|
This repository is a fork of [i3blocks](https://github.com/vivien/i3blocks) made to be compatible with [i3-gaps](https://github.com/Airblader/i3), itself a fork of i3wm.
|
|
|
|
***
|
|
|
|
i3blocks is a highly flexible **status line** for the [i3](http://i3wm.org)
|
|
window manager. It handles *clicks*, *signals* and *language-agnostic* user
|
|
*scripts*.
|
|
|
|
The content of each *block* (e.g. time, battery status, network state, ...) is
|
|
the output of a *command* provided by the user. Blocks are updated on *click*,
|
|
at a given *interval* of time or on a given *signal*, also specified by the
|
|
user.
|
|
|
|
It aims to respect the
|
|
[i3bar protocol](http://i3wm.org/docs/i3bar-protocol.html), providing
|
|
customization such as text alignment, urgency, color, and more.
|
|
|
|
- - -
|
|
|
|
Here is an example of status line, showing the time updated every 5 seconds,
|
|
the volume updated only when i3blocks receives a SIGRTMIN+1, and click events.
|
|
|
|
```` ini
|
|
[volume]
|
|
label=Volume:
|
|
command=amixer get Master | grep -E -o '[0-9]{1,3}?%' | head -1
|
|
interval=once
|
|
signal=1
|
|
# use 'pkill -RTMIN+1 i3blocks' after changing the volume
|
|
|
|
[time]
|
|
command=date '+%D %T'
|
|
interval=5
|
|
|
|
[clickme]
|
|
full_text=Click me!
|
|
command=echo button=$BLOCK_BUTTON x=$BLOCK_X y=$BLOCK_Y
|
|
min_width=button=1 x=1366 y=768
|
|
align=left
|
|
````
|
|
|
|
You can use your own scripts, or the
|
|
[ones](https://github.com/Airblader/i3blocks-gaps/tree/master/scripts) provided with
|
|
i3blocks. Many [community-contributed scripts](https://github.com/vivien/i3blocks-contrib) are also available. Feel free to contribute and improve them!
|
|
|
|
The default config will look like this:
|
|
|
|
|
|
|
|
The scripts provided by default may use external tools:
|
|
|
|
* `mpstat` (often provided by the *sysstat* package) used by `cpu_usage`.
|
|
* `acpi` (often provided by a package of the same name) used by `battery`.
|
|
|
|
The user contributed scripts may also use external tools:
|
|
|
|
* `playerctl` (available [here](https://github.com/acrisci/playerctl)) used by `mediaplayer`.
|
|
* `sensors` (often provided by the *lm-sensors* package) used by `temperature`.
|
|
|
|
## Documentation
|
|
|
|
For more information about how it works, please refer to the
|
|
[**manpage**](http://vivien.github.io/i3blocks).
|
|
|
|
You can also take a look at the
|
|
[i3bar protocol](http://i3wm.org/docs/i3bar-protocol.html) to see what
|
|
possibilities it offers you.
|
|
|
|
Take a look at the [wiki](https://github.com/vivien/i3blocks/wiki) for examples
|
|
of blocks and screenshots. If you want to share your ideas and status line,
|
|
feel free to edit it!
|
|
|
|
## Installation
|
|
|
|
Install i3blocks-gaps from source:
|
|
|
|
$ git clone https://github.com/Airblader/i3blocks-gaps i3blocks
|
|
$ cd i3blocks
|
|
$ make clean debug # or make clean all
|
|
# make install
|
|
|
|
Note: the generation of the manpage requires the `pandoc` utility, packaged in
|
|
common distributions as `pandoc`.
|
|
|
|
### Usage
|
|
|
|
* Set your `status_command` in a bar block of your i3 config file:
|
|
|
|
bar {
|
|
status_command i3blocks
|
|
}
|
|
|
|
* For customization, copy the default i3blocks.conf into ~/.i3blocks.conf
|
|
(e.g. `cp /etc/i3blocks.conf ~/.i3blocks.conf`)
|
|
* Restart i3 (e.g. `i3-msg restart`)
|
|
|
|
## Copying
|
|
|
|
i3blocks is Copyright (C) 2014 Vivien Didelot<br />
|
|
See the file COPYING for information of licensing and distribution.
|