File: README.md

package info (click to toggle)
grim 1.1+ds-1
  • links: PTS
  • area: main
  • in suites:
  • size: 148 kB
  • sloc: ansic: 780; xml: 152; makefile: 4
file content (81 lines) | stat: -rw-r--r-- 1,241 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# grim

Grab images from a Wayland compositor. Works great with [slurp] and with [sway] >= 1.0.

## Example usage

Screenshoot all outputs:

```sh
grim screenshot.png
```

Screenshoot a specific output:

```sh
grim -o DP-1 screenshot.png
```

Screenshoot a region:

```sh
grim -g "10,20 300x400" screenshot.png
```

Select a region and screenshoot it:

```sh
grim -g "$(slurp)" screenshot.png
```

Use a timestamped filename:

```sh
grim $(xdg-user-dir PICTURES)/$(date +'%Y-%m-%d-%H%M%S_grim.png')
```

Screenshoot and copy to clipboard:

```sh
grim - | wl-copy
```

Grab a screenshot from the focused monitor under Sway, using `swaymsg` and `jq`:

```sh
grim -o $(swaymsg -t get_outputs | jq -r '.[] | select(.focused) | .name') screenshot.png
```

## Installation

* Arch Linux: `pacman -S grim`

## Building

Install dependencies:

* meson
* wayland
* cairo
* libjpeg (optional)

Then run:

```sh
meson build
ninja -C build
build/grim
```

## Contributing

Either [send GitHub pull requests][github] or [send patches on the mailing list][ml].

## License

MIT

[slurp]: https://github.com/emersion/slurp
[sway]: https://github.com/swaywm/sway
[github]: https://github.com/emersion/grim
[ml]: https://lists.sr.ht/%7Eemersion/public-inbox