1grim(1)                     General Commands Manual                    grim(1)
2
3
4

NAME

6       grim - grab images from a Wayland compositor
7

SYNOPSIS

9       grim [options...] [output-file]
10

DESCRIPTION

12       grim is a command-line utility to take screenshots of Wayland desktops.
13       For now it requires support for the screencopy protocol to work. Sup‐
14       port for the xdg-output protocol is optional, but improves fractional
15       scaling support.
16
17       grim will write an image to output-file, or to a timestamped file name
18       in $GRIM_DEFAULT_DIR if not specified. If $GRIM_DEFAULT_DIR is not set,
19       it falls back first to $XDG_PICTURES_DIR and then to the current work‐
20       ing directory. If output-file is -, grim will write the image to the
21       standard output instead.
22

OPTIONS

24       -h
25           Show help message and quit.
26
27       -s <factor>
28           Set the output image's scale factor to factor. By default, the
29           scale factor is set to the highest of all outputs.
30
31       -g "<x>,<y> <width>x<height>"
32           Set the region to capture, in layout coordinates.
33
34           If set to -, read the region from the standard input instead.
35
36       -t <type>
37           Set the output image's file format to type. By default, the file‐
38           type is set to png, valid values are png, jpeg or ppm.
39
40       -q <quality>
41           Set the output jpeg's filetype compression rate to quality. By de‐
42           fault, the jpeg quality is 80, valid values are between 0-100.
43
44       -l <level>
45           Set the output PNG's filetype compression level to level. By de‐
46           fault, the PNG compression level is 6 on a scale from 0 to 9. Level
47           9 gives the highest compression ratio, but may be slow; level 1
48           gives a lower compression ratio, but is faster. Level 0 does no
49           compression at all, and produces very large files; it can be useful
50           when grim is used in a pipeline with other commands.
51
52       -o <output>
53           Set the output name to capture.
54
55       -c
56           Include cursors in the screenshot.
57

AUTHORS

59       Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other
60       open-source contributors. For more information about grim development,
61       see <https://sr.ht/~emersion/grim>.
62
63
64
65                                  2023-07-22                           grim(1)
Impressum