commit 385193b
wf
·
2026-04-04 09:46:00 +0000 UTC
parent daa8175
Minor manpage changes
2 files changed,
+272,
-241
+111,
-100
1@@ -4,7 +4,7 @@
2 .SH "NAME"
3 \fBhowlc\fR \- client to control the howl compositor
4 .SH "SYNOPSIS"
5-\fBhowlc\fR \fIcmd\fR [\fIargs\|\.\|\.\|\.\fR]
6+\fBhowlc\fR \fIcmd\fR [\fIargs\fR\|\.\|\.\|\.]
7 .SH "DESCRIPTION"
8 \fBhowlc\fR is a client that controls the howl compositor\.
9 .SH "COMMANDS"
10@@ -13,170 +13,179 @@
11 Will move the window relative to either its current position or to the top left corner of the screen\. Arguments are in the form of pairs of x and y integer coordinates\.
12 .IP
13 Example:
14-.IP "" 4
15-.nf
16-$ howlc move 20 \-40 # Shift the window 20px forward and 40px up relative to its position
17-$ howlc move_absolute 300 300 # Move the window to absolute coordinates [300, 300]
18-.fi
19-.IP "" 0
20-
21+.IP
22+# Shift the window 20px forward and 40px up
23+.br
24+$ howlc move 20 \-40
25+.IP
26+# Move the window to absolute coordinates [300, 300]
27+.br
28+$ howlc move_absolute 300 300
29 .TP
30 \fBresize\fR, \fBresize_absolute\fR
31 Will resize the window relative to either its current position or the top left corner of the screen\. Arguments are in the form of pairs of w and h integers\.
32 .IP
33 Example:
34-.IP "" 4
35-.nf
36-$ howlc resize 20 \-40 # Grow the window 20px forward and shrink it 40px up relative to its size
37-$ howlc resize_absolute 300 300 # Resize the window to the absolute size [300, 300]
38-.fi
39-.IP "" 0
40-
41+.IP
42+# Grow the window 20px forward and shrink it 40px up
43+.br
44+$ howlc resize 20 \-40
45+.IP
46+# Resize the window to the absolute size [300, 300]
47+.br
48+$ howlc resize_absolute 300 300
49 .TP
50 \fBteleport\fR
51 Will "teleport" (move and resize) the window to the coordinates specified, in the format of x, y, w and h\.
52 .IP
53 Example:
54-.IP "" 4
55-.nf
56-$ howlc teleport 50 25 200 250 # Teleport the window to [50, 25] and resize it to [200, 250]
57-.fi
58-.IP "" 0
59-
60+.IP
61+# Move the window to [50, 25] and resize it to [200, 250]
62+.br
63+$ howlc teleport 50 25 200 250
64 .TP
65 \fBcenter\fR
66 Will position the window in the center of the screen\.
67 .IP
68 Example:
69-.IP "" 4
70-.nf
71-$ howlc center # Move the window to the center of the screen
72-.fi
73-.IP "" 0
74-
75+.IP
76+# Move the window to the center of the screen
77+.br
78+$ howlc center
79 .TP
80 \fBfullscreen\fR
81 Will resize the window to the screen size\.
82 .IP
83 Example:
84-.IP "" 4
85-.nf
86-$ howlc fullscreen # Put the window in fullscreen mode
87-.fi
88-.IP "" 0
89-
90+.IP
91+# Put the window in fullscreen mode
92+.br
93+$ howlc fullscreen
94 .TP
95 \fBhide\fR, \fBshow\fR
96 Hide/show the current window\. Currently these don't have much use\.
97 .IP
98 Example:
99-.IP "" 4
100-.nf
101-$ howlc hide # Hide (unmap) the current window
102-$ howlc show # And now show (map) it
103-.fi
104-.IP "" 0
105-
106+.IP
107+# Hide (unmap) the current window
108+.br
109+$ howlc hide
110+.IP
111+# And now show (map) it
112+.br
113+$ howlc show
114 .TP
115 \fBclose\fR
116 Closes the window\.
117 .IP
118 Example:
119-.IP "" 4
120-.nf
121-$ howlc close # Close the current window
122-.fi
123-.IP "" 0
124-
125+.IP
126+# Close the current window
127+.br
128+$ howlc close
129 .TP
130 \fBworkspace\fR, \fBmove_workspace\fR
131 Switch, or move the current window, to the specified workspace\. Argument is a single integer representing the workspace number\.
132 .IP
133 Example:
134-.IP "" 4
135-.nf
136-$ howlc workspace 3 # Switch to the 3rd workspace
137-$ howlc move_workspace 6 # Move the current window to the 6th workspace
138-.fi
139-.IP "" 0
140-
141+.IP
142+# Switch to the 3rd workspace
143+.br
144+$ howlc workspace 3
145+.IP
146+# Move the current window to the 6th workspace
147+.br
148+$ howlc move_workspace 6
149 .TP
150 \fBget_geometry\fR, \fBget_pid\fR, \fBget_title\fR, \fBget_app_id\fR
151-Print the current window's geometry (in x, y, w and h), process ID, title or app ID\. These are practically non\-operational right now\.
152+Print the current window's geometry (in x, y, w and h), process ID, title or app ID\. These are practically non\-operational right now, see \fIBUGS\fR\.
153 .IP
154 Example:
155-.IP "" 4
156-.nf
157-$ howlc get_geometry # Get the current window's geometry
158+.IP
159+# Get the current window's geometry
160+.br
161+$ howlc get_geometry
162+.br
163 327 148 620 620
164-$ howlc get_pid # Get the current window's process ID
165+.IP
166+# Get the current window's process ID
167+.br
168+$ howlc get_pid
169+.br
170 12345
171-$ howlc get_title # Get the current window's title
172+.IP
173+# Get the current window's title
174+.br
175+$ howlc get_title
176+.br
177 Example
178-$ howlc get_app_id # Get the current window's app ID
179+.IP
180+# Get the current window's app ID
181+.br
182+$ howlc get_app_id
183+.br
184 example
185-.fi
186-.IP "" 0
187-
188 .TP
189 \fBbind\fR
190-Create a key binding\. Arguments are in the form of a list of keys and the command to execute, see the BINDINGS section for more info\.
191+Create a key binding\. Arguments are in the form of a list of keys and the command to execute, see the \fIBINDINGS\fR section for more info\.
192 .IP
193 Example:
194-.IP "" 4
195-.nf
196-$ howlc bind mod+shift+g "example_command" # Bind modkey+Shift+g to execute "example_command"
197-$ howlc bind win+4 "howlc workspace 4" # Bind Win+4 to switch to the 4th workspace
198-.fi
199-.IP "" 0
200-
201+.IP
202+# Bind modkey+Shift+g to execute "example_command"
203+.br
204+$ howlc bind mod+shift+g "example_command"
205+.IP
206+# Bind Win+4 to switch to the 4th workspace
207+.br
208+$ howlc bind win+4 "howlc workspace 4"
209 .TP
210 \fBmodkey\fR
211-Configure the modifier key\. This can be then used as an alias in keybindings, like so: \fBmod+key\fR\. See the BINDINGS section for allowed values\.
212+Configure the modifier key\. This can be then used as an alias in keybindings, like so: \fBmod+key\fR\. See the \fIBINDINGS\fR section for allowed values\.
213 .IP
214 Example:
215-.IP "" 4
216-.nf
217-$ howlc modkey alt # Configure the modifier key to Alt
218-$ howlc modkey win+ctrl # Configure the modifier key to Win+Ctrl
219-.fi
220-.IP "" 0
221-
222+.IP
223+# Configure the modifier key to Alt
224+.br
225+$ howlc modkey alt
226+.IP
227+# Configure the modifier key to Win+Ctrl
228+.br
229+$ howlc modkey win+ctrl
230 .TP
231 \fBfocus_color\fR, \fBunfocus_color\fR
232 Set the focused and unfocused colors of the window borders\. Arguments are in the format of #RRGGBB, where the leading pound sign is optional\. Note that in the format of #RRGGBB, the argument needs to be quoted, since the pound sign (#) is a special one in most shells\.
233 .IP
234 Example:
235-.IP "" 4
236-.nf
237-$ howlc focus_color "#f03937" # Set the focused color to a shade of red
238-$ howlc unfocus_color eeeeee # Set the unfocused color to a bright white
239-.fi
240-.IP "" 0
241-
242+.IP
243+# Set the focused color to a shade of red
244+.br
245+$ howlc focus_color "#f03937"
246+.IP
247+# Set the unfocused color to a bright white
248+.br
249+$ howlc unfocus_color eeeeee
250 .TP
251 \fBborder_width\fR
252 Set the window's border width\. Argument is a single integer representing the new border width\.
253 .IP
254-Examples:
255-.IP "" 4
256-.nf
257-$ howlc border_width 4 # Set the border width to 4px
258-$ howlc border_width 0 # Set the border width to 0px, essentially disabling borders
259-.fi
260-.IP "" 0
261-
262+Example:
263+.IP
264+# Set the border width to 4px
265+.br
266+$ howlc border_width 4
267+.IP
268+# Set the border width to 0px, essentially disabling borders
269+.br
270+$ howlc border_width 0
271 .TP
272 \fBquit\fR
273 Quit the compositor\.
274 .IP
275 Example:
276-.IP "" 4
277-.nf
278-$ howlc quit # Terminate the Wayland display, cleanup and exit
279-.fi
280-.IP "" 0
281-
282+.IP
283+# Terminate the Wayland display, cleanup and exit
284+.br
285+$ howlc quit
286 .SH "BINDINGS"
287 The format for keybindings is the following:
288 .P
289@@ -200,6 +209,8 @@ The accepted key strings are as specified in \fB<xkbcommon/xkbcommon\-keysyms\.h
290 The \fBget_*\fR functions are useless since they print the needed information to the compositor's controlling terminal\.
291 .P
292 The manual does not specify the names for modifiers on other platforms\.
293+.P
294+There is no way to unbind keys\. This is an swc problem, but still deserves to be mentioned here\.
295 .SH "COPYRIGHT"
296 \fBhowl\fR and \fBhowlc\fR are (C) wf 2026 \fIhttps://codeberg\.org/wf\fR\.
297 .SH "SEE ALSO"
+161,
-141
1@@ -1,9 +1,9 @@
2-howlc(1) - client to control the howl compositor
3+howlc(1) -- client to control the howl compositor
4 ================================================
5
6 ## SYNOPSIS
7
8-`howlc` *cmd* [*args...*]
9+`howlc` <cmd> [<args>...]
10
11 ## DESCRIPTION
12
13@@ -11,145 +11,165 @@ howlc(1) - client to control the howl compositor
14
15 ## COMMANDS
16
17- * `move`, `move_absolute`:
18- Will move the window relative to either its current position or to the top
19- left corner of the screen. Arguments are in the form of pairs of x and y
20- integer coordinates.
21-
22- Example:
23-
24- ```
25- $ howlc move 20 -40 # Shift the window 20px forward and 40px up relative to its position
26- $ howlc move_absolute 300 300 # Move the window to absolute coordinates [300, 300]
27- ```
28-
29-
30- * `resize`, `resize_absolute`:
31- Will resize the window relative to either its current position or the top
32- left corner of the screen. Arguments are in the form of pairs of w and h
33- integers.
34-
35- Example:
36- ```
37- $ howlc resize 20 -40 # Grow the window 20px forward and shrink it 40px up relative to its size
38- $ howlc resize_absolute 300 300 # Resize the window to the absolute size [300, 300]
39- ```
40-
41- * `teleport`:
42- Will "teleport" (move and resize) the window to the coordinates specified, in
43- the format of x, y, w and h.
44-
45- Example:
46- ```
47- $ howlc teleport 50 25 200 250 # Teleport the window to [50, 25] and resize it to [200, 250]
48- ```
49-
50- * `center`:
51- Will position the window in the center of the screen.
52-
53- Example:
54- ```
55- $ howlc center # Move the window to the center of the screen
56- ```
57-
58- * `fullscreen`:
59- Will resize the window to the screen size.
60-
61- Example:
62- ```
63- $ howlc fullscreen # Put the window in fullscreen mode
64- ```
65-
66- * `hide`, `show`:
67- Hide/show the current window. Currently these don't have much use.
68-
69- Example:
70- ```
71- $ howlc hide # Hide (unmap) the current window
72- $ howlc show # And now show (map) it
73- ```
74-
75- * `close`:
76- Closes the window.
77-
78- Example:
79- ```
80- $ howlc close # Close the current window
81- ```
82-
83- * `workspace`, `move_workspace`:
84- Switch, or move the current window, to the specified workspace. Argument is a single
85- integer representing the workspace number.
86-
87- Example:
88- ```
89- $ howlc workspace 3 # Switch to the 3rd workspace
90- $ howlc move_workspace 6 # Move the current window to the 6th workspace
91- ```
92-
93- * `get_geometry`, `get_pid`, `get_title`, `get_app_id`:
94- Print the current window's geometry (in x, y, w and h), process ID, title or app ID.
95- These are practically non-operational right now.
96-
97- Example:
98- ```
99- $ howlc get_geometry # Get the current window's geometry
100- 327 148 620 620
101- $ howlc get_pid # Get the current window's process ID
102- 12345
103- $ howlc get_title # Get the current window's title
104- Example
105- $ howlc get_app_id # Get the current window's app ID
106- example
107- ```
108-
109- * `bind`:
110- Create a key binding. Arguments are in the form of a list of keys and the command to execute,
111- see the BINDINGS section for more info.
112-
113- Example:
114- ```
115- $ howlc bind mod+shift+g "example_command" # Bind modkey+Shift+g to execute "example_command"
116- $ howlc bind win+4 "howlc workspace 4" # Bind Win+4 to switch to the 4th workspace
117- ```
118-
119- * `modkey`:
120- Configure the modifier key. This can be then used as an alias in keybindings, like so: `mod+key`.
121- See the BINDINGS section for allowed values.
122-
123- Example:
124- ```
125- $ howlc modkey alt # Configure the modifier key to Alt
126- $ howlc modkey win+ctrl # Configure the modifier key to Win+Ctrl
127- ```
128-
129- * `focus_color`, `unfocus_color`:
130- Set the focused and unfocused colors of the window borders. Arguments are in the format of #RRGGBB,
131- where the leading pound sign is optional. Note that in the format of #RRGGBB, the argument needs to
132- be quoted, since the pound sign (#) is a special one in most shells.
133-
134- Example:
135- ```
136- $ howlc focus_color "#f03937" # Set the focused color to a shade of red
137- $ howlc unfocus_color eeeeee # Set the unfocused color to a bright white
138- ```
139-
140- * `border_width`:
141- Set the window's border width. Argument is a single integer representing the new border width.
142-
143- Examples:
144- ```
145- $ howlc border_width 4 # Set the border width to 4px
146- $ howlc border_width 0 # Set the border width to 0px, essentially disabling borders
147- ```
148-
149- * `quit`:
150- Quit the compositor.
151-
152- Example:
153- ```
154- $ howlc quit # Terminate the Wayland display, cleanup and exit
155- ```
156+ * `move`, `move_absolute`:
157+ Will move the window relative to either its current position or to the top
158+ left corner of the screen. Arguments are in the form of pairs of x and y
159+ integer coordinates.
160+
161+ Example:
162+
163+ \# Shift the window 20px forward and 40px up<br>
164+ $ howlc move 20 -40
165+
166+ \# Move the window to absolute coordinates [300, 300]<br>
167+ $ howlc move_absolute 300 300
168+
169+ * `resize`, `resize_absolute`:
170+ Will resize the window relative to either its current position or the top
171+ left corner of the screen. Arguments are in the form of pairs of w and h
172+ integers.
173+
174+ Example:
175+
176+ \# Grow the window 20px forward and shrink it 40px up<br>
177+ $ howlc resize 20 -40
178+
179+ \# Resize the window to the absolute size [300, 300]<br>
180+ $ howlc resize_absolute 300 300
181+
182+ * `teleport`:
183+ Will "teleport" (move and resize) the window to the coordinates specified, in
184+ the format of x, y, w and h.
185+
186+ Example:
187+
188+ \# Move the window to [50, 25] and resize it to [200, 250]<br>
189+ $ howlc teleport 50 25 200 250
190+
191+ * `center`:
192+ Will position the window in the center of the screen.
193+
194+ Example:
195+
196+ \# Move the window to the center of the screen<br>
197+ $ howlc center
198+
199+ * `fullscreen`:
200+ Will resize the window to the screen size.
201+
202+ Example:
203+
204+ \# Put the window in fullscreen mode<br>
205+ $ howlc fullscreen
206+
207+ * `hide`, `show`:
208+ Hide/show the current window. Currently these don't have much use.
209+
210+ Example:
211+
212+ \# Hide (unmap) the current window<br>
213+ $ howlc hide
214+
215+ \# And now show (map) it<br>
216+ $ howlc show
217+
218+ * `close`:
219+ Closes the window.
220+
221+ Example:
222+
223+ \# Close the current window<br>
224+ $ howlc close
225+
226+ * `workspace`, `move_workspace`:
227+ Switch, or move the current window, to the specified workspace. Argument is a single
228+ integer representing the workspace number.
229+
230+ Example:
231+
232+ \# Switch to the 3rd workspace<br>
233+ $ howlc workspace 3
234+
235+ \# Move the current window to the 6th workspace<br>
236+ $ howlc move_workspace 6
237+
238+ * `get_geometry`, `get_pid`, `get_title`, `get_app_id`:
239+ Print the current window's geometry (in x, y, w and h), process ID, title or app ID.
240+ These are practically non-operational right now, see [BUGS][].
241+
242+ Example:
243+
244+ \# Get the current window's geometry<br>
245+ $ howlc get_geometry<br>
246+ 327 148 620 620
247+
248+ \# Get the current window's process ID<br>
249+ $ howlc get_pid<br>
250+ 12345
251+
252+ \# Get the current window's title<br>
253+ $ howlc get_title<br>
254+ Example
255+
256+ \# Get the current window's app ID<br>
257+ $ howlc get_app_id<br>
258+ example
259+
260+ * `bind`:
261+ Create a key binding. Arguments are in the form of a list of keys and the command to execute,
262+ see the [BINDINGS][] section for more info.
263+
264+ Example:
265+
266+ \# Bind modkey+Shift+g to execute "example_command"<br>
267+ $ howlc bind mod+shift+g "example_command"
268+
269+ \# Bind Win+4 to switch to the 4th workspace<br>
270+ $ howlc bind win+4 "howlc workspace 4"
271+
272+ * `modkey`:
273+ Configure the modifier key. This can be then used as an alias in keybindings, like so: `mod+key`.
274+ See the [BINDINGS][] section for allowed values.
275+
276+ Example:
277+
278+ \# Configure the modifier key to Alt<br>
279+ $ howlc modkey alt
280+
281+ \# Configure the modifier key to Win+Ctrl<br>
282+ $ howlc modkey win+ctrl
283+
284+ * `focus_color`, `unfocus_color`:
285+ Set the focused and unfocused colors of the window borders. Arguments are in the format of #RRGGBB,
286+ where the leading pound sign is optional. Note that in the format of #RRGGBB, the argument needs to
287+ be quoted, since the pound sign (#) is a special one in most shells.
288+
289+ Example:
290+
291+ \# Set the focused color to a shade of red<br>
292+ $ howlc focus_color "#f03937"
293+
294+ \# Set the unfocused color to a bright white<br>
295+ $ howlc unfocus_color eeeeee
296+
297+ * `border_width`:
298+ Set the window's border width. Argument is a single integer representing the new border width.
299+
300+ Example:
301+
302+ \# Set the border width to 4px<br>
303+ $ howlc border_width 4
304+
305+ \# Set the border width to 0px, essentially disabling borders<br>
306+ $ howlc border_width 0
307+
308+ * `quit`:
309+ Quit the compositor.
310+
311+ Example:
312+
313+ \# Terminate the Wayland display, cleanup and exit<br>
314+ $ howlc quit
315
316 ## BINDINGS
317