Warning, /graphics/spectacle/doc/man-spectacle.1.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?> 0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ 0003 <!ENTITY % English "INCLUDE"> 0004 ]> 0005 0006 <refentry lang="&language;"> 0007 <refentryinfo> 0008 <title>Spectacle User's Manual</title> 0009 <author><firstname>Yuri</firstname><surname>Chornoivan</surname> 0010 <contrib>Spectacle man page.</contrib> 0011 <email>yurchor@ukr.net</email></author> 0012 <date>2023-11-26</date> 0013 <releaseinfo>Spectacle 23.08</releaseinfo> 0014 <productname>KDE Applications</productname> 0015 </refentryinfo> 0016 0017 <refmeta> 0018 <refentrytitle><command>spectacle</command></refentrytitle> 0019 <manvolnum>1</manvolnum> 0020 </refmeta> 0021 0022 <refnamediv> 0023 <refname>spectacle</refname> 0024 <refpurpose>screenshot capture Utility</refpurpose> 0025 </refnamediv> 0026 <!-- body begins here --> 0027 <refsynopsisdiv id='synopsis'> 0028 <cmdsynopsis> 0029 <command>spectacle</command> 0030 <arg choice="opt"><replaceable>Spectacle options</replaceable></arg> 0031 </cmdsynopsis> 0032 </refsynopsisdiv> 0033 0034 0035 <refsect1 id="description"><title>Description</title> 0036 <para><command>spectacle</command> is a simple application for capturing desktop screenshots. It can capture images of the entire desktop, a single monitor, the currently active window, the window currently under the mouse, or a rectangular region of the screen. The images can then be annotated, printed, sent to other applications for manipulation, or quickly be saved as-is.</para> 0037 0038 </refsect1> 0039 0040 <refsect1 id="options"><title>Spectacle options</title> 0041 <variablelist> 0042 0043 <varlistentry> 0044 <term><option>-h, --help</option></term> 0045 <listitem> 0046 <para>Displays help on commandline options.</para> 0047 </listitem> 0048 </varlistentry> 0049 0050 <varlistentry> 0051 <term><option>--help-all</option></term> 0052 <listitem> 0053 <para>Displays help including Qt specific options.</para> 0054 </listitem> 0055 </varlistentry> 0056 0057 <varlistentry> 0058 <term><option>-v, --version</option></term> 0059 <listitem> 0060 <para>Displays version information.</para> 0061 </listitem> 0062 </varlistentry> 0063 0064 <varlistentry> 0065 <term><option>-f, --fullscreen</option></term> 0066 <listitem> 0067 <para>Capture the entire desktop (default).</para> 0068 </listitem> 0069 </varlistentry> 0070 0071 <varlistentry> 0072 <term><option>-m, --current</option></term> 0073 <listitem> 0074 <para>Capture the current monitor.</para> 0075 </listitem> 0076 </varlistentry> 0077 0078 <varlistentry> 0079 <term><option>-a, --activewindow</option></term> 0080 <listitem> 0081 <para>Capture the active window.</para> 0082 </listitem> 0083 </varlistentry> 0084 0085 <varlistentry> 0086 <term><option>-u, --windowundercursor</option></term> 0087 <listitem> 0088 <para>Capture the window currently under the cursor, including parents of pop-up menus.</para> 0089 </listitem> 0090 </varlistentry> 0091 0092 <varlistentry> 0093 <term><option>-t, --transientonly</option></term> 0094 <listitem> 0095 <para>Capture the window currently under the cursor, excluding parents of pop-up menus.</para> 0096 </listitem> 0097 </varlistentry> 0098 0099 <varlistentry> 0100 <term><option>-r, --region</option></term> 0101 <listitem> 0102 <para>Capture a rectangular region of the screen.</para> 0103 </listitem> 0104 </varlistentry> 0105 0106 <varlistentry> 0107 <term><option>-l, --launchonly</option></term> 0108 <listitem> 0109 <para>Launch Spectacle without taking a screenshot.</para> 0110 </listitem> 0111 </varlistentry> 0112 0113 <varlistentry> 0114 <term><option>-g, --gui</option></term> 0115 <listitem> 0116 <para>Start in GUI mode (default).</para> 0117 </listitem> 0118 </varlistentry> 0119 0120 <varlistentry> 0121 <term><option>-b, --background</option></term> 0122 <listitem> 0123 <para>Take a screenshot and exit without showing the GUI.</para> 0124 </listitem> 0125 </varlistentry> 0126 0127 <varlistentry> 0128 <term><option>-s, --dbus</option></term> 0129 <listitem> 0130 <para>Start in DBus-Activation mode.</para> 0131 </listitem> 0132 </varlistentry> 0133 0134 <varlistentry> 0135 <term><option>-n, --nonotify</option></term> 0136 <listitem> 0137 <para>In background mode, do not pop up a notification when the screenshot is taken.</para> 0138 </listitem> 0139 </varlistentry> 0140 0141 <varlistentry> 0142 <term><option>-o, --output <replaceable>fileName</replaceable></option></term> 0143 <listitem> 0144 <para>In background mode, save image to specified file <replaceable>fileName</replaceable>.</para> 0145 </listitem> 0146 </varlistentry> 0147 0148 <varlistentry> 0149 <term><option>-d, --delay <replaceable>delayMsec</replaceable></option></term> 0150 <listitem> 0151 <para>In background mode, delay before taking the shot (in milliseconds).</para> 0152 </listitem> 0153 </varlistentry> 0154 0155 <varlistentry> 0156 <term><option>-c, --copy-image</option></term> 0157 <listitem> 0158 <para>In background mode, copy screenshot only to clipboard, unless -o is also used.</para> 0159 </listitem> 0160 </varlistentry> 0161 0162 <varlistentry> 0163 <term><option>-C, --copy-path</option></term> 0164 <listitem> 0165 <para>In background mode, copy screenshot file path to clipboard.</para> 0166 </listitem> 0167 </varlistentry> 0168 0169 <varlistentry> 0170 <term><option>-w, --onclick</option></term> 0171 <listitem> 0172 <para>Wait for a click before taking screenshot. Invalidates delay..</para> 0173 </listitem> 0174 </varlistentry> 0175 0176 <varlistentry> 0177 <term><option>-i, --new-instance</option></term> 0178 <listitem> 0179 <para>Starts a new GUI instance of spectacle without registering to DBus.</para> 0180 </listitem> 0181 </varlistentry> 0182 0183 <varlistentry> 0184 <term><option>-p, --pointer</option></term> 0185 <listitem> 0186 <para>In background mode, include pointer in the screenshot.</para> 0187 </listitem> 0188 </varlistentry> 0189 0190 <varlistentry> 0191 <term><option>-e, --no-decoration</option></term> 0192 <listitem> 0193 <para>In background mode, do not include window decorations in the screenshot.</para> 0194 </listitem> 0195 </varlistentry> 0196 0197 <varlistentry> 0198 <term><option>-E, --edit-existing <replaceable>existingFileName</replaceable></option></term> 0199 <listitem> 0200 <para>Open and edit existing screenshot file.</para> 0201 </listitem> 0202 </varlistentry> 0203 </variablelist> 0204 </refsect1> 0205 0206 <refsect1 id="feedback"><title>Feedback</title> 0207 <para>On IRC, irc.libera.chat #kde or via email, kde-graphics-devel@kde.org or on the web, <<ulink url="https://apps.kde.org/spectacle">https://apps.kde.org/spectacle</ulink>></para> 0208 </refsect1> 0209 0210 <refsect1> 0211 <title>See Also</title> 0212 <simplelist> 0213 <member>More detailed user documentation is available from <ulink 0214 url="help:/spectacle">help:/spectacle</ulink> 0215 (either enter this <acronym>URL</acronym> into &konqueror;, or run 0216 <userinput><command>khelpcenter</command> 0217 <parameter>help:/spectacle</parameter></userinput>).</member> 0218 <member>kf5options(7)</member> 0219 <member>qt5options(7)</member> 0220 <member>There is also further information available at 0221 <ulink url="https://apps.kde.org/spectacle">https://apps.kde.org/spectacle</ulink></member> 0222 </simplelist> 0223 </refsect1> 0224 0225 <refsect1 id="copyright"><title>Copyright</title> 0226 <para>Copyright © 2015 Boudhayan Gupta</para> 0227 <para>License: GNU General Public Version 2 <<ulink url="https://www.gnu.org/licenses/gpl-2.0.html">https://www.gnu.org/licenses/gpl-2.0.html</ulink>></para> 0228 </refsect1> 0229 </refentry> 0230