awayrc(5)

✨ awayrc(5) ✨

okay bestie, gather round, because this is the manual page for awayrc, aka the configuration file for Away 💖 and honestly? it's giving cozy little dotfile energy and we're obsessed.

---

🌸 NAME 🌸

awayrc — configuration file for Away

---

🦋 DESCRIPTION 🦋

So here's the vibe: an away configuration file is literally just a series of commands, one after another. Each line of the file may contain only one command. No stacking, no multitasking, one per line, periodt.

Command names are case-insensitive — so go ahead and scream them in all caps if that's your truth, it doesn't matter. Commands and their arguments get separated by spaces.

The hash mark, aka the pound sign ("#"), is your comment character. Use it to annotate your config file, spill your thoughts, leave little notes for future you. All text after the comment character, all the way to the end of the line, is ignored. it's giving "not me writing my diary in my rc file" 💅

⚠️ BIG one, bestie, no cap: if any mailboxes are configured in the rc file, they will be the only mailboxes checked. Which means you must add your inbox yourself — the $MAIL environment variable will be ignored. she does not care about $MAIL anymore. that ship has sailed. 🫶

---

👑 COMMANDS 👑

okay so here's every single one, in order, no skips, no cuts, we're eating the whole plate 🍓

• mail VALUE — this lets you disable or enable the checking of the user's mailboxes. If mail checking is disabled, then all mailbox and maildir commands are ignored (they just don't exist to her anymore, RIP 💀). VALUE can be 0, 1, no, or yes. The default value is 'yes'.
• mailbox FILENAME — a file that should be checked for "new mail." The filename gets appended to the previous maildir declaration. You can also optionally supply a description of the mailbox. If that description contains a space, the entire description must be enclosed in braces, "{" and "}". yes, curly braces, she's fancy like that ✨
• maildir DIRECTORY — a path where subsequent mailbox declarations will be located. The only argument is the path itself. simple. clean. iconic.
• persist VALUE — this sets whether to do persistent mail checking. VALUE can be 0, 1, no, or yes. The default value is 'yes'.
• time SECONDS — this sets the number of seconds that away sleeps before performing its background tasks. Presently, the only background task that away will perform is the checking of mailboxes. The SECONDS value must be more than the minimum, which is set at compile time — so don't go thinking you can set it to whatever, bestie, there's a floor here 🚧. The only argument is the number of seconds. The default value is 300.

---

🌈 EXAMPLE 🌈

here's a whole little config, look at her go 🧚

# check mailboxes
mail yes

# check mail every 60 seconds
time 60

# do not do persistent checking
persist no

# inbox
maildir /var/spool/mail
    mailbox johndoe                {your Inbox}

# procmail folders
maildir /home/johndoe/mail
    mailbox linux-security         {Linux Security}
    mailbox mutt-announce          {Mutt Announce}

---

🎀 FILES 🎀

• ~/.awayrc — Per user configuration file. (yes, the little tilde, the little dotfile, the whole aesthetic 💜)

---

💀 BUGS 💀

Found a bug? Bug reports should be sent to the away mailing list <away@unbeatenpath.net>. tell them everything, they wanna know 🫶

---

⭐ SEE ALSO ⭐

• away(1)

---

💖 AUTHORS 💖

Cameron Moore <cameron@unbeatenpath.net>, and others.

---

and that's the whole page, bestie!! this was awayrc(5) from the Linux manual pages, dated November 2000 — yeah, she's vintage, she's retro, she's lowkey a classic and we respect the era 👑✨ bye ily, go fix your mail config 🦋💅