aboutsummaryrefslogtreecommitdiffstats
path: root/wmsl.1
blob: b592866d25b6bf2c7eb625b6fefb3f846ec8997a (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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.TH WMSL 1 "January 2026" "wmsl" "User Commands"
.SH NAME
wmsl \- Window Manager Status Line
.SH SYNOPSIS
.B wmsl
[\fB\-C\fR \fIFILE\fR]
[\fB\-h\fR]
.SH DESCRIPTION
.B wmsl
is a simple and efficient status line program for window managers like dwm.
It updates the X root window name with status information from configured block scripts.
.PP
Blocks can be updated on a timer interval or manually triggered via signals using
.BR sigwmsl (1).
.SH OPTIONS
.TP
.BR \-C " " \fIFILE\fR
Specify an alternate configuration file. Default is
.IR $HOME/.config/wmsl/wmslrc .
.TP
.BR \-h
Display usage information and exit.
.SH CONFIGURATION
The configuration file uses a simple line-based format. Each line is one of:
.TP
.BI delim= STRING
Set the delimiter between blocks (default: " | ").
.TP
.BI prefix= STRING
Set the prefix before all blocks (default: "").
.TP
.BI suffix= STRING
Set the suffix after all blocks (default: " ").
.TP
.BI block= COMMAND
Define a new block that executes the given command.
.TP
.BI block-id= ID
Set the block ID for the current block (used with
.BR sigwmsl ).
A block-id of 0 means the block cannot be manually triggered.
.TP
.BI block-sleep= SECONDS
Set the update interval in seconds for the current block.
A value of 0 means the block only updates when manually triggered.
.PP
Lines starting with # are comments. Empty lines are ignored.
.SH EXAMPLE CONFIGURATION
.nf
# ~/.config/wmsl/wmslrc
delim= |
prefix=
suffix=

block=wmsl-ip
block-id=3
block-sleep=60

block=wmsl-battery
block-id=2
block-sleep=10

block=wmsl-time
block-id=1
block-sleep=1
.fi
.SH FILES
.TP
.I ~/.config/wmsl/wmslrc
Default configuration file.
.TP
.I /tmp/wmsl.pid
PID file for signal-based updates.
.SH SIGNALS
.TP
.B SIGUSR1
Trigger a specific block update (use
.BR sigwmsl (1)
for this).
.TP
.BR SIGINT ", " SIGTERM
Clean up and exit gracefully.
.SH SEE ALSO
.BR sigwmsl (1)
.SH AUTHORS
Written for use with dwm and similar window managers.
.SH BUGS
Report bugs to the project repository.