path: root/gnome-users-guide/gnome-users-guide-1.4/C/applets/clock-ug.sgml

 <sect2 id="clock">
  <title>Clock Applet</title>

   <para>
   <application>Clock</application> applet, shown in <xref
   linkend="clockapplet-fig">, is a simple applet which shows the
   time (and optionally the date too) in any of several formats.  To
   add this applet to a <interface>Panel</interface>, 
   right-click on the <interface>Panel</interface> and choose
   <menuchoice>
    <guimenu>Panel</guimenu>
    <guisubmenu>Add to panel</guisubmenu>
    <guisubmenu>Applet</guisubmenu>
    <guisubmenu>Clocks</guisubmenu>
    <guimenuitem>Clock</guimenuitem>
   </menuchoice>.
  </para>

  <figure id="clockapplet-fig">
   <title>Clock Applet</title>
   <screenshot>
    <screeninfo>Clock Applet</screeninfo>
    <graphic format="png" fileref="figures/clock_applet" 
    srccredit="muet">
    </graphic>
   </screenshot>
  </figure>

  <!-- ============= Usage  ================================ -->
  <sect3 id="clock-usage">
   <title>Usage</title>
   <para>
    <application>Clock</application> applet requires no user
    input. You may optionally configure it, as described below. 
   </para>

   <para>
    Right-clicking on the applet brings up a menu containing the
    following items:
    <itemizedlist>

     <listitem>
      <para>
       <guimenuitem>Properties&hellip;</guimenuitem> &mdash;
       opens the <link linkend="clock-prefs">
       <guilabel>Properties</guilabel></link> dialog.
      </para>
     </listitem>

     <listitem>
      <para>
       <guimenuitem>Help</guimenuitem> &mdash;
       displays this document.
      </para>
     </listitem>

     <listitem>
      <para>
       <guimenuitem>About&hellip;</guimenuitem> &mdash;
       shows basic information about <application>Clock
       Applet</application>, including the applet's version and the
       author's name.
      </para>
     </listitem>

    </itemizedlist>
   </para>
  </sect3>


  <!-- ============= Customization ============================= -->
  <sect3 id="clock-prefs">
    <title>Customization</title>
    <para>
      You can customize <application>Clock</application>
      applet by right-clicking on it and choosing
      <guimenuitem>Properties&hellip;</guimenuitem>. This will open the
      <interface>Properties</interface> dialog(shown in <xref
      linkend="clock-settings-fig">), which allows you to
      change various settings.
    </para>

    <figure id="clock-settings-fig">
     <title>Properties dialog</title>
     <screenshot>
      <screeninfo>Properties dialog</screeninfo>
      <graphic format="png" fileref="figures/clock_settings"
      srccredit="muet">
      </graphic>
     </screenshot>
    </figure>

    <para>
     The properties are:
     <itemizedlist>

      <listitem>
       <para>
        Time Format &mdash; Select either <guilabel>12 hour</guilabel>
        format for <quote>AM/PM</quote> formatted time, or
        <guilabel>24 hour</guilabel> for a 24 hour clock.
       </para>
      </listitem>

      <listitem>
       <para>
        Show date in applet &mdash; Select this to show the date
        inside the applet.
       </para>
      </listitem>

      <listitem>
       <para>
        Show date in tooltip &mdash; Select this to show the date in
        the tooltip that pops up when the mouse is briefly left over
        the applet.
       </para>
      </listitem>

      <listitem>
       <para>
        Use GMT &mdash; Select this to show the Greenwich Mean Time
        instead of the local time.
       </para>
      </listitem>

      <listitem>
       <para>
        Unix time &mdash; Select this to show the time, in seconds,
        that has elapsed since Jan 1, 1970.
       </para>
      </listitem>

     </itemizedlist>
    </para>

    <para> 
      After you have made all the changes you want, click on
      <guibutton>OK</guibutton> to apply the changes and close the
      <interface>Properties</interface> dialog. To cancel the changes
      and return to previous values, click the
      <guibutton>Close</guibutton> button.
    </para>

   <note>
    <title>Setting the Time</title>
    <para>
     <application>Clock</application> applet only displays the time;
     it does not allow you to set the time.  In order to set the time
     on a Unix or Linux system, you should use the
     <command>date</command> command. For example, to set the time to
     11:43:01PM and the date to April 4, use <command>date --set="Apr
     4 23:43:01"</command>. Note that you must be logged in as root to
     set the time. More information about the <command>date</command> command is
     available from the <ulink type="man" url="man:date">date manual page</ulink>.
     You may set your timezone using the <command>timeconfig</command> or
     <command>tzselect</command> commands on some Linux
     distributions.
    </para>
   </note>

  </sect3>


  <!-- ============= Bugs ================================== -->
  <!-- This section should describe known bugs and limitations of
       the program if there are any - please be frank and list all
       problems you know of -->
  <sect3 id="clock-bugs">
   <title>Known Bugs and Limitations</title>
   <para>
    This applet has no known bugs.
   </para>
  </sect3>


  <!-- ============= Authors ================================ -->

  <sect3 id="clock-authors">
   <title>Authors</title>
   <para>
    <application>Clock</application> was written by Miguel de Icaza
    (<email>miguel@kernel.org</email>), Federico Mena
    (<email>quartic@gimp.org</email>), and Stuart Parmenter
    (<email>pavlov@innerx.net</email>).  Please send all comments,
    suggestions, and bug 
    reports to the <ulink url="http://bugs.gnome.org/" type="http">GNOME
    bug tracking database</ulink>. (Instructions for submitting bug
    reports can be found <ulink
    url="http://bugs.gnome.org/Reporting.html" type="http">
    on-line</ulink>. If you are using
    GNOME 1.1 or later, you can also use <application>Bug Report
    Tool</application> (<command>bug-buddy</command>), available in the
    <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
    Menu</guimenu>, for submitting bug reports.
   </para>

   <para>
    This manual was written by Dan Mueth
    (<email>d-mueth@uchicago.edu</email>). Please send all comments and
    suggestions regarding this manual to the <ulink type="http"
    url="http://developer.gnome.org/projects/gdp/">GNOME Documentation Project</ulink> 
    by sending an email to <email>docs@gnome.org</email>. You can also
    submit comments online by using the <ulink type="http"
    url="http://developer.gnome.org/projects/gdp/doctable/">GNOME Documentation Status
    Table</ulink>.
   </para>

   <!-- For translations: uncomment this:

   <para>
    Latin translation was done by ME
    (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
    suggestions regarding this translation to SOMEWHERE.
   </para>

   -->

  </sect3>


  <!-- ============= Application License ============================= -->

  <!-- 
   <sect3 id="license">
   <title>License</title>
   <para>
    This program is free software; you can redistribute it and/or
    modify it under the terms of the <ulink type="help"
    url="gnome-help:gpl"><citetitle>GNU General Public
    License</citetitle></ulink> as published by the Free Software
    Foundation; either version 2 of the License, or (at your option)
    any later version.
   </para>
   <para>
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General
    Public License</citetitle></ulink> for more details.
   </para>
   <para>
    A copy of the <ulink type="help"
    url="gnome-help:gpl"><citetitle>GNU General Public
    License</citetitle></ulink> is included with the GNOME
    documentation.  You may also obtain a copy of the <ulink
    type="help" url="gnome-help:gpl"><citetitle>GNU General Public
    License</citetitle></ulink> from the Free Software Foundation by
    visiting <ulink type="http" url="http://www.fsf.org/">their Web
    site</ulink> or by writing to
    <address>
     Free Software Foundation, Inc.
     <street>59 Temple Place</street> - Suite 330
     <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
     <country>USA</country>
    </address>
   </para>
  </sect3>

 --> 
 </sect2>