lsmboxrc5

Overview

A lsmbox configuration file consists of a list of configuration options and their setting. The hash mark ("#") is used as a "comment" character. Every line beginning with a comment character is ignored. Whitespace is also ignored.

Commands

set variable=value

Set a configuration variable to the specified value.

unset variable

Unset a configuration variable. This implies that the built-in default will be used instead.

mailboxes filename...

Specifies what mailboxes to check. You can have one or several of these lines. Each line can contain the name of one or more mailboxes, each separated by a space.

A filename of ! denotes your inbox. A leading ("=") or ("+") in a filename will be expanded into the path to your mail-directory.

Configuration variables

folder

The path to your mail-directory; this is usually $HOME/Mail/.

lsmbox_mail_command

Specifies what command to execute when the user selects a mailbox in continuous mode.

mark_old

Specifies whether or not old unread messages and new messages should be accounted separately. If you explicitly unset this variable using the unset command, the number of new and old messages will be added together as unread messages, otherwise they will be accounted as new and old respectively.

mh_seq_unseen

Specifies the string used in the .mh_sequences file to list new/old unread messages. If this variable is not set, or explicitly unset, "unseen" will be used.

spoolfile

The path to where the system keeps your inbox; usually /var/mail/USERNAME or /var/spool/mail/USERNAME.

lsmbox_padding

The width of the mailbox column. To never add additional padding beyond what's needed to align all values, specify '0' here.

Comments

You cannot specify a path or mailbox that contains whitespace characters (space, newline, etc.) Do not bug me about this. Having such filenames/pathnames is stupid anyway.

I've deliberately tried to use the same syntax as mutt uses for its configuration-file muttrc whenever possible, to facilitate sourcing of $HOME/.lsmboxrc from your $HOME/.muttrc. lsmbox_mail_command will, however, cause mutt to emit an error.