1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
# i3blocks
[](https://travis-ci.org/vivien/i3blocks)
[](https://gitter.im/vivien/i3blocks?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
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][0-9]?%' | 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/vivien/i3blocks/tree/master/scripts) provided with
i3blocks. 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
i3blocks may already be packaged for your distribution:
* Archlinux: [i3blocks](https://aur.archlinux.org/packages/i3blocks) and
[i3blocks-git](https://aur.archlinux.org/packages/i3blocks-git) AURs.
* Gentoo: [ebuild](https://github.com/Sabayon-Labs/spike-community-overlay/tree/master/x11-misc/i3blocks)
* Debian: [i3blocks](https://packages.debian.org/i3blocks) and Ubuntu: [i3blocks](http://packages.ubuntu.com/i3blocks)
Or you may install i3blocks from source:
$ git clone git://github.com/vivien/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
* 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.
|
