forked from alex-courtis/way-displays
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathway-displays.1
215 lines (215 loc) · 6.13 KB
/
way-displays.1
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
.\" Automatically generated by Pandoc 3.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "WAY-DISPLAYS" "1" "2023/08/29" "way-displays" "User Manuals"
.hy
.SH NAME
.PP
way-displays - Auto Manage Your Wayland Displays
.SH SYNOPSIS
.PP
way-displays [\f[I]OPTIONS\f[R]\&...]
[\f[I]COMMAND\f[R]]
.SH DESCRIPTION
.PP
way-displays manages your wayland displays:
.IP "1." 3
Sets mode:
.RS 4
.IP \[bu] 2
user specified resolution/refresh OR
.IP \[bu] 2
monitor preferred OR
.IP \[bu] 2
highest resolution/refresh
.RE
.IP "2." 3
Enables VRR / adaptive sync
.IP "3." 3
Arranges in a row or a column
.IP "4." 3
Auto scales based on DPI: 96 is a scale of 1
.IP "5." 3
Reacts when displays are plugged/unplugged
.IP "6." 3
Reacts when laptop lid is closed/opened and no other displays connected
.PP
Works out of the box: no configuration required.
.SS Server
.PP
Background process that performs the management.
Configuration is read from a file discovered in order:
.IP
.nf
\f[C]
$XDG_CONFIG_HOME/way-displays/cfg.yaml
$HOME/.config/way-displays/cfg.yaml
/usr/local/etc/way-displays/cfg.yaml
/etc/way-displays/cfg.yaml
\f[R]
.fi
.PP
The file may be specified via the \f[V]--config\f[R] option.
.PP
cfg.yaml will be monitored for changes, which will be immediately applied.
.PP
See the default /etc/way-displays/cfg.yaml and https://github.com/alex-courtis/way-displays/blob/master/doc/CONFIGURATION.md for details on individual configurable settings.
.PP
Server is run when no commands are specified.
.PP
Server responds to IPC requests to fetch and mutate state: https://github.com/alex-courtis/way-displays/blob/master/doc/IPC.md
.SS Client
.PP
Manages the server.
The active configuration and display state may be inspected, and the configuration modified.
.PP
The active configuration can be written to disk, however any comments and formatting will be lost.
.SH REQUIREMENTS
.PP
way-displays is known to work on the sway and river compositors.
It may work on any wlroots compositor that supports the WLR Output Management protocol.
.PP
The user must be a member of the \f[V]input\f[R] group.
.SH OPTIONS
.TP
\f[V]-L\f[R] | \f[V]--l[og-threshold]\f[R] <\f[I]debug\f[R]|\f[I]info\f[R]|\f[I]warning\f[R]|\f[I]error\f[R]>
Overrides cfg.yaml.
\f[I]info\f[R] is default.
.TP
\f[V]-c\f[R] | \f[V]--c[onfig]\f[R] <\f[I]path\f[R]>
Configuration file, falls back to defaults if not found.
.TP
\f[V]-y\f[R] | \f[V]--y[aml]\f[R]
Print client output as raw YAML
.SH COMMANDS
.TP
\f[V]-h\f[R] | \f[V]--h[elp]\f[R]
Print usage and exit.
.TP
\f[V]-v\f[R] | \f[V]--v[ersion]\f[R]
Display version information and exit.
.TP
\f[V]-g\f[R] | \f[V]--g[et]\f[R]
Show the active configuration, commands and current display state.
.TP
\f[V]-s\f[R] | \f[V]--s[et]\f[R]
Add a new setting or modify an existing.
.RS
.TP
\f[V]ARRANGE_ALIGN\f[R] <\f[I]row\f[R]|\f[I]column\f[R]> <\f[I]top\f[R]|\f[I]middle\f[R]|\f[I]bottom\f[R]|\f[I]left\f[R]|\f[I]right\f[R]>
Set vertical arrangement and the alignment.
.TP
\f[V]ORDER\f[R] <\f[I]name\f[R]|!\f[I]regex\f[R]> \&...
Set the order of arrangement.
Replaces previous order.
.TP
\f[V]SCALING\f[R] <\f[I]on\f[R]|\f[I]off\f[R]>
Enable scaling, overrides AUTO_SCALE and SCALE
.TP
\f[V]AUTO_SCALE\f[R] <\f[I]on\f[R]|\f[I]off\f[R]>
Enable auto scaling.
.TP
\f[V]SCALE\f[R] <\f[I]name\f[R]> <\f[I]scale\f[R]>
Set the scale for a specific display.
.TP
\f[V]MODE\f[R] <\f[I]name\f[R]> MAX
Highest available resolution / refresh.
.TP
\f[V]MODE\f[R] <\f[I]name\f[R]> <\f[I]width\f[R]> <\f[I]height\f[R]> [<\f[I]Hz\f[R]>]
Specified resolution at its highest refresh.
Optional refresh will choose a mode +-0.5Hz.
.TP
\f[V]TRANSFORM\f[R] <\f[I]name\f[R]> <\f[I]90\f[R]|\f[I]180\f[R]|\f[I]270\f[R]|\f[I]flipped\f[R]|\f[I]flipped-90\f[R]|\f[I]flipped-180\f[R]|\f[I]flipped-270\f[R]>
Transform a specific display.
.TP
\f[V]VRR_OFF\f[R] <\f[I]name\f[R]>
Disable VRR for a display.
.TP
\f[V]DISABLED\f[R] <\f[I]name\f[R]>
Disable a display.
.RE
.TP
\f[V]-d\f[R], \f[V]--d[elete]\f[R]
Remove an existing setting.
.RS
.TP
\f[V]SCALE\f[R] <\f[I]name\f[R]>
Use auto scaling for the display, if enabled.
.TP
\f[V]MODE\f[R] <\f[I]name\f[R]>
Use preferred or highest availble if no preferred.
.TP
\f[V]TRANSFORM\f[R] <\f[I]name\f[R]>
Remove transformation for a display.
.TP
\f[V]VRR_OFF\f[R] <\f[I]name\f[R]>
Enable VRR for a display.
.TP
\f[V]DISABLED\f[R] <\f[I]name\f[R]>
Enable a display.
.RE
.TP
\f[V]-w\f[R] | \f[V]--w[rite]\f[R]
Write active configuration to cfg.yaml; removes any whitespace or comments.
.SH NAMING
.PP
You can configure displays by name or description.
You can find these by looking at the logs e.g.
.IP
.nf
\f[C]
DP-3 Arrived:
info:
name: \[aq]DP-3\[aq]
make: \[aq]Monitor Maker\[aq]
model: \[aq]ABC123\[aq]
desc: \[aq]Monitor Maker ABC123 (DP-3 via HDMI)\[aq]
\f[R]
.fi
.PP
It is recommended to use the description rather than the name, as the name may change over time and will most likely be different on different PCs.
.PP
The description does contain information about how it is connected, so strip that out.
In the above example, you would use the description `Monitor Maker ABC123'.
.PP
The name should be at least 3 characters long, to avoid any unwanted extra matches.
.SH EXAMPLES
.TP
exec \f[V]way-displays\f[R] > /tmp/way-displays.${XDG_VTNR}.${USER}.log 2>&1
Add to your sway config to start way-displays when sway starts.
.TP
\f[V]way-displays\f[R] -g
Show current configuration and display state.
.TP
\f[V]way-displays\f[R] -s \f[V]ARRANGE_ALIGN\f[R] \f[I]row\f[R] \f[I]bottom\f[R]
Arrange left to right, aligned at the bottom.
.TP
\f[V]way-displays\f[R] -s \f[V]ORDER\f[R] \[dq]!\[ha]DP-[0-9]+$\[dq] HDMI-1 \[dq]monitor maker ABC model XYZ\[dq] eDP-1
Set the order for arrangement.
.TP
\f[V]way-displays\f[R] -s \f[V]SCALE\f[R] \[dq]eDP-1\[dq] 3
Set the scale.
.TP
\f[V]way-displays\f[R] -s \f[V]MODE\f[R] HDMI-A-1 3840 2160 24
Use 3840x2160\[at]24Hz
.TP
\f[V]way-displays\f[R] -w
Persist your changes to your cfg.yaml
.SH SEE ALSO
.PP
https://github.com/alex-courtis/way-displays
.SH AUTHORS
Alexander Courtis.