em/slstatus
1
0
Fork 0
Code Releases Activity
master
slstatus/slstatus.1

48 lines
965 B
Groff
Raw Permalink Normal View History

manpage: Quality improvements Adds signals section to the manpage and generally improves contents and wording
2023-04-23 23:43:14 +02:00
.Dd 2023-04-23
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.
2017-08-10 21:36:29 +02:00
.Dt SLSTATUS 1
Fix man page .Os field
2017-08-13 23:25:44 +02:00
.Os
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.
2017-08-10 21:36:29 +02:00
.Sh NAME
.Nm slstatus
manpage: Quality improvements Adds signals section to the manpage and generally improves contents and wording
2023-04-23 23:43:14 +02:00
.Nd suckless status
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.
2017-08-10 21:36:29 +02:00
.Sh SYNOPSIS
.Nm
Remove o-flag as it is redundant Even if we extend the flag to be an n-flag with a numerical input, we already have other Unix-tools to take care of us much more flexibly, e.g. with head(1) you can easily get the first 10 outputs with slstatus -s | head -n 10, but also e.g. discard the first one and then get the consecutive 10 outputs. For the X11-root-window-name, you can limit the runtime with timeout(1) or a comparable solution. This reverts commit fa8b939990ed0648f99b0cbeba4efed807160db3.
2018-05-21 21:31:53 +02:00
.Op Fl s
Add a -1 option flag Allow slstatus to be used by programs that can grab status by calling an external program on a periodic basis (e.g. tmux)
2020-06-23 22:35:43 +02:00
.Op Fl 1
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.
2017-08-10 21:36:29 +02:00
.Sh DESCRIPTION
.Nm
manpage: Quality improvements Adds signals section to the manpage and generally improves contents and wording
2023-04-23 23:43:14 +02:00
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
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.
2017-08-10 21:36:29 +02:00
By default,
.Nm
outputs to WM_NAME.
.Sh OPTIONS
.Bl -tag -width Ds
Add back version flag to prepare for release
2023-05-15 19:14:52 +02:00
.It Fl v
Print version information to stderr, then exit.
Reduce -o | -n to -s What we really want is to either output to WM_NAME or stdout. If we want just one single line, we do slstatus | head -n 1.
2017-08-10 22:22:39 +02:00
.It Fl s
Write to stdout instead of WM_NAME.
Add a -1 option flag Allow slstatus to be used by programs that can grab status by calling an external program on a periodic basis (e.g. tmux)
2020-06-23 22:35:43 +02:00
.It Fl 1
Write once to stdout and quit.
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.
2017-08-10 21:36:29 +02:00
.El
.Sh CUSTOMIZATION
.Nm
added man page
2016-09-17 22:51:59 +02:00
can be customized by creating a custom config.h and (re)compiling the source
code. This keeps it fast, secure and simple.
manpage: Quality improvements Adds signals section to the manpage and generally improves contents and wording
2023-04-23 23:43:14 +02:00
.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
Copy Permalink