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

 <sect2 id="clockmail">
  <title>Clock and Mailcheck Applet</title>

   <para>
   <application>Clock and Mailcheck</application> applet, shown in <xref
   linkend="clockmailapplet-fig">, displays the current time and how
   much mail is in your mailbox.  It also notifies you when new mail
   arrives by flashing.   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 and Mailcheck</guimenuitem>
   </menuchoice>.
  </para>

  <figure id="clockmailapplet-fig">
   <title>Clock and Mailcheck Applet</title>
   <screenshot>
    <screeninfo>Clock and Mailcheck Applet</screeninfo>
    <graphic format="png" fileref="figures/clockmail_applet" 
    srccredit="muet">
    </graphic>
   </screenshot>
  </figure>


  <!-- ============= Usage  ================================ -->
  <sect3 id="clockmail-usage">
   <title>Usage</title>
   <para>
    View the time and number of messages in your inbox in the applet's
    display. The envelope will flash when new email arrives.
   </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="clockmail-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 and Mailcheck
       Applet</application>, inluding the applet's version and the
       author's name.
      </para>
     </listitem>

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


  <!-- ============= Customization ============================= -->
  <sect3 id="clockmail-prefs">
    <title>Customization</title>
    <para>
      You can customize <application>Clock and Mailcheck</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="clockmail-settings-fig">), which allows you to
      change various settings.
    </para>

    <figure id="clockmail-settings-fig">
     <title>Properties dialog</title>
     <screenshot>
      <screeninfo>Properties dialog</screeninfo>
      <graphic format="png" fileref="figures/clockmail-prefs-general"
      srccredit="Eric Baudais">
      </graphic>
     </screenshot>
    </figure>

    <para>
     The <interface>Properties</interface> dialogue is divided in two
     sections, one for general options and one for themes.
    </para>

    <para>
     The properties in the <guilabel>General</guilabel> tab are:
     <itemizedlist>

      <listitem>
       <para>
        Display time in 12 hours format (AM/PM) &mdash;  Check this
        button to show the time in 12-hour format. 
       </para>
      </listitem>

      <listitem>
       <para>
        Display time relative to GMT (Greenwich Mean Time) &mdash;
        This allows you to change the timezone
        <application>Clock and Mailcheck</application> 
        uses.  The time can be anything from twelve hours
        ahead of GMT to twelve hours behind it. Remember also to select
        the <guibutton>checkbox</guibutton>, to use the new
        timezone. Note that you can only alter the
        time by an integral number of hours.
       </para>
      </listitem>

      <listitem>
       <para>
        Mail file  &mdash; Enter you email inbox file which should be 
        checked for new mail. Typically, this is
        <filename>/var/spool/mail/yourusername</filename>
        or something similar. You can only enter one file.
       </para>
      </listitem>

      <listitem>
       <para>
        When new mail is received, run... &mdash; It is possible to
        execute commands when new mail arrives. 
        For example, it is very common for people to have a sound
        file played as mail arrives. You can put the command to 
        run and the file to run it on in this space and ensure the
        checkbox is checked for it to occur.
        If you have more than one command, you can separate them
        by a semi-colon. For example,
        <itemizedlist>
         <listitem>
          <para>
           <command>esdplay /full/path/to/file.wav</command>
          </para>
         </listitem>
         <listitem>
          <para>
           <command>cd /path/to/directory ; esdplay file.wav</command>
          </para>
         </listitem>
        </itemizedlist>
        These two have the same effect. You will need the full path
        for this, without using shortcuts such as <command>cd ~</command>.
       </para>
      </listitem>

      <listitem>
       <para>
        Always blink when new mail is waiting &mdash; If you select
        this <guibutton>checkbox</guibutton>, then the 
        red envelope will blink until you read your unread email. Normally,
        this is off, and the blinking lasts only a few seconds.
       </para>
      </listitem>

      <listitem>
       <para>
        Number of messages to consider mailbox full &mdash; Set the
        number of messages you mailbox must have to be considered
        <quote>full</quote>.  Certain themes will show a special
        symbol indicating the mailbox is full.
       </para>
      </listitem>

      <listitem>
       <para>
        When clicked, run... &mdash; When this is set, clicking
        the left mouse button on the applet will run a program. The default is
        to run the <application>Balsa</application> mail client. (If
        <application>Balsa</application> is not installed, nothing
        will happen.) Set this to be your favorite email program.
       </para>
      </listitem>

     </itemizedlist>
    </para>

    <para>
     The properties in the <guilabel>Theme</guilabel> tab allows you
     to set the appearance of <application>Clock and
     Mailcheck</application> applet. <application>Clock and
     Mailcheck</application> applet comes with many themes which are
     stored in  <filename>$PREFIX/clockmail/</filename>. By 
     default, it does not use a theme. Note that not all of the themes
     show both the time and the state of your mailbox. 
    </para>

    <figure id="clockmail-settings-theme-fig">
     <title>Properties dialog showing theme tab</title>
     <screenshot>
      <screeninfo>Properties dialog showing theme tab</screeninfo>
      <graphic format="png" fileref="figures/clockmail-prefs-theme"
      srccredit="Eric Baudais">
      </graphic>
     </screenshot>
    </figure>

    <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>Cancel</guibutton> button.
    </para>
  </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="clockmail-bugs">
   <title>Known Bugs and Limitations</title>
    <orderedlist>
     <listitem>
      <para>
        You can't change the time through the clock properties. This
        is not really a bug; it's because you must be root to alter 
        the time for the whole of the system, using the <command>
        date</command> command.
      </para>
     </listitem>
     <listitem>
      <para>
        If you adjust the system clock backwards using the <command>
        date</command> command, the clock will stop working until the
        system time reaches the time the clock displays. It will start
        working normally then.
      </para>
     </listitem>
     <listitem>
      <para>
        The mailcounter theme gets the number of messages in your inbox
        wrong.
      </para>
     </listitem>
     <listitem>
      <para>
        Several themes do not reshape to the size of a vertical panel and
        force the panel to be wider.
      </para>       
     </listitem>
     <listitem>
      <para>
        Doesn't handle multiple mailboxes.
      </para>
     </listitem>
    </orderedlist>
  </sect3>


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

  <sect3 id="clockmail-authors">
   <title>Authors</title>
   <para>
    <application>ClockMail</application> was written by John Ellis
    (<email>johne@bellatlantic.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 Telsa Gywnne
    (<email>telsa@linuxchix.org</email>) and Eric Baudais 
    (<email>baudais@okstate.edu</email>). Please send all comments and
    suggestions regarding this manual to the <ulink type="http"
    url="http://www.gnome.org/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://www.gnome.org/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 <citetitle>GNU General Public
    License</citetitle> 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
    <citetitle>GNU General Public License</citetitle> for more details.
   </para>
   <para>
    A copy of the <citetitle>GNU General Public License</citetitle> is
    included as an appendix to the <citetitle>GNOME Users
    Guide</citetitle>.  You may also obtain a copy of the
    <citetitle>GNU General Public License</citetitle> 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>