summaryrefslogtreecommitdiffstats
path: root/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml')
-rw-r--r--gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml345
1 files changed, 345 insertions, 0 deletions
diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml
new file mode 100644
index 0000000..bd9f554
--- /dev/null
+++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml
@@ -0,0 +1,345 @@
+ <sect2 id="applets-core-mailcheck">
+ <title>The Mail Check Applet</title>
+
+ <para>
+ The <application>mailcheck applet</application> is an applet which
+ sits in your panel and tells you when you have new email. To add
+ this applet to the panel, right-click on the panel and choose
+ <menuchoice>
+ <guimenu>Add applet</guimenu>
+ <guisubmenu>Network</guisubmenu>
+ <guimenuitem>Mailcheck</guimenuitem>
+ </menuchoice>
+ </para>
+
+ <figure id="mailcheck-applets-core-fig">
+ <title>Mail Check Applet</title>
+ <screenshot>
+ <screeninfo>Mail Check Applet</screeninfo>
+ <graphic format="png" fileref="figures/mailcheck-applet"
+ srccredit="Eric Baudais">
+ </graphic>
+ </screenshot>
+ </figure>
+
+ <sect3 id="mailcheck-usage">
+ <title> Usage</title>
+ <para>
+ You don't need to do anything in particular to run this applet.
+ Providing it is looking in the right place for your email, it
+ will run itself quite happily. The following options, however,
+ are available:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Clicking <mousebutton>mouse button 1</mousebutton> does nothing
+ unless you have told it to start a program when you do this. You
+ do this with the properties box described <link
+ linkend="mailcheck-prefs">below</link>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Holding down <mousebutton>mouse button 2</mousebutton> allows
+ you to drag the applet around the panel (and between panels).
+ option.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Clicking <mousebutton>mouse button 3</mousebutton> brings up
+ the typical <guimenu>applet menu</guimenu> which includes an
+ About box and a <link linkend="mailcheck-prefs">properties</link>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <sect3 id="mailcheck-prefs">
+ <title>Preferences</title>
+ <para>
+ The mailcheck <interface>properties dialogue box</interface> is
+ divided into two sections, one for what the mail check applet
+ does, and one for where it checks for email.
+ </para>
+
+ <figure id="mailcheck-settings-mailcheck-fig">
+ <title>Properties dialog &mdash; Mail check tab</title>
+ <screenshot>
+ <screeninfo>Properties dialog - Mail check tab</screeninfo>
+ <graphic format="png" fileref="figures/mailcheck-properties-mailcheck"
+ srccredit="Eric Baudais">
+ </graphic>
+ </screenshot>
+ </figure>
+
+ <variablelist>
+ <varlistentry>
+ <term>Mail check options</term>
+ <listitem>
+ <para>
+ The mail check options have six sections:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>Execute...before each update</term>
+ <listitem>
+ <para>
+ Sometimes you may want to run something such as
+ <application>fetchmail</application> before the applet
+ checks for new mail. To do this, check the checkbox and
+ fill in the program name in the space here.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Execute...when new mail arrives</term>
+ <listitem>
+ <para>
+ Sometimes you may want other programs to run when new mail
+ arrives. It is common to tell the machine to play a noise
+ at you, for example. Checking this checkbox and filling in
+ the command (such as <command>mpg123
+ <replaceable>sillynoise.mpg</replaceable></command> or
+ <command>esdplay
+ <replaceable>sillynoise.wav</replaceable></command>) will
+ let this happen.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Execute...when clicked</term>
+ <listitem>
+ <para>
+ By putting a program name (generally a mail-reader such as
+ <application>balsa</application> or <application>spruce</application>
+ here and clicking on the checkbox, you can set things up so that
+ when you click <mousebutton>button 1</mousebutton> on the
+ applet, that program will be automatically run.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Check for mail every...</term>
+ <listitem>
+ <para>
+ You can adjust the range for checking whether mail has arrived
+ between 1440 minutes (once a day) to never. Setting it to never
+ is silly and will confuse it. The default value is every two
+ minutes.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Play a sound when new mail arrives</term>
+ <listitem>
+ <para>
+ The sound played if you check this <guibutton>checkbox</guibutton>
+ is an alarm bell. It is contained in
+ <filename>$prefix/sound/events/mailcheck.soundlist</filename>;
+ if you want to change it to a different sound, alter that and
+ put the sound in <filename>$prefix/sounds/</filename>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Select animation</term>
+ <listitem>
+ <para>
+ By clicking on the <guilabel>box with the animation name</guilabel>,
+ you can get a list of different pictures which have different
+ animations when new email arrives.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <figure id="mailcheck-settings-mailbox-fig">
+ <title>Properties dialog &mdash; Mailbox tab</title>
+ <screenshot>
+ <screeninfo>Properties dialog - Mailbox tab</screeninfo>
+ <graphic format="png" fileref="figures/mailcheck-properties-mailbox"
+ srccredit="Eric Baudais">
+ </graphic>
+ </screenshot>
+ </figure>
+
+ <variablelist>
+ <varlistentry>
+ <term>Mailbox options</term>
+ <listitem>
+ <para>
+ The mailbox options have four sections, some of which will be
+ greyed-out.
+ </para>
+
+ <para>
+ By clicking on the <guilabel>box with the mailbox location</guilabel>,
+ you can tell the mailcheck applet where to look for your incoming
+ email.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ When local mailspool or local maildir are selected as the location
+ for the mailbox, then you can fill in the details on which file
+ or directory the applet should check for new email. You can only
+ put one filename here. The section about mail servers will be
+ greyed out.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When remote POP3 or remote IMAP are selected as the location for
+ the mailbox, then you can fill in the details on the mail server,
+ username and password. If the you don't supply the password, the
+ applet will ask for it when it first tries to check for mail.
+ The section about local filenames will be greyed out.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect3>
+
+ <sect3 id="mailcheck-bugs">
+ <title> Known bugs and limitations</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Setting something to be executed before each update can hang the
+ applet and the panel.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Sometimes the animation stops happening after prolonged use.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If you use a mail filter such as <application>procmail</application>,
+ which sorts email into different folders, the applet won't check them
+ all for new email. It will only look at one file.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+
+ <!-- ============= Authors ================================ -->
+
+ <sect3 id="mailcheck-authors">
+ <title>Authors</title>
+ <para>
+ <application>Mail Check</application> was written by
+ Miguel de Icaza (<email>miguel@gnu.org</email>),
+ Jacob Berkman (<email>jberkman@andrew.cmu.edu</email>),
+ Jaka Mocnik (<email>jaka.mocnik@kiss.uni-lj.si</email>) and
+ Lennart Poettering (<email>poettering@gmx.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 Gwynne
+ (<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://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
+ also may 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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+