wl-mirror(1)

1wl-mirror(1)                General Commands Manual               wl-mirror(1)
2
3
4

NAME

6       wl-mirror - a simple Wayland output mirror client
7

SYNOPSIS

9       wl-mirror [-h,-V,-v,-c,-i,-s S,-b B,-t T,-r R,-S] <output>
10

OPTIONS

12       -h, --help
13           Show help message and exit.
14
15       -V, --version
16           Show version information and exit.
17
18       -v, --verbose
19           --no-verbose
20           Enable or disable debug logging.
21
22       -c, --show-cursor
23           --no-show-cursor
24           Show the cursor on the mirrored surface (enabled by default).
25
26       -i, --invert-colors
27           --no-invert-colors
28           Invert colors on the mirrored surface.
29
30       -s l, --scaling linear
31           Use linear scaling (enabled by default).
32
33       -s n, --scaling nearest
34           Use nearest-neighbor scaling.
35
36       -s e, --scaling exact
37           Use exact multiple scaling (and if necessary add letterboxing).
38           Uses nearest neighbor scaling for downscaling.
39
40       -b B, --backend B
41           Use a specific screen capture backend, see BACKENDS.
42
43       -t T, --transform T
44           Apply custom transform (rotation and flipping), see TRANSFORMS.
45
46       -r R, --region R
47           Capture custom screen region R, see REGIONS.
48
49       -S, --stream
50           Accept a stream of additional options on stdin, see STREAM MODE.
51

BACKENDS

53       auto
54           Automatically try backends in order and use the first that works
55           (enabled by default). The next backend is selected automatically
56           when the current backend fails to capture a frame 10 times in a
57           row.
58
59       dmabuf
60           Use the wlr-export-dmabuf-unstable-v1 protocol to capture outputs
61           (requires wlroots). This backend keeps the image data on the GPU
62           and does not need expensive copies to the CPU and back.
63
64       screencopy
65           Use the wlr-screencopy-unstable-v1 protocol to capture outputs (re‐
66           quires wlroots) This backend passes the image data via shared mem‐
67           ory on the CPU, but may have better compatibility with complex GPU
68           driver configurations (e.g., multi GPU).
69

TRANSFORMS

71       Transforms are specified as a dash-separated list of flips followed by
72       a rotation amount. Flips are applied before rotations, both flips and
73       rotations are optional. Custom transformations are applied after ad‐
74       justing for the wayland output transform, so that if no custom trans‐
75       formations are applied, the mirrored surface is displayed right-side-
76       up.
77
78       normal
79           No transformation (default transformation).
80
81       flipX, flipY
82           Flip the X or Y coordinate of the image, i.e. flipX means the mir‐
83           rored surface has left and right swapped.
84
85       0cw, 90cw, 180cw, 270cw
86           Apply a clockwise rotation.
87
88       0ccw, 90ccw, 180ccw, 270ccw
89           Apply a counter-clockwise rotation.
90
91       The following transformation options are provided for compatibility
92       with sway-output(5) transforms:
93
94       flipped
95           Same as flipX.
96
97       0, 90, 180, 270
98           Same as 0cw, 90cw, 180cw, 270cw.
99

REGIONS

101       Regions are specified in the format used by the slurp(1) utility:
102
103           'x,y widthxheight [output]'
104
105       When processing the region option, the region is translated into output
106       coordinates, so when the output moves, the captured region moves with
107       it. When a region is specified, the output positional argument is op‐
108       tional.
109

STREAM MODE

111       In stream mode, wl-mirror interprets lines on stdin as additional com‐
112       mand line options.
113
114       •   Arguments can be quoted with single or double quotes, but every ar‐
115           gument must be fully quoted.
116       •   Unquoted arguments are split on whitespace.
117       •   No escape sequences are implemented.
118
119
120       Option lines on stdin are processed asynchronously, and can override
121       all options and the captured output. Stream mode is used by wl-
122       present(1) to add interactive controls to wl-mirror.
123

AUTHORS

125       Maintained by Ferdinand Bachmann <theferdi265@gmail.com>. More informa‐
126       tion on wl-mirror can be found at <https://github.com/Ferdi265/wl-mir‐
127       ror>.
128