<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!--ARC : LSARC 2001/348 GNOME Panel-->
<!ENTITY cmd "gnome-screenshot">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2003,2006,2007 Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="gnome-screenshot-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>gnome-screenshot</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">09 Nov 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>gnome-screenshot</primary></indexterm><indexterm><primary>gnome-panel-screenshot</primary></indexterm><indexterm>
<primary>GNOME screenshot utility</primary></indexterm><refnamediv id="gnome-screenshot-1-name">
<refname>gnome-screenshot</refname><refname>gnome-panel-screenshot</refname><refpurpose>GNOME screenshot utility</refpurpose>
</refnamediv>
<refsynopsisdiv id="gnome-screenshot-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command> 
<arg choice="opt"><option>-border-effect=<replaceable>effect</replaceable></option></arg>
<arg choice="opt"><option>-delay=<replaceable>int</replaceable></option></arg>
<arg choice="opt"><option>-include-border</option></arg>
<arg choice="opt"><option>-interactive</option></arg>
<arg choice="opt"><option>-window</option></arg>
<arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1 id="gnome-screenshot-1-desc"><title>&desc-tt;</title>
<para><command>&cmd;</command> allows users to capture the screen image of a window or
the complete screen.  <command>gnome-panel-screenshot</command> is a symlink to 
<command>&cmd;</command>.</para>

<para>If the <option>-window</option> option is used, you must move the mouse
pointer to the window to be captured. The <option>-delay</option> option is
always used with the <option>-window</option> option, to allow sufficient
delay to set up the required screenshot. Once you have captured the window
region, you are presented with a dialog showing a preview of the snapshot and the
choice to save the image.
</para>
</refsect1>

<refsect1 id="gnome-screenshot-1-opts"><title>&opts-tt;</title>
<para>The following options are supported:</para>
<variablelist termlength="medium">
<variablelist><varlistentry><term><option>-border-effect=<replaceable>effect</replaceable></option></term>
<listitem><para>Effect to add to the border.</para>
</listitem></varlistentry>
<variablelist><varlistentry><term><option>-delay=<replaceable>int</replaceable></option></term>
<listitem><para>
Pause for <replaceable>int</replaceable> seconds before capturing
the window or screen</para>
</listitem></varlistentry>
<varlistentry><term><option>-include-border</option></term>
<listitem><para>
Include the window border with the screenshot.</para>
</listitem></varlistentry>
<varlistentry><term><option>-interactive</option></term>
<listitem><para>
Interactively set options.
</listitem></varlistentry>
<varlistentry><term><option>-window</option></term>
<listitem><para>
Capture a screenshot of the window in which the mouse pointer
is located.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term>
<listitem><para>
<listitem><para>Standard options available for use with most GNOME applications.
See <citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>
5</manvolnum></citerefentry> for more information.</para>
</listitem></varlistentry>
</variablelist>
</variablelist></refsect1>
<refsect1 id="gnome-screenshot-1-exam"><title>&exam-tt;</title>
<example role="example"><title>Capturing the full screen</title>
<para><screen>example% <userinput>&cmd; </userinput></screen></para>
</example>
</refsect1>
<refsect1 id="gnome-screenshot-1-exit"><title>&exit-tt;</title>
<para>The following exit values are returned:</para>
<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>
<listitem><para>Application exited successfully</para>
</listitem></varlistentry>
<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
exited with failure</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gnome-screenshot-1-file"><title>&file-tt;</title>
<para>The following files are used by this application:</para>
<variablelist termlength="wide">
<varlistentry><term><filename>/usr/bin/&cmd;</filename> 
</term><listitem><para>Executable for GNOME screenshot utility.</para>
</listitem></varlistentry>
<varlistentry><term><filename>/usr/bin/gnome-panel-screenshot</filename> 
</term><listitem><para>Symbolic link to run <command>&cmd;</command>.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="gnome-screenshot-1-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row><entry><para>Availability</para></entry><entry><para>gnome/gnome-screenshot
</para></entry></row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="gnome-screenshot-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle> for your platform.</para>
<para>
<citerefentry><refentrytitle>gnome-panel</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="gnome-screenshot-1-note"><title>&note-tt;</title>
<para>Written by Ghee Teo, Sun Microsystems Inc., 2003, 2006, 2007.</para>
</refsect1>
</refentry>
