WMF(1)

๐ŸŒธ WMF โ€” the web mail folder glow-up ๐Ÿ’Œ

okay bestie, listen up, because wmf is literally the moment. it's the Web Mail Folder tool โ€” it takes your emails and turns them into html pages. iconic behavior honestly. your source can be a file or stdin, so it's flexible like that. ๐Ÿฆ‹


โœจ SYNOPSIS โœจ

wmf [ options ]

no args? no problem. just vibes and options. ๐Ÿ’…


๐Ÿ’– DESCRIPTION ๐Ÿ’–

WMF (that's Web Mail Folder, keep up ๐ŸŽ€) generates html-pages from email. that's the whole personality. the source can be a file or stdin โ€” whatever you're feeling today.


๐Ÿ‘‘ OPTIONS ๐Ÿ‘‘

Available command line options are the following โ€” and yes, we're listing all of them, no skipping, we're thorough here:

  • -? โ€” print a summary of the command line options. your little cheat sheet ๐Ÿซถ
  • -a url โ€” the About link. if this link presents, it gets placed in the index section. cute little credit moment โœจ
  • -c file โ€” another configurationfile. default is ~/.wmfrc ๐Ÿ’œ
  • -d directory โ€” where all the files write to. default is ./ ๐Ÿ“
  • -e command โ€” the Mail-command. default is MAILTO: ๐Ÿ“ฎ
  • -f permission โ€” set file permission after creation. numeric mode only, like chown (1) ๐Ÿ”’
  • -h โ€” print a summary of command line options. same energy as -?, both icons fr ๐Ÿ˜Œ
  • -l days โ€” Daylimit. mails older than <days> day won't be listed in the indexes. 0 = no limit (default=0) โณ
  • -m mbox โ€” name of the mailbox file. - is used for stdin ๐Ÿ“ฅ
  • -n name โ€” name of the mail folder ๐Ÿท๏ธ
  • -p lines โ€” lines / page index. 0 = only one page (default 0). threads won't be brocken ๐Ÿงต (yes, brocken. we respect the original spelling in this house)
  • -r โ€” reverse sorting ๐Ÿ”„
  • -t level โ€” threading level limitation ๐ŸŒณ
  • -v โ€” print the programname and the version. identity reveal moment ๐Ÿ’ซ
  • -w mode โ€” write-mode: 0=indexing, 1=overwrite, 2=append, 3=append no index.
    • 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 !!! โ€” yes bestie, ALL of them. this is not a drill. ๐Ÿ’€
  • Mode 2: if you want to extend an existing archive. ๐Ÿ“š
  • Mode 3: specially 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. ๐Ÿ—‚๏ธ
  • -x level โ€” Debug level (Bit0=Functions Bit1=Information Bit2=Fileoperations) ๐Ÿ›

๐ŸŒˆ ENVIROMENT ๐ŸŒˆ

(yes, it's spelled that way, we don't make the rules ๐Ÿ’–)

All switches can be defined with enviroments. so like, everything up there? also down here. versatile king.

  • WMF_CONFIG โ€” another configurationfile (default ~/.wmfrc) ๐Ÿ’œ
  • WMF_DAYS โ€” Daylimit. mails older than <days> day won't be listed in the indexes. 0 = no limit (default=0) โณ
  • WMF_DEBUG โ€” Debug level (Bit0=Functions Bit1=Information Bit2=Fileoperations) ๐Ÿ›
  • WMF_EXTENSION โ€” define the file extension (default=".html") ๐Ÿ“Ž
  • WMF_DIR โ€” where all the files write to (default ./) ๐Ÿ“
  • WMF_LINES โ€” lines / page index. 0 = only one page (default 0). Threads won't be brocken. ๐Ÿงต
  • WMF_MBOX โ€” name of the mailbox, - is used for stdin ๐Ÿ“ฅ
  • WMF_MCMD โ€” Mail-command (default MAILTO:) ๐Ÿ“ฎ
  • WMF_NAME โ€” name of the mailinglist ๐Ÿท๏ธ
  • WMF_RSORT โ€” reverse sorting ๐Ÿ”„
  • WMF_WMODE โ€” Write-mode (0=indexing 1=append 2=overwrite) โœ๏ธ

๐ŸŽ€ EXAMPLES ๐ŸŽ€

so... this section is literally empty in the original. nothing. not a single example. it's giving "we'll add it later" energy ๐Ÿ˜ญ so i'm not gonna invent anything, because inventing technical claims is not the vibe. the examples section simply is, and we respect it. ๐Ÿ™ˆ


๐Ÿฆ‹ AUTHOR ๐Ÿฆ‹

Norbert Kuemin <norbert.kuemin@gmx.net> โ€” the icon who made all of this happen ๐Ÿ‘‘


๐Ÿ“ FILES ๐Ÿ“

  • ~/.wmfrc โ€” the config file, home sweet home ๐Ÿ’–

๐Ÿ”— SEE ALSO ๐Ÿ”—

  • wmfrc (1)
  • procmail (1)

go read those too bestie, cross-referencing is self-care โœจ


๐Ÿ’ซ NOTES ๐Ÿ’ซ

Thanks to all the people, who sent emails with bug-reports and suggestions. y'all are the real ones ๐Ÿซถ


๐Ÿ’€ BUGS ๐Ÿ’€

There will always rest one bug (Murphys law). if you find it, so please report it to Norbert.Kuemin@gmx.net. fr fr, don't be shy, they want to know ๐Ÿ›


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 shipped as part of the 4th Berkeley Distribution, dated November 1996, and the manual page is WMF(1). vintage, iconic, still slaying. ๐Ÿ’…โœจ