Skip to content

Commit 463d181

Browse files
committed
Document use of gnome-screenshot
1 parent b1ba090 commit 463d181

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

docs/reference/ImageGrab.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ or the clipboard to a PIL image memory.
1515
returned as an "RGBA" on macOS, or an "RGB" image otherwise.
1616
If the bounding box is omitted, the entire screen is copied.
1717

18-
.. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS), 7.1.0 (Linux (X11))
18+
On Linux, if ``xdisplay`` is ``None`` then ``gnome-screenshot`` will be used if it
19+
is installed. To capture the default X11 display instead, pass ``xdisplay=""``.
20+
21+
.. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS), 7.1.0 (Linux)
1922

2023
:param bbox: What region to copy. Default is the entire screen.
2124
Note that on Windows OS, the top-left point may be negative if ``all_screens=True`` is used.

docs/releasenotes/9.2.0.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ TODO
7676
Other Changes
7777
=============
7878

79-
TODO
80-
^^^^
79+
Using gnome-screenshot on Linux
80+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8181

82-
TODO
82+
In :py:meth:`~PIL.ImageGrab.grab` on Linux, if ``xdisplay`` is ``None`` then
83+
``gnome-screenshot`` will be used to capture the display if it is installed. To capture
84+
the default X11 display instead, pass ``xdisplay=""``.

0 commit comments

Comments
 (0)