wmckgmail-1.1/wmckgmail/wmckgmail.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH WMCKGMAIL 1 "September 09, 2006"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 wmckgmail 1.1 \- A dockapp to monitor the number of unread mails in a gmail inbox.
  20 .SH DESCRIPTION
  21 This manual page documents briefly the
  22 .B wmckgmail
  23 command.
  24 .PP
  25 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  26 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  27 .\" respectively.
  28 \fBwmckgmail\fP is a very simple program used to monitor the number of unread mails
  29 in a gmail inbox. It uses the
  30 .B wget
  31 command to get the gmail
  32 .B atom
  33 feed and reads the number of new mails from this feed. It is a dockapp
  34 that is supported by X window managers such as Window Maker, AfterStep, BlackBox, Fluxbox and
  35 Enlightenment.
  36
  37 .TP
  38 This dockapp is quite simple. It contains the gmail \fBM\fP icon and a small counter. When the program is unable to access gmail, the counter shows the "\fBERR\fP" string and the \fBM\fP icon is greyed. When gmail is accessible and your configuration file contain a valid username/password combo, the counter indicate the number of new mails in the gmail inbox. If there is no unread mails in the gmail inbox, the \fBM\fP icon stays greyed. If there is unread mails in the gmail inbox, the \fBM\fP icon then takes its real colors and the counter indicates the number of unread mails.
  39
  40 .SH OPTIONS
  41 This program has no command line options.
  42
  43 .SH CONFIGURATION
  44 This program needs a configuration file to work. This file must be found as:
  45
  46 .TP
  47 .B
  48 $HOME/.wmckgmail/config
  49
  50 .TP
  51 This configuration file contains "<key> <value>" parameters. There is some mandatory parameters that requires to be defined in this file in order to make the program work:
  52
  53 .TP
  54 .B uname <gmail username>
  55 Set the username of the gmail mailbox to monitor
  56 .TP
  57 .B pass <gmail password>
  58 Set the password of the gmail mailbox to monitor
  59
  60 .TP
  61 There is also optional parameters:
  62
  63 .TP
  64 .B pollinterval <seconds between each new mail verification>
  65 Used to define the interval between each verification of new incoming mails. If you do not define this parameter, it will be set to a defauolt value of 300 seconds (5 minutes).
  66 .TP
  67 .B browsercmd1 <command to launch when clicking on the 'big M'>
  68 Used to define the command to launch when clicking on the 'big M'. Example configuration line:
  69
  70 browsercmd1 mozilla -remote "openURL(http://www.gmail.com)"
  71
  72 .TP
  73 .B browsercmd2 <command to launch when clicking on the 'big M' if 'browsercmd1' failed>
  74 Used to define the command to launch when clicking on the 'big M' if the execution of 'browsercmd1' failed (return value != 0). Example configuration line :
  75
  76 browsercmd2 mozilla http://www.gmail.com &
  77
  78 .TP
  79 .B -- WARNINGS --
  80 - It is very recommended to set the configuration file permissions to "600" or "400" as your mailbox password is clearly written in this file.
  81
  82 - When defining 'browsercmd1' or 'browsercmd2', verify if the command you launch returns immediately to the shell or not. If the command does NOT returns to the shell, you have to put an ampersand (&) to launch the command in background like in the 'browsercmd2' example configuration line.
  83
  84 .SH THANKS
  85 Thanks to the author of the
  86 .B wmgeneral
  87 code, it has been a really good starting base to develop this little application.
  88
  89 .SH AUTHOR
  90 .B wmckgmail
  91 has been written by Sylvain Tremblay <stremblay@gmail.com>