README: update

pull/45/head
Leah Neukirchen 7 years ago
parent 41fc81992f
commit 10063ce3cf

@ -42,15 +42,15 @@ PRINCIPLES
it using sendmail(8), as provided by OpenSMTPD, Postfix, msmtp(1), dma(8) it using sendmail(8), as provided by OpenSMTPD, Postfix, msmtp(1), dma(8)
or similar. mblaze expects your mail to reside in Maildir folders. or similar. mblaze expects your mail to reside in Maildir folders.
mblaze operates directly on Maildir and doesn't use own caches or mblaze operates directly on Maildir and doesn't use its own caches or
databases. There is no setup needed for many uses. All tools have been databases. There is no setup needed for many uses. All tools have been
written with performance in mind. Enumeration of all mails in a Maildir written with performance in mind. Enumeration of all mails in a Maildir
is avoided unless necessary, and then optimized to use few syscalls. is avoided unless necessary, and then optimized to limit syscalls.
Parsing mail metadata is optimized to use few I/O requests. Initial Parsing mail metadata is optimized to limit I/O requests. Initial
operations on big Maildir may feel slow, but as soon as they are in file operations on big Maildir may feel slow, but as soon as they are in the
system cache, everything is blazing fast. The tools are written to be file system cache, everything is blazingly fast. The tools are written
memory efficient (i.e. not wasteful), but whole messages are assumed to to be memory efficient (i.e. not wasteful), but whole messages are
fit into RAM easily (one at a time). assumed to fit into RAM easily (one at a time).
mblaze has been written from scratch and tested on a big pile of personal mblaze has been written from scratch and tested on a big pile of personal
mail, but is not actually 100% RFC conforming (which is neither worth it mail, but is not actually 100% RFC conforming (which is neither worth it
@ -65,7 +65,7 @@ PRINCIPLES
mairix(1), or mu(1). mairix(1), or mu(1).
EXAMPLES EXAMPLES
mblaze tools are designed to be composed together into a pipe. It is mblaze tools are designed to be composed together in a pipe. It is
suitable for interactive use and for scripting. It integrates well into suitable for interactive use and for scripting. It integrates well into
a Unix workflow. a Unix workflow.
@ -73,7 +73,7 @@ EXAMPLES
INBOX, oldest first. 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 a list of To operate on a set of mails in multiple steps, you can save a list of
mail as a sequence. E.g. add a call to mseq -S to above command: mail as a 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: mails at once, for example:
@ -91,11 +91,11 @@ EXAMPLES
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 persisted on disk in ${MBLAZE:-$HOME/.mblaze}/seq), and the possibly saved on disk in ${MBLAZE:-$HOME/.mblaze}/seq), and the current
current message (kept as a symlink in ${MBLAZE:-$HOME/.mblaze}/cur). message (kept as a symlink in ${MBLAZE:-$HOME/.mblaze}/cur).
Messages in the persisted sequence can be referred to using special Messages in the saved sequence can be referred to using special syntax as
syntax as explained in mmsg(7). explained in mmsg(7).
Many utilities have a default behavior when used interactively from a Many utilities have a default behavior when used interactively from a
terminal (e.g. operate on the current message or the current sequence). terminal (e.g. operate on the current message or the current sequence).

Loading…
Cancel
Save