Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
apps:xfce4-screenshooter:usage [2020/09/27 17:30] – created kevinbowenapps:xfce4-screenshooter:usage [2025/01/15 23:12] (current) – [xfce4-screenshooter - Usage] kevinbowen
Line 1: Line 1:
 ~~NOTOC~~ ~~NOTOC~~
 {{ :apps:xfce4-screenshooter.png?nolink|}} {{ :apps:xfce4-screenshooter.png?nolink|}}
-====== xcfe4-screenshooter - Using the application ======+====== xfce4-screenshooter - Usage ======
  
   * **[[#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™]]** 
-  * **[[#Via command-line|Via command-line]]**+  * **[[#Command-line options|Command-line options]]**
  
 ---- ----
  
-===== Via the user interface =====+===== Open the user interface =====
  
 To launch the application, use the {gui>Screenshot} item in the {gui>Accessories} category of Xfce's main menu. To launch the application, use the {gui>Screenshot} item in the {gui>Accessories} category of Xfce's main menu.
Line 18: Line 18:
 ===== Taking a screenshot ===== ===== Taking a screenshot =====
  
-<figure "Take a screenshot"> +<figure "xfce4-screenshooter Main Dialog Window"> 
-{{:apps:screenshooter:xfce4-screenshooter-dialog1.png?nolink|}}+{{:apps:xfce4-screenshooter:xfce4-screenshooter-dialog1.png?nolink|xfce4-screenshooter Main Dialog Window}}
 </figure> </figure>
 +
 +----
  
 ==== Region to capture ==== ==== Region to capture ====
Line 31: Line 33:
 ? Select a region ? Select a region
 ! 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. You can also press Ctrl while dragging to move the rectangle. ! 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. You can also press Ctrl while dragging to move the rectangle.
-? Capturing the pointer +? Capture the mouse pointer 
-! The {gui>Capture the mouse pointer} option allows you to select whether or not the screenshot will include the mouse pointer.+! This option allows you to select whether the screenshot will include the mouse pointer. 
 +? Capture the window border 
 +! This option allows you to select whether the screenshot will include the window border. Only available for the Active window region. 
 + 
 +For an explanation about {gui>Preferences}, please consult [[apps:xfce4-screenshooter:custom-actions|Custom Actions]]. 
  
 ==== Delay before capturing ==== ==== Delay before capturing ====
Line 46: Line 53:
 After pressing the {gui>OK} button a second window will be displayed:  After pressing the {gui>OK} button a second window will be displayed: 
  
-<figure "Action"> +<figure "xfce4-screenshooter Action Window"> 
-{{:apps:screenshooter:xfce4-screenshooter-dialog2.png?600x300|}}+{{:apps:xfce4-screenshooter:xfce4-screenshooter-dialog2.png?600|xfce4-screenshooter Action Window}}
 </figure> </figure>
  
Line 65: Line 72:
 ? Open with ? Open with
 ! 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.
-? Host on Imgur +? Custom Action 
-! 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.+! 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]].
  
 [[|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, this same feature can be accomplished using a configurable [[:apps:xfce4-screenshooter:custom-actions#host_on_imgur|custom action]].
- +
-<figure "Imgur image link"> +
-{{:apps:screenshooter:xfce4-screenshooter-imgur-link-dialog.png?nolink|}} +
-</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"> +
-{{:apps:screenshooter:xfce4-screenshooter-imgur-embed-dialog.png?nolink|}} +
-</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"> +
-{{:apps:screenshooter:xfce4-screenshooter-imgur-deletion-dialog.png?nolink|}} +
-</figure> +
- +
-Linking images of Imgure accounts is not currently supported.+
  
 [[|Back to Top]] [[|Back to Top]]
 ---- ----
  
-===== Via command-line =====+===== 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. 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.
Line 103: Line 92:
  
 ? The -w option ? The -w option
-! The -w option allows you to take a screenshot of the active window.+! The -w or --window option allows you to take a screenshot of the active window. 
 ? The -f option ? The -f option
-! The -f option allows you to take a screenshot of the entire screen.+! The -f or --fullscreen option allows you to take a screenshot of the entire screen. 
 ? The -r option ? The -r option
-! The -r 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.+! 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. 
 ? The -d option ? The -d option
-! The -d option followed by a positive integer allows you to set the delay before taking the screenshot when the -w, the -f or the -r option is given.+! 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 ? The -s option
-! The -s option followed by the path to an existing folder allows you to set where the screenshots are saved. This option only has an effect if the -w, the -f or the -r option 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 
 +! 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. 
 ? The -o option ? The -o option
-! If the -o 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, the -f or the -r option is given. +! 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 -u option + 
-! If the -u option is given, the screenshot will be hosted on Imgur. See above for more details. This option only has an effect if the -w, the -f or the -r option is given. +? The -i option 
 +! 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 
 +! 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. 
 + 
 +? The --no-border option 
 +! If the --no-border option is given, the window borders are removed from the screenshot. 
 + 
 +? The --supported-formats option 
 +! 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. 
 + 
 +===== Command-line examples ===== 
 + 
 +Here is a small collection of examples demonstrating what is possible to accomplish with little shell-fu and some creativity. 
 +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. 
 +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. 
 + 
 +<code> 
 +# Take fullscreen screenshot and save to desktop without asking the file name 
 +xfce4-screenshooter -f -s "$HOME/Desktop/Screenshot_$(date +%Y-%m-%d_%H-%M-%S).png" 
 + 
 +# Take screenshots at regular intervals and stop after 8 captures 
 +# repeat is a zsh built-in function, use for or while when using other shells 
 +repeat 8 sh -c 'xfce4-screenshooter -f -s ~/Desktop/$(date +%Y%m%d_%H%M%S).png; sleep 5.25' 
 +</code>
  
 [[|Back to Top]] [[|Back to Top]]
 ---- ----
-[[:apps:screenshooter:start:|Back to xfce-screenshooter main page]]+[[:apps:xfce4-screenshooter:start:|Return to xfce4-screenshooter Main Documentation Page]]