| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| apps:xfce4-screenshooter:usage [2024/12/12 00:39] – kevinbowen | apps:xfce4-screenshooter:usage [2026/11/22 16:17] (current) – Update the introduction epetriglia |
|---|
| ====== xfce4-screenshooter - Usage ====== | ====== xfce4-screenshooter - Usage ====== |
| |
| | xfce4-screenshooter can be used in two ways: through its graphical user interface (GUI), or from a terminal with command-line options (CLI). The GUI is described in the sections [[#Open the user interface|Open the user interface]], [[#Taking a screenshot|Taking a screenshot]] and [[#After capturing|After capturing]]. The [[#Command-line options|Command-line options]] section explains how to use it from a terminal, in scripts, or with keyboard shortcuts. |
| | |
| | * **[[#Open the user interface|Open the user interface]]** |
| * **[[#Taking a screenshot|Taking a screenshot]]** | * **[[#Taking a screenshot|Taking a screenshot]]** |
| * **[[#After capturing|After capturing]]** | * **[[#After capturing|After capturing]]** |
| * **[[#Host on Imgur|Host on Imgur]]** | * **[[#Hosting on Imgur™|Hosting on Imgur™]]** |
| * **[[#Command-line options|Command-line options]]** | * **[[#Command-line options|Command-line options]]** |
| |
| |
| <figure "xfce4-screenshooter Main Dialog Window"> | <figure "xfce4-screenshooter Main Dialog Window"> |
| {{:apps:xfce4-screenshooter:xfce4-screenshooter-dialog1.png?nolink|xfce4-screenshooter Main Dialog Window}} | {{:apps:xfce4-screenshooter:xfce4-screenshooter-main-window.png|xfce4-screenshooter Main Dialog Window}} |
| </figure> | </figure> |
| |
| |
| <figure "xfce4-screenshooter Action Window"> | <figure "xfce4-screenshooter Action Window"> |
| {{:apps:xfce4-screenshooter:xfce4-screenshooter-dialog2.png?600|xfce4-screenshooter Action Window}} | {{:apps:xfce4-screenshooter:xfce4-screenshooter-after-screenshot.png|xfce4-screenshooter Action Window}} |
| </figure> | </figure> |
| |
| ==== Action ==== | ==== Action ==== |
| |
| The {gui>Action} section allows you to choose what should be performed on the screenshot. | The {gui>Action} section allows you to choose what should be performed on the screenshot. Select one of the actions listed below, then press the {gui>OK} button to apply it. |
| |
| ? Save | ? Save |
| ! The {gui>Save} option will save the screenshot to a PNG file. A save dialog will be displayed. You will be able to set the save location, and the name of the file. | ! The {gui>Save} option will save the screenshot to a file. A save dialog will be displayed. You will be able to set the save location, the name of the file and its format (PNG, JPEG, BMP and, if the corresponding pixbuf loaders are installed, WebP, JPEG XL and AVIF). |
| ! Xfce4 Screenshooter is also able to save the screenshot to any remote file system supported by GVfs, such as FTP, SAMBA, SFTP, remote computers accessible via SSH... You just need to connect this remote file system using gvfs-connect or Gigolo and it will be available in the left column of the save dialog. | ! xfce4-screenshooter is also able to save the screenshot to any remote file system supported by GVfs, such as FTP, SAMBA, SFTP, remote computers accessible via SSH... You just need to connect this remote file system using gvfs-connect or Gigolo and it will be available in the left column of the save dialog. |
| ? Copy to the clipboard | ? Copy to the clipboard |
| ! The {gui>Copy to the clipboard} option allows you to paste the screenshot in another application, such as a word processor. This option is only available when a clipboard manager is running. | ! The {gui>Copy to the clipboard} option allows you to paste the screenshot in another application, such as a word processor. This option is only available when a clipboard manager is running. |
| ! The {gui>Open with} option saves the screenshot to the system's temporary directory and opens it with the application chosen from the drop-down list. Applications which support images are automatically detected and added to the drop-down list. | ! The {gui>Open with} option saves the screenshot to the system's temporary directory and opens it with the application chosen from the drop-down list. Applications which support images are automatically detected and added to the drop-down list. |
| ? Custom Action | ? Custom Action |
| ! The {gui>Custom Action} saves the screenshot to the system's temporary directory and executes the custom action chosen from the drop-down list. Custom Actions are defined in the Preferences dialog, for more details consult [[apps:xfce4-screenshooter:custom-actions|Custom Actions]]. | ! The {gui>Custom Action} saves the screenshot to the system's temporary directory and executes the custom action chosen from the drop-down list. Custom Actions are defined in the Preferences dialog, for more details see [[apps:xfce4-screenshooter:custom-actions|Custom Actions]]. |
| ? Host on Imgur | |
| | |
| <note important>This action is deprecated and will be removed in future releases, please use a custom action if you need to upload screenshots to Imgur or any other hosting provider.</note> | |
| | |
| ! The {gui>Host on Imgur} option allow you to host your screenshot on this free online hosting service, so that you can share it easily with other people. Imgur automatically generates a tiny, medium, and full-size image of your screenshot, which can be used to create thumbnails pointing to the full size screenshot. | |
| | |
| | |
| <note important>Hosting images in a public-facing service must be done with caution, as it is not possible to guarantee the removal of a image after publishing it. Before using this action, please review Imgur's [[https://imgur.com/tos|Terms of service]], if you do not agree with the terms please refrain from using this service.</note> | |
| | |
| ! Since 1.9.9 a hidden option is available to toggle the visibility of "Host on Imgur" in the action list, useful for whoever wants to avoid accidental usages. This option is called ''enable_imgur_upload'', accepts ''true'' or ''false'' as value and can be defined in ''~/.config/xfce4/xfce4-screenshooter''. Notice that your distribution may set this option to ''false'' by default. | |
| |
| [[|Back to Top]] | [[|Back to Top]] |
| ---- | ---- |
| |
| ===== Host on Imgur ===== | ===== Hosting on Imgur™ ===== |
| |
| After selecting {gui>Host on Imgur} and pressing the {gui>OK} button, you will be shown this dialog: | As of the Xfce 4.18 release this option has been removed. Alternatively, the same feature can be accomplished using a configurable [[:apps:xfce4-screenshooter:custom-actions#host_on_imgur|custom action]]. |
| | |
| <figure "xfce4-screenshooter Imgur Image Link"> | |
| {{:apps:xfce4-screenshooter:xfce4-screenshooter-imgur-link-dialog.png|xfce4-screenshooter Imgur Image Link}} | |
| </figure> | |
| | |
| The dialog below will give you the links to the full size screenshot, the large thumbnail, the small thumbnails, as well examples of HTML, Markdown and BBcode to create a thumbnail pointing to the full size screenshot: | |
| | |
| <figure "Imgur Embed into Code Dialog Window"> | |
| {{:apps:xfce4-screenshooter:xfce4-screenshooter-imgur-embed-dialog.png|Imgur Embed into Code Dialog Window}} | |
| </figure> | |
| | |
| The dialog below will give you the links to delete the image off of the Imgur website. The link will only be shown once. Make sure to save it if you think you might be deleting this image: | |
| | |
| <figure "Imgur Deletion Dialog Window"> | |
| {{:apps:xfce4-screenshooter:xfce4-screenshooter-imgur-deletion-dialog.png|Imgur Deletion Dialog Window}} | |
| </figure> | |
| | |
| Linking images of Imgur accounts is not currently supported. | |
| |
| [[|Back to Top]] | [[|Back to Top]] |
| ===== Command-line options ===== | ===== Command-line options ===== |
| |
| Command line options allow you to take screenshots quickly. They also allow you to configure the Print Screen key on the upper right of most keyboards so that it takes screenshots. To do so, configure the key-bindings of your desktop environment so that it launches xfce4-screenshooter with one or several of the following options when the Prt Scrn key is pressed. | xfce4-screenshooter can also be run from a terminal, which lets you take screenshots quickly without going through the main dialog. Command-line options are also useful to bind the Print Screen key to xfce4-screenshooter: configure the keyboard shortcuts of your desktop environment (for example with xfce4-keyboard-settings) so that pressing Print Screen launches xfce4-screenshooter with one or more of the options below. |
| |
| ==== The command line options ==== | Run ''%%xfce4-screenshooter --help%%'' to see the list of options supported by your installed version. |
| |
| ? The -w option | ==== Region to capture ==== |
| ! The -w or --window option allows you to take a screenshot of the active window. | |
| |
| ? The -f option | These options select what to capture. Only one of them can be given at a time. Without any of them, the main dialog is shown and most of the other options are ignored. |
| ! The -f or --fullscreen option allows you to take a screenshot of the entire screen. | |
| |
| ? The -r option | ? -f, --fullscreen |
| ! The -r or --region option allows you to select a region to be captured by clicking and dragging a rectangle over the area of screen that you wish to capture, before releasing the mouse button. | ! Takes a screenshot of the entire screen. |
| | ? -w, --window |
| | ! Takes a screenshot of the active window. |
| | ? -r, --region |
| | ! Lets you select the region to capture by clicking and dragging a rectangle over the area of the screen that you wish to capture, then releasing the mouse button. Press Ctrl while dragging to move the rectangle, or Esc to cancel. |
| |
| ? The -d option | ==== Capture options ==== |
| ! The -d or --delay option followed by a positive integer allows you to set the delay before taking the screenshot when the -w, -f or -r option is given. | |
| |
| ? The -s option | These options only have an effect when -f, -w or -r is given. |
| ! The -s or --save option followed by the path to an existing folder allows you to set where the screenshots are saved. The filename and extension can optionally be passed. This option only has an effect if the -w, -f or -r option is given. | |
| |
| ? The -S option | ? -d, --delay SECONDS |
| ! If the -S or --save option is given, the saved screenshot is shown in the file manager. This option only has an effect if the -s option is given. | ! Waits the given number of seconds before taking the screenshot. With -r, the delay starts after the region has been selected. |
| | ? -m, --mouse |
| | ! Includes the mouse pointer in the screenshot. |
| | ? --no-border |
| | ! Removes the window border from the screenshot. Only meaningful together with -w. |
| |
| ? The -o option | ==== Actions ==== |
| ! If the -o or --open option is given, followed by an application name, the screenshot will be saved to the system's temporary directory and opened with the application whose name is to be given after -o. This option only has an effect if the -w, -f or -r option is given. | |
| |
| ? The -i option | These options select what to do with the screenshot and only have an effect when -f, -w or -r is given. If no action is given, the [[#After capturing|action window]] is shown after the capture. |
| ! If the -i or --imgur option is given, the screenshot will be hosted on Imgur. See above for more details. This option only has an effect if the -w, -f or -r option is given. | |
| |
| ? The -c option | ? -s, --save PATH |
| ! If the -c or --clipboard option is given, the screenshot will be copied to the system clipboard. This option only has an effect if the -w, -f or -r option is given. | ! Saves the screenshot without showing any dialog. PATH can be a directory, in which case a file name is generated automatically, or a full file path. The format is chosen from the file extension: png, jpg (or jpeg) and bmp are always supported, while webp, jxl and avif require the corresponding pixbuf loaders to be installed (see ''%%--supported-formats%%''). |
| | ? -S |
| | ! Shows the saved screenshot in the file manager. Only has an effect together with -s. |
| | ? -o, --open COMMAND |
| | ! Saves the screenshot to the system's temporary directory and opens it with COMMAND, for example ''-o gimp''. The path of the screenshot is appended to the command. Cannot be used together with -s. |
| | ? -c, --clipboard |
| | ! Copies the screenshot to the clipboard. Can be combined with -s or -o. |
| |
| ? The --no-border option | ==== Other options ==== |
| ! If the --no-border option is given, the window borders are removed from the screenshot. | |
| |
| ? The --supported-formats option | ? --supported-formats |
| ! If the --supported-formats option is given, all the supported image formats will be listed, results can vary depending on installed pixbuf loaders. This option cancels out the other options, prints the list and the program exits. | ! Lists the supported image formats and exits. The results depend on the installed pixbuf loaders. All other options are ignored. |
| | ? -V, --version |
| | ! Prints the version and exits. |
| | ? -h, --help |
| | ! Lists all the available options and exits. |
| |
| ===== Command-line examples ===== | ==== Notes ==== |
| |
| Here is a small collection of examples demonstrating what is possible to accomplish with little shell-fu and some creativity. | * Conflicting options, such as two of -f, -w and -r, or -s together with -o, make xfce4-screenshooter print an error and exit. |
| Some of the commands below were extracted from feature requests to add very specific solutions, which would bloat xfce4-screenshooter's UI but are easily doable with command line. | * Options that are ignored because -f, -w or -r is missing produce a warning on the terminal. |
| | * When an action is given on the command line, xfce4-screenshooter runs non-interactively: errors are printed to the terminal and the program exits with a non-zero status, which makes it suitable for scripts. |
| | |
| | ==== Command-line examples ==== |
| | |
| | Here is a small collection of examples demonstrating what is possible to accomplish with a little shell-fu and some creativity. Some of the commands below come from feature requests for very specific solutions, which would bloat xfce4-screenshooter's UI but are easy to achieve from the command line. |
| For increased convenience, it is also possible to assign keyboard shortcuts to commands with the help of xfce4-keyboard-settings or add launchers to xfce4-panel. | For increased convenience, it is also possible to assign keyboard shortcuts to commands with the help of xfce4-keyboard-settings or add launchers to xfce4-panel. |
| |
| [[|Back to Top]] | [[|Back to Top]] |
| ---- | ---- |
| | |
| [[:apps:xfce4-screenshooter:start:|Return to xfce4-screenshooter Main Documentation Page]] | [[:apps:xfce4-screenshooter:start:|Return to xfce4-screenshooter Main Documentation Page]] |