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,-f,-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       -f, --freeze
31           --unfreeze
32           --toggle-freeze
33           Freeze, unfreeze, or toggle freezing of the current image on the
34           screen.
35
36       -s l, --scaling linear
37           Use linear scaling (enabled by default).
38
39       -s n, --scaling nearest
40           Use nearest-neighbor scaling.
41
42       -s e, --scaling exact
43           Use exact multiple scaling (and if necessary add letterboxing).
44           Uses nearest neighbor scaling for downscaling.
45
46       -b B, --backend B
47           Use a specific screen capture backend, see BACKENDS.
48
49       -t T, --transform T
50           Apply custom transform (rotation and flipping), see TRANSFORMS.
51
52       -r R, --region R
53           Capture custom screen region R, see REGIONS.
54
55       -S, --stream
56           Accept a stream of additional options on stdin, see STREAM MODE.
57

BACKENDS

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

TRANSFORMS

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

REGIONS

107       Regions are specified in the format used by the slurp(1) utility:
108
109           'x,y widthxheight [output]'
110
111       When processing the region option, the region is translated into output
112       coordinates, so when the output moves, the captured region moves with
113       it. When a region is specified, the output positional argument is op‐
114       tional.
115

STREAM MODE

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

AUTHORS

131       Maintained by Ferdinand Bachmann <theferdi265@gmail.com>. More informa‐
132       tion on wl-mirror can be found at <https://github.com/Ferdi265/wl-mir‐
133       ror>.
134