wmfrc(5)

💖 wmfrc — bestie edition 💖

okay so this is a wmfrc(5) page, which means it lives in the File Formats Manual section of your man pages, and it's literally the whole entire manual for the config file of wmf. yes it's giving "one file to rule them all" energy. 👑

---

✨ NAME ✨

wmfrc — the configuration file for wmf. that's it. that's the name. iconic. 🎀

---

🌸 DESCRIPTION 🌸

so like, this file handles every single configurational feature of wmf. all of them. the whole vibe. 💅

and here's the tea: wmf goes looking for .wmfrc as the default if nothing else is defined. so if you don't tell it otherwise, that's the one it's gonna read. no cap.

---

🦋 COMMANDS 🦋

the available command line options are literally these, in this exact order, and yes we're going through all of them because i would never do you like that:

• AboutLink = <Text> — if this link is present, it gets placed into the index section. cute lil cameo. ✨
• AuthorCaseSort = 0n|Off — sorts the author index case sensitive.
• AuthorEmailSort = 0n|Off — sorts the author index by email address.
• BodyHtmlConvert = 0n|Off — turns the html convert of the mail-body on/off.
• BodyLinkEmail = 0n|Off — turns email detecting in the mail-body on/off.
• BodyLinkUrl = 0n|Off — turns url detecting in the mail-body on/off.
• BodyReplyChars = <Text> — defines the characters that indicate the begin of reply text. for example ">". you know, the lil quote marks that scream "this part is a reply". 🙈
• DayLimit = <Number> — mails older than <Number> days won't be listed in the indexes. 0 = no limit (default=0). so 0 is the "we don't gatekeep, everyone's invited" setting. 🫶
• DebugLevel = <Number> — the debug level. the bits are: Bit0=Functions, Bit1=Information, Bit2=Fileoperations. yes bestie it's bitmask math, we love her.
• Directory = <Text> — where all the files write to (default ./).
• DocEndFile = <Text> — includefile for the end of the document.
• DocStartFile = <Text> — includefile for the begin of the document.
• Extension = <Text> — define the file extension (default=".html").
• FaceDirectory = <Text> — directory where to store the face files. Attention: this directory is RELATIVE to the html directory. like, don't get it twisted, it's not absolute, it's relative, i said what i said. 💀
• FaceNoData = <Text> — what to include, if there are no face datas.
• FaceSupport = 0n|Off — turn face support on/off.
• FilePermission = <Number> — set file permission after creation. numeric mode only, like chown (1).
• FolderName = <Text> — name of the mail folder.
• FrameNameIndex = <Text> — name of the frame where the index is.
• FrameNameText = <Text> — name of the frame where the mailtext is.
• FrameNameTitle = <Text> — name of the frame where the title is.
• FrameSupport = 0n|Off — turn frame support on/off.
• HtmlBodyStart = <Text> — replacement for <BODY>.
• HtmlBodyEnd = <Text> — replacement for </BODY>.
• HtmlSeparator = <Text> — replacement for <HR>.
• HtmlReplyStart = <Text> — if you want display the reply text italic, put a <I> here. 💅
• HtmlReplyEnd = <Text> — if you want display the reply text italic, put a </I> here.
• IndexAuthor = 0n|Off — turning indexing by author (author.html) on/off.
• IndexDate = 0n|Off — turning indexing by date (date.html) on/off.
• IndexSubject = 0n|Off — turning indexing by subject (subject.html) on/off.
• IndexThread = 0n|Off — turning indexing by thread (thread.html) on/off.
• LineSize = <Number> — lines greater than the defined limit will be breaked at the last space. if there wasn't any space, the search continues to the next after the limit. if there isn't ANY space in the whole line, no breakes. (yes, "breakes". we're keeping the original spelling, don't @ me, it's part of the lore 🫶)
• MailboxFile = <Text> — name of the mailbox file, - is used for stdin. (the dash is giving "i read from your keyboard now" ✨)
• MailCommand = <Text> — mail-command (default MAILTO:).
• MessageCount = 0n|Off — print the amount of messages in the first page of every index file.
• NewSubjectThread = 0n|Off — make a new Thread if the Subject changes in a reply.
• PageSize = <Number> — lines / page index. 0 = only one page (default 0). Threads won't be brocken.
• SortOrder = NewFirst|NewLast — define sorting. pick a lane bestie.
• Statistics = 0n|Off — turn statistic on/off.
• SubjectCaseSort = 0n|Off — sorting the subject index case sensitive.
• ThreadCaseSort = 0n|Off — sorting the thread index case sensitive.
• WriteMode = <Number> — write-mode, and the options are 0=indexing, 1=overwrite, 2=append, 3=append no index. okay so let's break this down because it's important:
  • Mode 0: if you made changes manual or anything went wrong until indexing.
  • Mode 1: if you want to start from scratch witch one big mbox file.

Warning: All files in the directory will be deleted !!! like, absolutely unhinged behaviour, please know what you're doing before you pick this one. 😭

• Mode 2: if you want to extend an existing archive.
• Mode 3: specialy made if you need to convert emails stored in single files. after converting all files you can call WMF again in Mode 0 for indexing.

---

👑 AUTHOR 👑

Norbert Kuemin <norbert.kuemin@gmx.net>

the original main character, we stan. 💜

---

📁 FILES 📁

• ~/.wmfrc

---

🌈 SEE ALSO 🌈

• wmf (1)

---

💬 NOTES 💬

thanks to all the people, who sent emails with bug-reports and suggestions. y'all are the real ones, fr fr. 🫶✨

---

💀 BUGS 💀

there will always rest one bug (Murphys law). it's giving "you can't sit with us" but for correctness. 🙈

if you find it, so please report it to Norbert.Kuemin@gmx.net. do your civic duty bestie.

---

🎀 COPYRIGHT 🎀

Copyright 1996, 1997 by Norbert Kuemin.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

---

and that's the whole page bestie!! 💖 this one came from the 4th Berkeley Distribution, dated December 1997, and it's filed under wmfrc(5). slay, go forth and configure. ✨🦋💅