README: update

pull/115/head v0.3.2
Leah Neukirchen 6 years ago
parent ecb5286e5a
commit 2cd67e3fe1

128
README

@ -1,102 +1,102 @@
MBLAZE(7) Miscellaneous Information Manual MBLAZE(7) MBLAZE(7) Miscellaneous Information Manual MBLAZE(7)
NAME NAME
mblaze introduction to mblaze mblaze introduction to the mblaze message system
DESCRIPTION DESCRIPTION
The mblaze message system is a set of Unix utilities to deal with mail The mblaze message system is a set of Unix utilities for processing and
kept in Maildir folders. interacting with mail messages which are stored in maildir folders.
Its design is roughly inspired by MH, the RAND Message Handling System, Its design is roughly inspired by MH, the RAND Message Handling System,
but it is a complete implementation from scratch. but it is a complete implementation from scratch.
mblaze consists of these Unix tools that each do one job: mblaze consists of these Unix utilities that each do one job:
maddr(1) extract addresses from mail
magrep(1) find mails matching a pattern maddr(1) extract mail addresses from messages
mbnc(1) bounces mail magrep(1) search messages matching a pattern
mcom(1) compose and send mail mbnc(1) bounce messages
mdeliver(1) deliver messages or import mailboxes mcom(1) compose and send messages
mdirs(1) find Maildir folders mdeliver(1) deliver messages or import mbox file
mexport(1) export Maildir folders as mailboxes mdirs(1) list maildir folders, recursively
mflag(1) change flags (marks) of mail mexport(1) export messages as mbox file
mflow(1) reflow format=flowed plain text mails mflag(1) manipulate maildir flags
mfwd(1) forward mail mflow(1) reflow format=flowed plain text messages
mgenmid(1) generate Message-IDs mfwd(1) forward messages
mhdr(1) extract mail headers mgenmid(1) generate a Message-ID
minc(1) incorporate new mail mhdr(1) print message headers
mless(1) conveniently read mail in less(1) minc(1) incorporate new messages
mlist(1) list and filter mail messages mless(1) conveniently read messages in less(1)
mlist(1) list and filter messages
mmime(1) create MIME messages mmime(1) create MIME messages
mmkdir(1) create new Maildir mmkdir(1) create new maildir folders
mpick(1) advanced mail filter mpick(1) advanced message filter
mrep(1) reply to mail mrep(1) reply to messages
mscan(1) generate one-line summaries of mail mscan(1) generate one-line message summaries
msed(1) manipulate mail headers msed(1) manipulate message headers
mseq(1) manipulate mail sequences mseq(1) manipulate message sequences
mshow(1) render mail and extract attachments mshow(1) render messages and extract MIME parts
msort(1) sort mail msort(1) sort messages
mthread(1) arrange mail into discussions mthread(1) arrange messages into discussions
PRINCIPLES
mblaze is a classic command line MUA and has no features for receiving or mblaze is a classic command line MUA and has no features for receiving or
transferring mail; you are expected to fetch your mail using fdm(1), transferring messages; you can operate on messages in a local maildir
getmail(1) offlineimap(1), procmail(1), or similar , and send it using spool, or fetch your messages using fdm(1), getmail(1), offlineimap(1),
dma(8), msmtp(1), sendmail(8), as provided by OpenSMTPD, Postfix, or or similar utilities, and send it using dma(8), msmtp(1), sendmail(8), as
similar. mblaze expects your mail to reside in Maildir folders. provided by OpenSMTPD, Postfix, or similar.
mblaze operates directly on Maildir folders and doesn't use its own mblaze operates directly on maildir folders and doesn't use its own
caches or databases. There is no setup needed for many uses. All tools caches or databases. There is no setup needed for many uses. All
have been written with performance in mind. Enumeration of all mails in utilities have been written with performance in mind. Enumeration of all
a Maildir is avoided unless necessary, and then optimized to limit messages in a maildir is avoided unless necessary, and then optimized to
syscalls. Parsing mail metadata is optimized to limit I/O requests. limit syscalls. Parsing message metadata is optimized to limit I/O
Initial operations on a large Maildir may feel slow, but as soon as they requests. Initial operations on a large maildir may feel slow, but as
are in the file system cache, everything is blazingly fast. The tools soon as they are in the file system cache, everything is blazingly fast.
are written to be memory efficient (i.e. not wasteful), but whole The utilities are written to be memory efficient (i.e. not wasteful), but
messages are assumed to fit into RAM easily (one at a time). whole messages are assumed to fit into RAM easily (one at a time).
mblaze has been written from scratch and tested on a large corpus of mblaze has been written from scratch and is now well tested, but it is
personal mail, but is not actually 100% RFC-conforming (which is neither not 100% RFC-conforming (which is neither worth it, nor desirable).
worth it nor desirable). There may be issues with very old, There may be issues with very old, nonconforming, messages.
nonconforming, messages.
mblaze is written in portable C, using only POSIX functions (apart from a mblaze is written in portable C, using only POSIX functions (apart from a
tiny Linux-only optimization), and has no external dependencies. It tiny Linux-only optimization), and has no external dependencies. It
supports MIME and more than 7-bit messages (everything the host iconv(3) supports MIME and more than 7-bit messages (everything the host iconv(3)
can decode). It assumes you work in a UTF-8 environment. mblaze works can decode). It assumes you work in a UTF-8 environment. mblaze works
well together with other Unix mail tools such as mairix(1), mu(1), or well with other Unix utilities such as mairix(1), mu(1), or
offlineimap(1). offlineimap(1).
EXAMPLES EXAMPLES
mblaze tools are designed to be composed together in a pipe. They are mblaze utilities are designed to be composed together in a pipe. They
suitable for interactive use and for scripting, and integrate well into a are suitable for interactive use and for scripting, and integrate well
Unix workflow. into a Unix workflow.
For example, you could decide you want to look at all unseen mail in your For example, you could decide you want to look at all unseen messages in
INBOX, oldest first. your INBOX, oldest first.
mlist -s ~/Maildir/INBOX | msort -d | mscan mlist -s ~/Maildir/INBOX | msort -d | mscan
To operate on a set of mails in multiple steps, you can save it as a To operate on a set of messages in multiple steps, you can save it as a
sequence, e.g. add a call to mseq -S to the above command: sequence, e.g. add a call to mseq -S to the above command:
mlist -s ~/Maildir/INBOX | msort -d | mseq -S | mscan mlist -s ~/Maildir/INBOX | msort -d | mseq -S | mscan
Now mscan will show message numbers and you could look at the first five Now mscan will show message numbers and you could look at the first five
mails at once, for example: messages at once, for example:
mshow 1:5 mshow 1:5
Likewise, you could decide to incorporate (by moving from new to cur) all Likewise, you could decide to incorporate (by moving from new to cur) all
new mail in all folders, thread it and look at it interactively: new messages in all folders, thread it and look at it interactively:
mdirs ~/Maildir | xargs minc | mthread | mless mdirs ~/Maildir | xargs minc | mthread | mless
Or you could list the attachments of the 20 largest mails in your INBOX: Or you could list the attachments of the 20 largest messages in your
INBOX:
mlist ~/Maildir/INBOX | msort -S | tail -20 | mshow -t mlist ~/Maildir/INBOX | msort -S | tail -20 | mshow -t
Or apply the patches from the current mail: Or apply the patches from the current message:
mshow -O. '*.diff' | patch mshow -O. '*.diff' | patch
As usual with pipes, the sky is the limit. As usual with pipes, the sky is the limit.
CONCEPTS CONCEPTS
mblaze deals with messages (which are files), folders (which are Maildir mblaze deals with messages (which are files), folders (which are maildir
folders), sequences (which are newline-separated lists of messages, folders), sequences (which are newline-separated lists of messages,
possibly saved on disk in ${MBLAZE:-$HOME/.mblaze}/seq), and the current possibly saved on disk in ${MBLAZE:-$HOME/.mblaze}/seq), and the current
message (kept as a symlink in ${MBLAZE:-$HOME/.mblaze}/cur). message (kept as a symlink in ${MBLAZE:-$HOME/.mblaze}/cur).
@ -117,9 +117,9 @@ AUTHORS
Leah Neukirchen <leah@vuxu.org> Leah Neukirchen <leah@vuxu.org>
There is a mailing list available at mblaze@googlegroups.com (to There is a mailing list available at mblaze@googlegroups.com (to
subscribe, send a mail to mblaze+subscribe@googlegroups.com. Please subscribe, send a message to mblaze+subscribe@googlegroups.com) and an
report security-related bugs directly to the author), as well as an IRC IRC channel #vuxu on irc.freenode.net. Please report security-related
channel #vuxu on irc.freenode.net. bugs directly to the author.
LICENSE LICENSE
mblaze is in the public domain. mblaze is in the public domain.

Loading…
Cancel
Save