commit 3fb0475

wf  ·  2026-05-18 14:58:09 +0000 UTC
parent a9015cc
Clean up manpage formatting
2 files changed,  +70, -52
+63, -45
  1@@ -9,80 +9,91 @@
  2 \fBhowlc\fR is a client that controls the howl(1) compositor\.
  3 .SH "COMMANDS"
  4 Most of the following (can be deduced logically) can take an optional window ID argument, e\.g\.: \fBmove 20 20 4\fR, where the first 2 arguments given to \fBmove\fR are the coordinates and the third one is the window ID\. If no window ID is given, then the currently focused window will be targeted (if it exists)\.
  5-.IP "\(bu" 4
  6-\fBmove\fR, \fBmove_absolute\fR: 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\.
  7+.TP
  8+\fBmove\fR, \fBmove_absolute\fR
  9+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\.
 10 .IP
 11 Example:
 12 .IP
 13 $ howlc move 20 \-40
 14 .IP
 15 $ howlc move_absolute 300 300
 16-.IP "\(bu" 4
 17-\fBresize\fR, \fBresize_absolute\fR: 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\.
 18+.TP
 19+\fBresize\fR, \fBresize_absolute\fR
 20+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\.
 21 .IP
 22 Example:
 23 .IP
 24 $ howlc resize 20 \-40
 25 .IP
 26 $ howlc resize_absolute 300 300
 27-.IP "\(bu" 4
 28-\fBteleport\fR: Will "teleport" (move and resize) the window to the coordinates specified, in the format of x, y, w and h\.
 29+.TP
 30+\fBteleport\fR
 31+Will "teleport" (move and resize) the window to the coordinates specified, in the format of x, y, w and h\.
 32 .IP
 33 Example:
 34 .IP
 35 $ howlc teleport 50 25 200 250
 36-.IP "\(bu" 4
 37-\fBcenter\fR: Will position the window in the center of the screen\.
 38+.TP
 39+\fBcenter\fR
 40+Will position the window in the center of the screen\.
 41 .IP
 42 Example:
 43 .IP
 44 $ howlc center
 45-.IP "\(bu" 4
 46-\fBfullscreen\fR: Will resize the window to the screen size\.
 47+.TP
 48+\fBfullscreen\fR
 49+Will resize the window to the screen size\.
 50 .IP
 51 Example:
 52 .IP
 53 $ howlc fullscreen
 54-.IP "\(bu" 4
 55-\fBhide\fR, \fBshow\fR: Hide/show the current window\. Currently these don't have much use\.
 56+.TP
 57+\fBhide\fR, \fBshow\fR
 58+Hide/show the window\.
 59 .IP
 60 Example:
 61 .IP
 62 $ howlc hide
 63 .IP
 64 $ howlc show
 65-.IP "\(bu" 4
 66-\fBfocus_prev\fR, \fBfocus_next\fR: Focus the previous/next window\.
 67+.TP
 68+\fBfocus_prev\fR, \fBfocus_next\fR
 69+Focus the previous/next window\.
 70 .IP
 71 Example:
 72 .IP
 73 $ howlc focus_prev
 74 .IP
 75 $ howlc focus_next
 76-.IP "\(bu" 4
 77-\fBlower\fR, \fBraise\fR: Lower/raise the window's stack order\.
 78+.TP
 79+\fBlower\fR, \fBraise\fR
 80+Lower/raise the window's stack order\.
 81 .IP
 82 Example:
 83 .IP
 84 $ howlc lower
 85 .IP
 86 $ howlc raise
 87-.IP "\(bu" 4
 88-\fBclose\fR: Closes the window\.
 89+.TP
 90+\fBclose\fR
 91+Closes the window\.
 92 .IP
 93 Example:
 94 .IP
 95 $ howlc close
 96-.IP "\(bu" 4
 97-\fBworkspace\fR, \fBmove_workspace\fR: Switch, or move the current window, to the specified workspace\. Argument is a single integer representing the workspace number\.
 98+.TP
 99+\fBworkspace\fR, \fBmove_workspace\fR
100+Switch, or move the window, to the specified workspace\. Argument is a single integer representing the workspace number\.
101 .IP
102 Example:
103 .IP
104 $ howlc workspace 3
105 .IP
106 $ howlc move_workspace 6
107-.IP "\(bu" 4
108-\fBget_geometry\fR, \fBget_pid\fR, \fBget_title\fR, \fBget_app_id\fR: Print the current window's geometry (in x, y, w and h), process ID, title or app ID\.
109+.TP
110+\fBget_geometry\fR, \fBget_pid\fR, \fBget_title\fR, \fBget_app_id\fR
111+Print the window's geometry (in x, y, w and h), process ID, title or app ID\.
112 .IP
113 Example:
114 .IP
115@@ -101,16 +112,18 @@ Example
116 $ howlc get_app_id
117 .br
118 example
119-.IP "\(bu" 4
120-\fBget_screen_geometry\fR: Print the current screen's width and height\.
121+.TP
122+\fBget_screen_geometry\fR
123+Print the current screen's width and height\.
124 .IP
125 Example:
126 .IP
127 $ howlc get_screen_geometry
128 .br
129 1920 1080
130-.IP "\(bu" 4
131-\fBlist_windows\fR: Print a list of currently open windows\. By default only mapped windows are listed, but \fB\-u\fR can be specified as an option to list only unmapped windows, and \fB\-a\fR can be specified to list all windows\.
132+.TP
133+\fBlist_windows\fR
134+Print a list of currently open windows\. By default only mapped windows are listed, but \fB\-u\fR can be specified as an option to list only unmapped windows, and \fB\-a\fR can be specified to list all windows\.
135 .IP
136 Example:
137 .IP
138@@ -121,8 +134,9 @@ $ howlc list_windows \-u
139 21
140 .br
141 25
142-.IP "\(bu" 4
143-\fBbind\fR: 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\.
144+.TP
145+\fBbind\fR
146+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\.
147 .IP
148 Example:
149 .IP
150@@ -133,56 +147,60 @@ $ howlc bind mod+shift+g "example_command"
151 # Bind Win+4 to switch to the 4th workspace
152 .br
153 $ howlc bind win+4 "howlc workspace 4"
154-.IP "\(bu" 4
155-\fBmodkey\fR: 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\.
156+.TP
157+\fBmodkey\fR
158+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\.
159 .IP
160 Example:
161 .IP
162 $ howlc modkey alt
163 .IP
164 $ howlc modkey win+ctrl
165-.IP "\(bu" 4
166-\fBinner_focus_color\fR, \fBinner_unfocus_color\fR, \fBinner_unfocus_color\fR, \fBouter_unfocus_color\fR: Set the inner/outer 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\.
167+.TP
168+\fBinner_focus_color\fR, \fBinner_unfocus_color\fR, \fBinner_unfocus_color\fR, \fBouter_unfocus_color\fR
169+Set the inner/outer 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\.
170 .IP
171 Example:
172 .IP
173 $ howlc outer_focus_color "#f03937"
174 .IP
175 $ howlc inner_unfocus_color eeeeee
176-.IP "\(bu" 4
177-\fBinner_border_width\fR, \fBouter_border_width\fR: Set the window's inner/outer border width\. Argument is a single integer representing the new border width\.
178+.TP
179+\fBinner_border_width\fR, \fBouter_border_width\fR
180+Set the inner/outer border widths of the window borders\. Argument is a single integer representing the new border width\.
181 .IP
182 Example:
183 .IP
184 $ howlc inner_border_width 4
185 .IP
186 $ howlc outer_border_width 0
187-.IP "\(bu" 4
188-\fBtitle_format\fR: Set the format for the text displayed in window titlebars\. Currently accepted specifiers are:
189-.IP "\(bu" 4
190+.TP
191+\fBtitle_format\fR
192+Set the format for the text displayed in window titlebars\. Currently accepted specifiers are:
193+.IP
194 \fB%t\fR \- window title
195-.IP "\(bu" 4
196+.br
197 \fB%a\fR \- window app ID
198-.IP "\(bu" 4
199+.br
200 \fB%p\fR \- window PID
201-.IP "" 0
202 .IP
203 Example:
204 .IP
205 $ howlc title_format '%t %p'
206-.IP "\(bu" 4
207-\fBset_decor\fR: Set the current window decoration theme\. Argument is a path (absolute or relative) to the directory containing the theme\. See decor\.c on the format of themes\.
208+.TP
209+\fBset_decor\fR
210+Set the current window decoration theme\. Argument is a path (absolute or relative) to the directory containing the theme\. See decor\.c on the format of themes\.
211 .IP
212 Example:
213 .IP
214 $ howlc set_decor ~/etc/decorations/theme
215-.IP "\(bu" 4
216-\fBquit\fR: Quit the compositor\.
217+.TP
218+\fBquit\fR
219+Quit the compositor\.
220 .IP
221 Example:
222 .IP
223 $ howlc quit
224-.IP "" 0
225 .SH "BINDINGS"
226 The format for keybindings is the following:
227 .P
+7, -7
 1@@ -58,7 +58,7 @@ Most of the following (can be deduced logically) can take an optional window ID
 2     $ howlc fullscreen
 3 
 4   * `hide`, `show`:
 5-    Hide/show the current window. Currently these don't have much use.
 6+    Hide/show the window.
 7 
 8     Example:
 9 
10@@ -92,7 +92,7 @@ Most of the following (can be deduced logically) can take an optional window ID
11     $ howlc close
12 
13   * `workspace`, `move_workspace`:
14-    Switch, or move the current window, to the specified workspace. Argument is a single
15+    Switch, or move the window, to the specified workspace. Argument is a single
16     integer representing the workspace number.
17 
18     Example:
19@@ -102,7 +102,7 @@ Most of the following (can be deduced logically) can take an optional window ID
20     $ howlc move_workspace 6
21 
22   * `get_geometry`, `get_pid`, `get_title`, `get_app_id`:
23-    Print the current window's geometry (in x, y, w and h), process ID, title or app ID.
24+    Print the window's geometry (in x, y, w and h), process ID, title or app ID.
25 
26     Example:
27 
28@@ -170,7 +170,7 @@ Most of the following (can be deduced logically) can take an optional window ID
29     $ howlc inner_unfocus_color eeeeee
30 
31   * `inner_border_width`, `outer_border_width`:
32-    Set the window's inner/outer border width. Argument is a single integer representing the new border width.
33+    Set the inner/outer border widths of the window borders. Argument is a single integer representing the new border width.
34 
35     Example:
36 
37@@ -181,9 +181,9 @@ Most of the following (can be deduced logically) can take an optional window ID
38   * `title_format`:
39     Set the format for the text displayed in window titlebars. Currently accepted specifiers are:
40 
41-    * `%t` - window title
42-    * `%a` - window app ID
43-    * `%p` - window PID
44+    `%t` - window title<br>
45+    `%a` - window app ID<br>
46+    `%p` - window PID
47 
48     Example:
49