Skip to content
This repository was archived by the owner on Oct 31, 2025. It is now read-only.

Commit b301248

Browse files
authored
Merge pull request #494 from ryincler/main
Docs: replace usage of single-tick blocks with bold text blocks
2 parents 460328b + 7cbfd6f commit b301248

File tree

9 files changed

+42
-42
lines changed

9 files changed

+42
-42
lines changed

doc/swww-clear-cache.1.scd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@ swww-clear-cache
1313

1414
# DESCRIPTION
1515

16-
Deletes the `swww` cache directory.
16+
Deletes the *swww* cache directory.
1717

1818
The cache resides at _$XDG_CACHE_HOME/swww_ or _$HOME/.cache/swww_
1919
if $XDG_CACHE_HOME does not exist. In this directory, we create another
20-
directory corresponding to `swww`s current version number. In there, we have
20+
directory corresponding to *swww*s current version number. In there, we have
2121
files that cache the last displayed image and animation frames for animated
2222
wallpapers. There is one file per output.
2323

24-
**Note that `swww` will automatically delete any files and directories in
25-
_$XDG_CACHE_HOME/swww_ that do not correspond to the exact current `swww`
26-
version number.** This is to ensure we only keep cache files for the latest
27-
`swww` version.
24+
Note that *swww* will automatically delete any files and directories in
25+
_$XDG_CACHE_HOME/swww_ that do not correspond to the exact current *swww*
26+
version number. This is to ensure we only keep cache files for the latest
27+
*swww* version.
2828

2929
# SEE ALSO
3030
*swww-img*(1)

doc/swww-clear.1.scd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ swww-clear
99
# OPTIONS
1010

1111
*-a*,*--all*
12-
Send this command to all active `swww-daemon` namespaces.
12+
Send this command to all active *swww-daemon* namespaces.
1313

1414
*-n*,*--namespace* <namespace>
1515
Which wayland namespace to send this command to.
1616

1717
You can specify this option multiple times to send commands to multiple
18-
namespaces at once: `swww clear -n <namespace1> -n <namespace 2>`.
18+
namespaces at once: *swww clear -n <namespace1> -n <namespace 2>*.
1919

20-
This affects the name of the `swww-daemon` socket we will use to
20+
This affects the name of the *swww-daemon* socket we will use to
2121
communicate with. Specifically, our socket name is
2222
_${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket_.
2323

doc/swww-daemon.1.scd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ swww-daemon [OPTIONS]
1818
when decoding the image (though the difference is unnoticiable).
1919

2020
*-l*,*--layer* <background|bottom>
21-
Which layer to display the background in. Defaults to `background`.
21+
Which layer to display the background in. Defaults to *background*.
2222

23-
We do not accept layers `top` and `overlay` because those would make your
23+
We do not accept layers *top* and *overlay* because those would make your
2424
desktoop unusable by simply putting an image on top of everything else. If
2525
there is ever a use case for these, we can reconsider it.
2626

2727
*-n*,*--namespace* <namespace>
28-
Which wayland namespace to append to `swww-daemon`.
28+
Which wayland namespace to append to *swww-daemon*.
2929

30-
The result namespace will the `swww-daemon<specified namespace>`. This also
31-
affects the name of the `swww-daemon` socket we will use to communicate
32-
with the `client`. Specifically, our socket name is
30+
The result namespace will the *swww-daemon<specified namespace>*. This also
31+
affects the name of the *swww-daemon* socket we will use to communicate
32+
with the *client*. Specifically, our socket name is
3333
_${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket_.
3434

3535
Some compositors can have several different wallpapers per output. This

doc/swww-img.1.scd

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ swww-img
99
# OPTIONS
1010

1111
*-a*,*--all*
12-
Send this command to all active `swww-daemon` namespaces.
12+
Send this command to all active *swww-daemon* namespaces.
1313

1414
*-f*, *--filter* <FILTER>
1515
Filter to use when scaling images
@@ -36,9 +36,9 @@ swww-img
3636
Which wayland namespace to send this command to.
3737

3838
You can specify this option multiple times to send commands to multiple
39-
namespaces at once: `swww img -n <namespace1> -n <namespace 2>`.
39+
namespaces at once: *swww img -n <namespace1> -n <namespace 2>*.
4040

41-
This affects the name of the `swww-daemon` socket we will use to
41+
This affects the name of the *swww-daemon* socket we will use to
4242
communicate with. Specifically, our socket name is
4343
_${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket_.
4444

@@ -107,13 +107,13 @@ swww-img
107107
from that position to its opposite in the screen.
108108

109109
_wipe_ is similar to _left_ but allows you to specify the angle for
110-
transition with the `--transition-angle` flag.
110+
transition with the *--transition-angle* flag.
111111

112112
_wave_ is similar to _wipe_ but the sweeping line is wavy. You can control
113-
the "waviness" with `--transition-wave`.
113+
the "waviness" with *--transition-wave*.
114114

115115
_grow_ causes a growing circle to transition across the screen and allows
116-
changing the circle's center position with the `--transition-pos` flag.
116+
changing the circle's center position with the *--transition-pos* flag.
117117

118118
_center_ is an alias to _grow_ with position set to center of screen.
119119

@@ -159,7 +159,7 @@ swww-img
159159
Note there is no point in setting this to a value smaller than what your
160160
monitor supports.
161161

162-
Also note this is **different** from the transition-step. That one controls
162+
Also note this is different from the transition-step. That one controls
163163
by how much we approach the new image every frame.
164164

165165
Default is 30.
@@ -203,7 +203,7 @@ swww-img
203203
*--invert-y* <bool>
204204
\[Environment Variable: SWWW_INVERT_Y]
205205

206-
inverts the y position sent in `transition_pos` flag
206+
inverts the y position sent in *transition_pos* flag
207207

208208
*--transition-bezier* <f1,f2,f3,f4 (all floats)>
209209
\[Environment Variable: SWWW_TRANSITION_BEZIER]
@@ -227,21 +227,21 @@ swww-img
227227
Print help (see a summary with '-h')
228228

229229
# DESCRIPTION
230-
Sends an image (or animated gif) for the daemon to display. You can also use `-`
230+
Sends an image (or animated gif) for the daemon to display. You can also use *-*
231231
to read from stdin instead.
232232

233233
# ABOUT THE CACHE
234234

235235
The images sent will be cached at _$XDG_CACHE_HOME/swww_ or _$HOME/.cache/swww_
236236
if $XDG_CACHE_HOME does not exist. In this directory, we create another
237-
directory corresponding to `swww`s current version number. In there, we have
237+
directory corresponding to *swww*s current version number. In there, we have
238238
files that cache the last displayed image and animation frames for animated
239239
wallpapers. There is one file per output.
240240

241241
As mentioned, the cache will keep preprocessed versions of animations. So, if
242-
you load a large `gif`, you would only have to pay the price for its processing
243-
the first time. If you constantly load large `gif`s, this could cause the cache
244-
to get very big. You can simply run `swww clean-cache` if this happens.
242+
you load a large *gif*, you would only have to pay the price for its processing
243+
the first time. If you constantly load large *gif*s, this could cause the cache
244+
to get very big. You can simply run *swww clean-cache* if this happens.
245245

246246
# SEE ALSO
247247
*swww-clear-cache*(1) *swww-daemon*(1) *swww-query*(1)

doc/swww-kill.1.scd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ swww-kill
99
# OPTIONS
1010

1111
*-a*,*--all*
12-
Send this command to all active `swww-daemon` namespaces.
12+
Send this command to all active *swww-daemon* namespaces.
1313

1414
*-n*,*--namespace* <namespace>
1515
Which wayland namespace to send this command to.
1616

1717
You can specify this option multiple times to send commands to multiple
18-
namespaces at once: `swww kill -n <namespace1> -n <namespace 2>`.
18+
namespaces at once: *swww kill -n <namespace1> -n <namespace 2>*.
1919

20-
This affects the name of the `swww-daemon` socket we will use to
20+
This affects the name of the *swww-daemon* socket we will use to
2121
communicate with. Specifically, our socket name is
2222
_${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket_.
2323

doc/swww-pause.1.scd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ swww-pause
99
# OPTIONS
1010

1111
*-a*,*--all*
12-
Send this command to all active `swww-daemon` namespaces.
12+
Send this command to all active *swww-daemon* namespaces.
1313

1414
*-n*,*--namespace* <namespace>
1515
Which wayland namespace to send this command to.
1616

1717
You can specify this option multiple times to send commands to multiple
18-
namespaces at once: `swww pause -n <namespace1> -n <namespace 2>`.
18+
namespaces at once: *swww pause -n <namespace1> -n <namespace 2>*.
1919

20-
This affects the name of the `swww-daemon` socket we will use to
20+
This affects the name of the *swww-daemon* socket we will use to
2121
communicate with. Specifically, our socket name is
2222
_${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket_.
2323

doc/swww-query.1.scd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ swww-query
99
# OPTIONS
1010

1111
*-a*,*--all*
12-
Send this command to all active `swww-daemon` namespaces.
12+
Send this command to all active *swww-daemon* namespaces.
1313

1414
*-n*,*--namespace* <namespace>
1515
Which wayland namespace to send this command to.
1616

1717
You can specify this option multiple times to send commands to multiple
18-
namespaces at once: `swww query -n <namespace1> -n <namespace 2>`.
18+
namespaces at once: *swww query -n <namespace1> -n <namespace 2>*.
1919

20-
This affects the name of the `swww-daemon` socket we will use to
20+
This affects the name of the *swww-daemon* socket we will use to
2121
communicate with. Specifically, our socket name is
2222
_${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket_.
2323

doc/swww-restore.1.scd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ swww-restore
99
# OPTIONS
1010

1111
*-a*,*--all*
12-
Send this command to all active `swww-daemon` namespaces.
12+
Send this command to all active *swww-daemon* namespaces.
1313

1414
*-n*,*--namespace* <namespace>
1515
Which wayland namespace to send this command to.
1616

1717
You can specify this option multiple times to send commands to multiple
18-
namespaces at once: `swww restore -n <namespace1> -n <namespace 2>`.
18+
namespaces at once: *swww restore -n <namespace1> -n <namespace 2>*.
1919

20-
This affects the name of the `swww-daemon` socket we will use to
20+
This affects the name of the *swww-daemon* socket we will use to
2121
communicate with. Specifically, our socket name is
2222
_${WAYLAND_DISPLAY}-swww-daemon.<specified namespace>.socket_.
2323

@@ -39,7 +39,7 @@ swww-restore
3939

4040
Restores the last displayed image on the specified outputs.
4141

42-
This can be used to split initialization (with `swww init --no-daemon`) and
42+
This can be used to split initialization (with *swww init --no-daemon*) and
4343
cache loading into different steps, in order to avoid race condition traps.
4444

4545
You can also use this command to restore the last displayed image when

doc/swww.1.scd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ swww - A Solution to your Wayland Wallpaper Woes
1515
Restores the last displayed image on the specified outputs
1616

1717
*clear-cache*
18-
Deletes the `swww` cache directory
18+
Deletes the *swww* cache directory
1919

2020
*img*
2121
Sends an image (or animated gif) for the daemon to display

0 commit comments

Comments
 (0)