aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 94775268dcc6a23af2bb6d92c4f4ea7fa5e37a52 (plain) (blame)
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
<!-- vi: tw=80
  -->

mstatus
=======
`mstatus` is a minimal status bar intended for the DWM window manager but which
also works on other window managers; I use it on Sway, for instance.  The status
bar is comprised of a sequence of “blocks” which can be created, modifed, and
removed at will by writing commands to a named pipe.

For usage instructions see the `mstatus(1)` manual page.  This can either be
done by running `man -l mstatus.1`, or `man mstatus` if you have already
installed the program.  Online documentation is also available [here][1]


Installation
============
Assuming you have cloned the repo, you can install the status bar and manual
page in two commands.

```sh
$ make
$ make install  # Will require root permissions
```

If you are installing `mstatus` for usage in DWM, then the installation is
slightly different:

```sh
$ make HAS_DWM=true
$ make install  # Will require root permissions
```

[1]: https://thomasvoss.com/man/mstatus.1.html