]> Skullheadx's Git Forge - slstatus.git/commitdiff
manpage: Quality improvements
authordrkhsh <me@drkhsh.at>
Sun, 23 Apr 2023 21:43:14 +0000 (23:43 +0200)
committerdrkhsh <me@drkhsh.at>
Sun, 23 Apr 2023 21:43:14 +0000 (23:43 +0200)
Adds signals section to the manpage and generally improves contents and
wording

slstatus.1

index d802037355f6a05a2c565883c92c9aa65dc35f5f..bea2a8ca3524c216d671d5d7b2026d4021b7626d 100644 (file)
@@ -1,17 +1,22 @@
-.Dd 2020-06-23
+.Dd 2023-04-23
 .Dt SLSTATUS 1
 .Os
 .Sh NAME
 .Nm slstatus
-.Nd suckless status monitor
+.Nd suckless status
 .Sh SYNOPSIS
 .Nm
 .Op Fl s
 .Op Fl 1
 .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.
+is a small tool for providing system status information to other programs
+over the EWMH
+.Em WM_NAME
+property of the root window (used by
+.Xr dwm 1 ) or standard input/output. It is designed to be as efficient as possible by
+only issuing the minimum of system calls required.
+.P
 By default,
 .Nm
 outputs to WM_NAME.
@@ -26,3 +31,15 @@ Write once to stdout and quit.
 .Nm
 can be customized by creating a custom config.h and (re)compiling the source
 code. This keeps it fast, secure and simple.
+.Sh SIGNALS
+.Nm
+responds to the following signals:
+.Pp
+.Bl -tag -width TERM -compact
+.It USR1
+Triggers an instant redraw.
+.El
+.Sh AUTHORS
+See the LICENSE file for the authors.
+.Sh SEE ALSO
+.Xr dwm 1