mirror of
https://github.com/leahneukirchen/mblaze
synced 2024-11-11 13:10:32 +00:00
correct typos and wording in documentation
This commit is contained in:
parent
7eed9240a7
commit
4bca2ccbc9
@ -27,21 +27,21 @@ for comments:
|
|||||||
Please bear in mind that empty lines will stop parsing.
|
Please bear in mind that empty lines will stop parsing.
|
||||||
.Pp
|
.Pp
|
||||||
The following
|
The following
|
||||||
.Ar key
|
.Ar keys
|
||||||
are used by
|
are used by
|
||||||
.Xr mblaze 7 :
|
.Xr mblaze 7 :
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
.It Li "Alternate-Mailboxes:"
|
.It Li "Alternate-Mailboxes:"
|
||||||
A comma-separated list of mail addresses that belong to you, for
|
A comma-separated list of mail addresses that belong to you, for
|
||||||
.Xr mscan 1
|
.Xr mscan 1
|
||||||
to recognize them as sent to you.
|
to recognize messages sent by or directly to you.
|
||||||
.It Li "FQDN:"
|
.It Li "FQDN:"
|
||||||
The fully qualified domain name used for
|
The fully qualified domain name used for
|
||||||
.Li "Message-Id:"
|
.Li "Message-Id:"
|
||||||
generation in
|
generation in
|
||||||
.Xr mgenmid 1 .
|
.Xr mgenmid 1 .
|
||||||
.It Li "Local-Mailbox:"
|
.It Li "Local-Mailbox:"
|
||||||
Your primary mail address, used as default value for
|
Your primary mail address, used as the default value for
|
||||||
.Li "From:"
|
.Li "From:"
|
||||||
in
|
in
|
||||||
.Xr mcom 1 ,
|
.Xr mcom 1 ,
|
||||||
|
16
man/mblaze.7
16
man/mblaze.7
@ -86,14 +86,14 @@ or similar.
|
|||||||
expects your mail to reside in Maildir folders.
|
expects your mail to reside in Maildir folders.
|
||||||
.Pp
|
.Pp
|
||||||
.Nm
|
.Nm
|
||||||
operates directly on Maildir and doesn't use own caches or databases.
|
operates directly on Maildir and doesn't use its own caches or databases.
|
||||||
There is no setup needed for many uses.
|
There is no setup needed for many uses.
|
||||||
All tools have been written with performance in mind.
|
All tools have been written with performance in mind.
|
||||||
Enumeration of all mails in a Maildir is avoided unless necessary,
|
Enumeration of all mails in a Maildir is avoided unless necessary,
|
||||||
and then optimized to use few syscalls.
|
and then optimized to limit syscalls.
|
||||||
Parsing mail metadata is optimized to use few I/O requests.
|
Parsing mail metadata is optimized to limit I/O requests.
|
||||||
Initial operations on big Maildir may feel slow, but as soon as they
|
Initial operations on big Maildir may feel slow, but as soon as they
|
||||||
are in file system cache, everything is blazing fast.
|
are in the file system cache, everything is blazingly fast.
|
||||||
The tools are written to be memory efficient (i.e. not wasteful), but
|
The tools are written to be memory efficient (i.e. not wasteful), but
|
||||||
whole 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).
|
||||||
.Pp
|
.Pp
|
||||||
@ -119,7 +119,7 @@ or
|
|||||||
.Xr mu 1 .
|
.Xr mu 1 .
|
||||||
.Sh EXAMPLES
|
.Sh EXAMPLES
|
||||||
.Nm
|
.Nm
|
||||||
tools are designed to be composed together into a pipe.
|
tools are designed to be composed together in a pipe.
|
||||||
It is suitable for interactive use and for scripting.
|
It is suitable for interactive use and for scripting.
|
||||||
It integrates well into a Unix workflow.
|
It integrates well into a Unix workflow.
|
||||||
.Pp
|
.Pp
|
||||||
@ -130,7 +130,7 @@ To operate on a set of mails in multiple steps, you can save a list of mail
|
|||||||
as a sequence.
|
as a sequence.
|
||||||
E.g. add a call to
|
E.g. add a call to
|
||||||
.Ql mseq -S
|
.Ql mseq -S
|
||||||
to above command:
|
to the above command:
|
||||||
.Dl mlist -s ~/Maildir/INBOX | msort -d | mseq -S | mscan
|
.Dl mlist -s ~/Maildir/INBOX | msort -d | mseq -S | mscan
|
||||||
Now mscan will show message numbers and you could look at the first
|
Now mscan will show message numbers and you could look at the first
|
||||||
five mails at once, for example:
|
five mails at once, for example:
|
||||||
@ -147,12 +147,12 @@ As usual with pipes, the sky is the limit.
|
|||||||
.Nm
|
.Nm
|
||||||
deals with messages (which are files),
|
deals with messages (which are files),
|
||||||
folders (which are Maildir folders),
|
folders (which are Maildir folders),
|
||||||
sequences (which are newline-separated lists of messages, possibly persisted on disk in
|
sequences (which are newline-separated lists of messages, possibly saved on disk in
|
||||||
.Pa ${MBLAZE:-$HOME/.mblaze}/seq ) ,
|
.Pa ${MBLAZE:-$HOME/.mblaze}/seq ) ,
|
||||||
and the current message (kept as a symlink in
|
and the current message (kept as a symlink in
|
||||||
.Pa ${MBLAZE:-$HOME/.mblaze}/cur ) .
|
.Pa ${MBLAZE:-$HOME/.mblaze}/cur ) .
|
||||||
.Pp
|
.Pp
|
||||||
Messages in the persisted sequence can be referred to using special
|
Messages in the saved sequence can be referred to using special
|
||||||
syntax as explained in
|
syntax as explained in
|
||||||
.Xr mmsg 7 .
|
.Xr mmsg 7 .
|
||||||
.Pp
|
.Pp
|
||||||
|
@ -23,13 +23,13 @@ After editing, a loop is started where the user can re-edit, send or
|
|||||||
cancel the mail.
|
cancel the mail.
|
||||||
Use
|
Use
|
||||||
.Sq Nm Fl r
|
.Sq Nm Fl r
|
||||||
to resume editing a draft.
|
to resume the editing of a draft.
|
||||||
By default, the last modified draft will be edited.
|
By default, the last modified draft will be edited.
|
||||||
.Pp
|
.Pp
|
||||||
.Nm mfwd
|
.Nm mfwd
|
||||||
behaves like
|
behaves like
|
||||||
.Nm mcom
|
.Nm mcom
|
||||||
but fills the draft with subject and body to forward the messages.
|
but fills the draft with a subject and body appropriate for forwarding the messages.
|
||||||
By default, messages are forwarded verbatim as MIME
|
By default, messages are forwarded verbatim as MIME
|
||||||
.Sq Li message/rfc822
|
.Sq Li message/rfc822
|
||||||
attachments.
|
attachments.
|
||||||
|
@ -16,7 +16,7 @@
|
|||||||
.Op Ar msgs\ ...
|
.Op Ar msgs\ ...
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm
|
.Nm
|
||||||
flags changes the flags of the given
|
changes the flags of the given
|
||||||
.Ar msgs
|
.Ar msgs
|
||||||
according to the options.
|
according to the options.
|
||||||
See
|
See
|
||||||
@ -52,7 +52,7 @@ as trashed.
|
|||||||
.It Fl X Ar str
|
.It Fl X Ar str
|
||||||
Mark
|
Mark
|
||||||
.Ar msgs
|
.Ar msgs
|
||||||
as with the chracters in
|
with the characters in
|
||||||
.Ar str .
|
.Ar str .
|
||||||
.It Fl d
|
.It Fl d
|
||||||
Unmark
|
Unmark
|
||||||
@ -81,14 +81,14 @@ as trashed.
|
|||||||
.It Fl x Ar str
|
.It Fl x Ar str
|
||||||
Unmark
|
Unmark
|
||||||
.Ar msgs
|
.Ar msgs
|
||||||
as with the chracters in
|
with the characters in
|
||||||
.Ar str .
|
.Ar str .
|
||||||
(Remember to use uppercase characters.)
|
(Remember to use uppercase characters.)
|
||||||
.It Fl v
|
.It Fl v
|
||||||
Read Maildir mails from stdin (or the use the whole current sequence, if
|
Read Maildir mails from stdin (or the use the whole current sequence, if
|
||||||
used interactively) and print the transformed list of file names.
|
used interactively) and print the transformed list of file names.
|
||||||
.Pp
|
.Pp
|
||||||
Can be used to keep the sequence intact in advent of renames.
|
This can be used to keep the sequence intact in the case of renames.
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
Note that the
|
Note that the
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
.Nm mlist
|
.Nm mlist
|
||||||
.Nd list mesages in Maildir folders
|
.Nd list messages in Maildir folders
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.Nm
|
.Nm
|
||||||
.Op Fl DFPRST
|
.Op Fl DFPRST
|
||||||
@ -40,7 +40,7 @@ Only list messages marked as seen.
|
|||||||
.It Fl T
|
.It Fl T
|
||||||
Only list messages marked as trashed.
|
Only list messages marked as trashed.
|
||||||
.It Fl X Ar str
|
.It Fl X Ar str
|
||||||
Only list messages marked with the chracters in
|
Only list messages marked with the characters in
|
||||||
.Ar str .
|
.Ar str .
|
||||||
.It Fl d
|
.It Fl d
|
||||||
Don't list messages marked as draft.
|
Don't list messages marked as draft.
|
||||||
@ -55,7 +55,7 @@ Don't list messages marked as seen.
|
|||||||
.It Fl t
|
.It Fl t
|
||||||
Don't list messages marked as trashed.
|
Don't list messages marked as trashed.
|
||||||
.It Fl x Ar str
|
.It Fl x Ar str
|
||||||
Don't list messages marked with the chracters in
|
Don't list messages marked with the characters in
|
||||||
.Ar str .
|
.Ar str .
|
||||||
(Remember to use uppercase characters.)
|
(Remember to use uppercase characters.)
|
||||||
.It Fl C
|
.It Fl C
|
||||||
|
@ -18,7 +18,7 @@ encodes the standard input into a MIME message.
|
|||||||
generates a
|
generates a
|
||||||
.Sq Li multipart/mixed
|
.Sq Li multipart/mixed
|
||||||
mail from standard input,
|
mail from standard input,
|
||||||
extending, wrapping, and encoding the header as neccessary,
|
extending, wrapping, and encoding the header as necessary,
|
||||||
and replacing body lines looking like
|
and replacing body lines looking like
|
||||||
.Pp
|
.Pp
|
||||||
.D1 Li # Ns Ar content Ns Li / Ns Ar type Ns Oo Ns Li # Ns Ar content-disposition Oc Pa path Ns Oo Li > Ns Ar filename Oc
|
.D1 Li # Ns Ar content Ns Li / Ns Ar type Ns Oo Ns Li # Ns Ar content-disposition Oc Pa path Ns Oo Li > Ns Ar filename Oc
|
||||||
|
@ -93,7 +93,7 @@ tests are given by the following EBNF:
|
|||||||
| <timeprop> <numop> <dur>
|
| <timeprop> <numop> <dur>
|
||||||
| <numprop> <numop> <num>
|
| <numprop> <numop> <num>
|
||||||
| <strprop> <strop> <str>
|
| <strprop> <strop> <str>
|
||||||
| prune -- do not match futher messages in thread
|
| prune -- do not match further messages in thread
|
||||||
| print -- always true value
|
| print -- always true value
|
||||||
|
|
||||||
<flagprop> ::= child | draft | flagged | info | new | parent | passed
|
<flagprop> ::= child | draft | flagged | info | new | parent | passed
|
||||||
|
@ -39,7 +39,7 @@ The mail body is copied as-is.
|
|||||||
supports the following commands.
|
supports the following commands.
|
||||||
The separators
|
The separators
|
||||||
.Em after
|
.Em after
|
||||||
the command letter may be subsituted with an arbitrary symbol, just as in
|
the command letter may be substituted with an arbitrary symbol, just as in
|
||||||
.Xr sed 1 .
|
.Xr sed 1 .
|
||||||
Multiple commands can be separated by
|
Multiple commands can be separated by
|
||||||
.Sq Cm \&; .
|
.Sq Cm \&; .
|
||||||
|
Loading…
Reference in New Issue
Block a user