LSMBOXRC(5)

📦 version 2.1.3, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ LSMBOXRC(5) ✨

ok so like. this is the manual page for lsmboxrc — the config file for lsmbox — filed under File Formats Manual, bestie. yes it's a whole section 5 situation. sit down, grab a boba, we're doing this 💅

🎀 NAME 🎀

lsmboxrc — the configuration file for lsmbox 💖

🌸 DESCRIPTION 🌸

so a lsmbox config file is literally just a list of configuration options and what you're setting them to. that's it. that's the whole vibe.

the hash mark (#) is the "comment" character, bestie. any line that starts with a comment character? ignored. gone. not invited to the party. 🚫

whitespace is also ignored. it's giving minimal effort and honestly same 🦋

💅 COMMANDS 💅

ok so these are the things you can actually do in this file:

  • set variable=value — sets a configuration variable to the value you specified. simple. iconic. no notes. ✨
  • unset variable — unsets a configuration variable. and lowkey this implies the built-in default gets used instead, so like, you're not breaking anything, you're just... returning to factory settings energy 🫶
  • mailboxes filename... — this is the one that says what mailboxes to check, bestie. you can have one of these lines or several of these lines. each line can hold the name of one or more mailboxes, each one separated by a space.

and now the important lore:

  • a filename of ! means your inbox 📥
  • a leading (=) or (+) in a filename gets expanded into the path to your mail-directory 🔥

👑 CONFIGURATION VARIABLES 👑

these are the variables, bestie. memorize them. or don't, that's what this file is for.

  • folder — the path to your mail-directory. usually $HOME/Mail/. 📁
  • lsmbox_mail_command — specifies what command to execute when the user selects a mailbox in continuous mode. main character command energy fr 💫
  • mark_old — specifies whether or not old unread messages and new messages should be accounted separately. now listen, here's the tea: 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. so like. choose wisely 💀
  • 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 is explicitly unset, "unseen" will be used. default queen behavior 👑
  • 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. zero means zero, periodt ✨

🙈 COMMENTS 🙈

ok so, real talk: 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. 💀 (their words, not mine, but honestly? valid.)

ngl I've deliberately tried to use the same syntax as mutt uses for its configuration-file muttrc whenever possible — all so you can source $HOME/.lsmboxrc from your $HOME/.muttrc with zero drama. cute right? 🎀

but heads up bestie: lsmbox_mail_command will, however, cause mutt to emit an error. yeah. that one. the one that's giving chaos 😭

🔗 SEE ALSO 🔗

📜 HISTORY 📜

the lore, in chronological order, no skips:

  • Apr 16 2006: Updated for v2.1.0 of lsmbox.
  • Apr 16 2004: Updated for v2.0.0 of lsmbox.
  • Mar 13 2004: Updated for v1.9.0 of lsmbox.
  • Jan 16 2003: Minor fixes.
  • Jan 06 2003: Minor fixes.
  • Dec 09 2002: Minor fixes.
  • Nov 15 2002: Updated for v1.6.0 of lsmbox.
  • Nov 13 2002: Add note about '+' and '='.
  • Nov 06 2002: Minor changes.
  • Nov 04 2002: Minor change.
  • Oct 29 2002: Fixed a typo.
  • Oct 28 2002: Fixed a typo.
  • Oct 26 2002: Updated for v1.1.0 of lsmbox.
  • Oct 26 2002: Updated for v1.0.1 of lsmbox.
  • Oct 21 2002: Initial release.

🧚 AUTHOR 🧚

lsmbox and its manual-pages are written by David Weinehall <tao@acc.umu.se> 💜

⭐ REPORTING BUGS ⭐

report bugs to <tao@acc.umu.se>. don't be shy, they want to know 🫶

Copyright © 2002-2006 David Weinehall

this is free software; see the source for copying conditions. there is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. like, none. zero. nada. 💀

and that's the whole page, bestie!! written by David Weinehall, dated Apr 16, 2006, and it lives at LSMBOXRC(5) in the manual — go configure something iconic 💖✨🎀

📦 where this page comes from