wmnotify/doc/wmnotify.man

   1 .TH WMNOTIFY 1 "February 2004" "wmnotify" "User's Manual"
   2
   3 .SH NAME
   4 wmnotify \- Dockable email notification program for single POP3 or IMAP4 account
   5
   6 .SH SYNOPSIS
   7 .B wmnotify
   8 [\fIOPTION\fR]...
   9
  10 .SH DESCRIPTION
  11 \fBwmnotify\fR is a dockable application (DockApp) for the WindowMaker window
  12 manager to periodically check a POP3 or IMAP4 email account for new messages.
  13 If there are new messages in the mailbox, a simple animation is displayed
  14 and an optional sound (or beep) is produced.
  15
  16 \fBwmnotify\fR now supports SSL encryption.
  17
  18 The interface is kept very simple. To manually check for new messages,
  19 single-click on the mailbox image. To start your favorite email program,
  20 double-click on the mailbox image.
  21
  22 When you double-click on the mailbox image to start your email program,
  23 the new messages animation is stopped, assuming that you will read your new
  24 messages. If you don't, the wmnotify program will simply continue it's
  25 periodic checking of your email account and will restart the new messages
  26 animation after the usual delay if new messages are unread.
  27
  28 By default, the interval between checks is 5 minutes, and this can be changed
  29 in the configuration file. You can also enable audio notification as well as
  30 specify an optional audio sound file (WAV or AU). If audio notification is
  31 enabled but no audio sound file is specified, a beep will be produced. There is
  32 an option in the configuration file to adjust the volume of the sound file.
  33
  34 .SH "OPTIONS"
  35 .TP
  36 .BI "\-\^c " config-file
  37 .B wmnotify
  38 reads your mail account settings and preferences from the specified
  39 configuration file. This option overrides the use of the default config file,
  40 .IR "$HOME/.wmnotifyrc". Make sure that the alternate configuration file has
  41 correct permissions (normally 0400) to protect your email account informations.
  42
  43 .TP
  44 \fB\-d\fR
  45 Display debugging messages.
  46
  47 .TP
  48 .BI \-display " host" : display
  49 Specifies the host and screen to be used by \fBwmnotify\fR. By default this
  50 is obtained from the environment variable
  51 .SB DISPLAY.
  52
  53 .TP
  54 .BI \-geometry " geometry"
  55 .RB ( *geometry )
  56 Specifies the initial geometry of the window.
  57
  58 .TP
  59 \fB\-h\fR
  60 display usage and exit
  61 .TP
  62 \fB\-v\fR
  63 output version information and exit
  64
  65 .SH "CONFIGURATION FILE"
  66 .IR $HOME/.wmnotifyrc
  67
  68 The first time the program is run, it will check for the presence of the
  69 configuration file in the user's home directory. If this file is not found,
  70 wmnotify will automatically create a new one, and exit with a message telling the
  71 user to set it's mail account settings and preferences in the new configuration file
  72 before restarting wmnotify.
  73
  74 .TP
  75 .BI "protocol " <protocol-name>
  76 mail account protocol, POP3 or IMAP4.
  77
  78 .TP
  79 .BI "imap_folder " <folder-name>
  80 IMAP folder name (optional, default is INBOX).
  81
  82 .TP
  83 .BI "use_ssl "  <value>
  84 This option controls the SSL encryption enabling/disabling. The value may be
  85 set to "0" to disable or to "1" to enable.
  86
  87 .TP
  88 .BI "server " <server-name>
  89 mail server name (or IP address).
  90
  91 .TP
  92 .BI "port " <port-number>
  93 mail server port number (optional, default value is 110).
  94
  95 .TP
  96 .BI "username " <username>
  97 mail account username.
  98
  99 .TP
 100 .BI "password " <password>
 101 mail account password.
 102
 103 .TP
 104 .BI "mailcheckdelay " <delay-in-minutes>
 105 Mail check interval, in minutes (optional, default value is 5).
 106
 107 .TP
 108 .BI "mailclient " <program>
 109 The program to start when double-clicking on the mailbox image (optional).
 110
 111 .TP
 112 .BI "enablebeep " <value>
 113 This option controls the audio notification enabling/disabling. If this option
 114 is enabled and the "audiofile" option below contains a valid audio file, it
 115 will be played whenever new message(s) are detected. If "audiofile" is
 116 commented, the console beep will be used to produce the audio notification. The
 117 value may be set to "0" to disable or to "1" to enable (optional, default value is 0, disabled).
 118
 119 .TP
 120 .BI "audiofile " <path-to-audiofile>
 121 Path and filename of the WAV or AU audio sound file to play when new message(s)
 122 are detected (optional).
 123
 124 .TP
 125 .BI "volume " <value>
 126 Volume value, in percent, when playing an audio file (optional, default value is
 127 100%). This volume value is relative to the values you have set in your sound
 128 card mixer settings. If you find the audio notification sound to be too loud,
 129 just reduce the volume value. On the other hand, if you want to increase the
 130 audio notification sound amplitude, just increase the volume. If you increase
 131 the volume value to 100% and you find that it is not sufficient, then you would
 132 have to increase the volume using your favorite sound card mixer program
 133 (ex: with alsamixer, increase the PCM or master value).
 134
 135 .SH CREDITS
 136 \fBwmnotify\fR was written by Hugo Villeneuve <hugo@hugovil.com>, based on
 137 the WMPop3 program by Scott Holden <scotth@thezone.net>.
 138
 139 .SH COPYRIGHT
 140 \fBwmnotify\fR is free; anyone may redistribute it to anyone under the terms
 141 stated in the GNU General Public License. A copy of the license is included in
 142 the \fBwmnotify\fR distribution. You can also browse it online at
 143 .I http://www.gnu.org/copyleft/gpl.html