.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4. .TH XLASSIE "1x" "October 2011" "xlassie 1.8" "User Commands" .SH NAME xlassie \- mailbox counter for X .SH SYNOPSIS .B xlassie [\fIoptions\fR] .SH DESCRIPTION The \fIxlassie\fR program is a replacement for the standard X mail notification tool, XBiff. It has several useful enhancements over XBiff. .in +2 .sp \fB*\fP Counts the number of new messages you have .br \fB*\fP Can query remote mail on a POP3 server or on an IMAP server .br \fB*\fP Can count local mail with an mbox or a maildir style spool .br \fB*\fP Uses less memory than XBiff (or any other X mail checker) .br \fB*\fP Can run a command when clicked on, and/or when new mail arrives .br \fB*\fP Can toggle an LED indicating availability of mail .br \fB*\fP Supports both the KDE and the WindowMaker applet protocols .br \fB*\fP Runs as a standard X application .PP When the count is 0 (no mail) it is displayed in a less obtrusive color. When mail arrives a beep is emitted, and the updated unread message count is displayed. .PP When xlassie is running, the following interactive commands are available: .PP .in +4 .nf \fBq\fP \fBQuit\fP gracefully. \fBmouse click\fP Spawn '-command' (if any), otherwise update mail count. .PP xlassie 1.8 .SH OPTIONS .TP \fB\-h\fR, \fB\-help\fR Print usage and exit .TP \fB\-v\fR, \fB\-version\fR Print version and exit .TP \fB\-V\fR, \fB\-verbose\fR Chatter on about this and that .TP \fB\-name\fR Set application class name (default: xlassie) .TP \fB\-bg\fR Background color (default: White) .TP \fB\-fg\fR Foreground color (default: Black) .TP \fB\-hilight\fR [] Use a different foreground color when there is non\-zero mail (default: Red) .TP \fB\-update\fR Check mail every seconds (default: 5 sec local, 60 sec remote) .TP \fB\-bell\fR Ring bell when count increases from zero .TP \fB\-led\fR [] Light\-up keyboard LED if mail exists (default: 1) .TP \fB\-fn\fR Font for the new mail count .TP \fB\-display\fR X server to connect to .TP \fB\-geometry\fR Window geometry .TP \fB\-shape\fR Use a shaped window .TP \fB\-spool\fR File to use for mail spool or maildir directory .TP \fB\-mailcommand\fR Command to execute on new mail arrival .TP \fB\-clickcommand\fR Command to execute when clicked upon (default: CHECK_MAILBOX) .TP \fB\-offset\fR Mail display count offset (for debugging) .TP \fB\-pop3\fR Connect to pop3 server rather than local mail spool .TP \fB\-apop3\fR Like \fB\-pop3\fR, but uses a different method. Use when \fB\-pop3\fR doesn't find the correct number .TP \fB\-imap\fR Use the IMAP protocol instead of pop3 .TP \fB\-imapfolder\fR Use this folder instead of INBOX .TP \fB\-username\fR Username for pop3/imap server, when different from local username .TP \fB\-password\fR Password to use on pop3/imap server. Use the password 'ask' to be prompted for the password on stdin. .TP \fB\-offline\fR Don't exit when the server is unreachable .TP \fB\-wmaker\fR, \fB\-kde\fR Do stuff to get swallowed into the WindowMaker or KDE dock. Normally unneeded: WindowMaker and KDE should be autodetected. .TP \fB\-nokde\fR, \fB\-nowmaker\fR Don't do the stuff to get swallowed .SH ENVIRONMENT If set \fBMAIL\fR is the mail spool or maildir directory to use, unless otherwise specified on the command line. .SH "X RESOURCES" When reading X resources, two class names \fBxlassie\fR and \fBxbiff\fR are recognized (in that order) unless the \fB-name\fR is used. The class name \fBxbiff\fR allows resources common to both xbiff and xlassie to be easily configured, while the class name \fBxlassie\fR allows resources unique to this program. If no resources are specified, suitable defaults will be used. Command-line arguments can be used to override resource settings. The following resources are allowed (e.g, "xlassie.RESOURCE"): .TP \fBname:\fR \fIname\fR Use the specified name as a class name for this application (default: xlassie). .TP \fBbackground:\fR \fIcolor\fR Use the specified color as this application's background color. The 'bg' resource is also recognized (default: White). .TP \fBforeground:\fR \fIcolor\fR Use the specified color as this application's foreground color. The 'fg' resource is also recognized (default: Black). .TP \fBhightlight:\fR \fIcolor\fR Use the specified color as this application's foreground color when there is non-zero mail. The 'hilight' resource is also recognized (default: Red). .TP \fBupdate:\fR \fInumber\fR Use the specified number to note how many seconds should be used to check mail every (default: 5 seconds local, 60 seconds remote). .TP \fBbell:\fR \fIboolean\fR Use the specified boolean value to affect the ringing of the system bell when mail is received (default: False). .TP \fBled:\fR \fInumber\fR Use the specified number to light-up the LED specified if mail exists (default: 1). .TP \fBfont:\fR \fIfontname\fR Use the specified fontname as the application's font. The 'fn' resource is also recognized. .TP \fBgeometry:\fR \fIgeometry\fR Use the specified X window geometry. .TP \fBshape:\fR \fIboolean\fR Use the specified boolean value to affect shaped window creation (default: False). .TP \fBspool:\fR \fIfilename\fR Use the specified filename as the mail spool or maildir directory. .TP \fBmailcommand:\fR \fIcommand\fR Use the specified command to execute on new mail arrival. The 'mailcmd' resource is also recognized. If you have a %d in the command, it will get replaced with the number of new messages. Remember to put quotes around the command if it's longer than one word. If you want the command to run the background, put a '&' at the end. .TP \fBclickcommand:\fR \fIcommand\fR Use the specified command to execute when application is clicked on. The 'clickcmd' resource is also recognized (default: CHECK_MAILBOX). .TP \fBpop3:\fR \fIserver\fR Use the specified pop3 server rather than local mail spool. .TP \fBapop3:\fR \fIserver\fR Use the specified pop3 server rather than local mail spool but while using a different access method. This option is useful when \fB\-pop3\fR doesn't find the correct number. .TP \fBimap:\fR \fIserver\fR Use the specified imap server rather than local mail spool. .TP \fBusername:\fR \fIname\fR Use the specified login name for pop3/imap server access when different from local username. .TP \fBpassword:\fR \fIpassword\fR Use the specified login password for pop3/imap server access. .TP \fBoffline:\fR \fIboolean\fR Use the specified boolean value to affect whether access is continued in the case a remote server is unreachable (default: False). .TP \fBwmaker:\fR \fIboolean\fR Use the specified boolean value to affect the ability to get swallowed into a WindowMaker dock (default: False). .TP \fBkde:\fR \fIboolean\fR Use the specified boolean value to affect the ability to get swallowed into a KDE dock (default: False). .TP \fBnokde:\fR \fIboolean\fR Use the specified boolean value to affect the inability to get swallowed into a KDE dock (default: False). .TP \fBnowmaker:\fR \fIboolean\fR Use the specified boolean value to affect the inability to get swallowed into a WindowMaker dock (default: False). .SH AUTHOR Original XLassie by Trent Piepho . .br Modified by .br - Barak A. Pearlmutter .br - Nadim Shaikli . .SH COPYRIGHT Copyright (c) 1998-2001, Trent Piepho. .br Copyright of modifications held by their respective authors. .PP Licensed under the GNU General Public License v2 (GPL).