Document use of gnome-screenshot

This commit is contained in:
Andrew Murray 2022-06-13 10:16:30 +10:00
parent b1ba0909ed
commit 463d18191a
2 changed files with 9 additions and 4 deletions

View File

@ -15,7 +15,10 @@ or the clipboard to a PIL image memory.
returned as an "RGBA" on macOS, or an "RGB" image otherwise. returned as an "RGBA" on macOS, or an "RGB" image otherwise.
If the bounding box is omitted, the entire screen is copied. If the bounding box is omitted, the entire screen is copied.
.. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS), 7.1.0 (Linux (X11)) On Linux, if ``xdisplay`` is ``None`` then ``gnome-screenshot`` will be used if it
is installed. To capture the default X11 display instead, pass ``xdisplay=""``.
.. versionadded:: 1.1.3 (Windows), 3.0.0 (macOS), 7.1.0 (Linux)
:param bbox: What region to copy. Default is the entire screen. :param bbox: What region to copy. Default is the entire screen.
Note that on Windows OS, the top-left point may be negative if ``all_screens=True`` is used. Note that on Windows OS, the top-left point may be negative if ``all_screens=True`` is used.

View File

@ -76,7 +76,9 @@ TODO
Other Changes Other Changes
============= =============
TODO Using gnome-screenshot on Linux
^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TODO In :py:meth:`~PIL.ImageGrab.grab` on Linux, if ``xdisplay`` is ``None`` then
``gnome-screenshot`` will be used to capture the display if it is installed. To capture
the default X11 display instead, pass ``xdisplay=""``.