summaryrefslogtreecommitdiff
path: root/slstatus.1
diff options
context:
space:
mode:
authorLaslo Hunhold <dev@frign.de>2017-08-10 21:36:29 +0200
committerAaron Marcher <me@drkhsh.at>2017-08-10 22:32:28 +0200
commit958c34052a13b964f5fd1e748c18796d155af7db (patch)
treeb4c0a00fa2293f8ac2c532c567757b4c76187fc3 /slstatus.1
parent8dad4910bfc75aa1085a20de95ceee951588deae (diff)
Convert slstatus.1 to mandoc, simplify it and remove -h
We also change the semantics of -v to only return the version information. There is now no need for usage() to exit with anything other than 1.
Diffstat (limited to 'slstatus.1')
-rw-r--r--slstatus.168
1 files changed, 36 insertions, 32 deletions
diff --git a/slstatus.1 b/slstatus.1
index de5d0e8..bc27271 100644
--- a/slstatus.1
+++ b/slstatus.1
@@ -1,34 +1,38 @@
-.TH SLSTATUS 1 slstatus
-.SH NAME
-slstatus \- suckless status
-.SH SYNOPSIS
-.B slstatus
-.RB [ \-dhov ]
-.SH DESCRIPTION
-slstatus is a suckless and lightweight status monitor for window managers that use WM_NAME as statusbar (e.g. DWM) or any other status bars as long as they support reading from stdin. It is written in pure C without any extern programs being executed and only reads from files most of the time. slstatus is meant to be a better alternative to Bash scripts (inefficient) and Conky (bloated and written in C++).
-.SH OPTIONS
-.TP
-.B \-d
-run slstatus as daemon in background
-.TP
-.B \-h
-display help
-.TP
-.B \-o
-output continuously to console instead of WM_NAME
-.TP
-.B \-n
-output to console once and exit
-.TP
-.B \-v
-display version and copyright details
-.SH CUSTOMIZATION
-.B slstatus
+.Dd 2017-08-10
+.Dt SLSTATUS 1
+.Os suckless.org
+.Sh NAME
+.Nm slstatus
+.Nd suckless status monitor
+.Sh SYNOPSIS
+.Nm
+.Oo
+.Op Fl v
+|
+.Oo
+.Op Fl d
+.Op Fl o | n
+.Oc
+.Oc
+.Sh DESCRIPTION
+.Nm
+is a suckless status monitor for window managers that use WM_NAME (e.g. dwm) or
+stdin to fill the status bar.
+By default,
+.Nm
+outputs to WM_NAME.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl d
+Daemonize.
+.It Fl n
+Write to stdout once and exit.
+.It Fl o
+Write to stdout continuously.
+.It Fl v
+Write version information to stdout and exit.
+.El
+.Sh CUSTOMIZATION
+.Nm
can be customized by creating a custom config.h and (re)compiling the source
code. This keeps it fast, secure and simple.
-.SH AUTHORS
-See the LICENSE file for the authors.
-.SH LICENSE
-See the LICENSE file for the terms of redistribution.
-.SH BUGS
-See the FIXME's in the code.