README.md (1310B)
1 status 2 ====== 3 4 A status line program for dwm. 5 6 Overview 7 -------- 8 The status line is made up of individual "blocks". Blocks update 9 based on a timer interval or an inotify CLOSE_WRITE notification. 10 Each block has an `_init()` function which is called once at startup 11 which facilitates the creation and initialization of any static 12 data and any needed registration with inotify. Afterwords a blocks 13 '_update()' function is called on every program tick with a `dt` 14 value and is expected to return with a true or false value based 15 on if they updated or not. Blocks being called from the inotify 16 event dispatcher are passed the special value `dt = 0`. This way 17 blocks are free to determine for themselves when they should update. 18 19 Installation 20 ------------ 21 22 Copy `config.def.h` to `config.h` and modify to your liking then to build: 23 24 ``` 25 ./build.sh 26 ``` 27 28 Then copy `status` to wherever you want. 29 30 Usage 31 ----- 32 33 Run `status` to launch in the background. Alternatively, launch to 34 the foreground with `status -d`. When running in the foreground 35 `status` prints to `stdout` instead of setting the X root window 36 name. 37 38 Gotchas 39 ------- 40 41 * alsalib is horribly broken. Don't compile with optimizations more 42 exotic than `-O2` and expect alsa to work. If you aren't using alsa 43 then you can use whatever meme flags you want.