alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

* many: documentation updates

Browse Source
This commit is contained in:
Dirk-Jan C. Binnema
2010-10-26 00:25:14 +03:00
parent 0fadc5e360
commit 8146cdb8b1
7 changed files with 74 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
man/mu-cleanup.1
View File

@ -1,4 +1,4 @@
.TH MU CLEANUP 1 "September 2010" "User Manuals"
.TH MU CLEANUP 1 "October 2010" "User Manuals"
.SH NAME
@ -15,15 +15,11 @@ database that are no longer present in the file system.
The \fBcleanup\fR command removes messages for which no corresponding file can
be found, from the database. Note that this is done automatically when running
\fBmu index\fR (unless \fB\-\-nocleanup\fR was specified).
\fBmu index\fR (unless \fB\-\-nocleanup\fR was specified).
.SH ENVIRONMENT
\fBmu cleanup\fR does not remove messages that are outside the currently
specified Maildir as long as they still exist.
Like \fBmu index\fR, \fBmu cleanup\fR uses \fBMAILDIR\fR to find the user's
Maildir if it has not been specified explicitly with
\fB\-\-maildir\fR=\fI<maildir>\fR. If MAILDIR is not set, \fBmu cleanup\fR will
try \fI~/Maildir\fR.
.
.SH BUGS
Please report bugs if you find them:

28
man/mu-easy.1
View File

@ -1,4 +1,4 @@
.TH MU-EASY 1 "September 2010" "User Manuals"
.TH MU-EASY 1 "October 2010" "User Manuals"
.SH NAME
@ -14,29 +14,27 @@ described here do not precisely do what you want, please check the more
extensive information in the man page about the sub-command you are using --
for example, the mu-index or mu-find man pages.
\fBNOTE\fR: the 'index' command (and therefore, the ones that depend on
that, 'cleanup' and 'search'), require that you store your mail in the
\fBNOTE\fR: the \fBindex\fR command (and therefore, the ones that depend on
that, such as \fBfind\fR), require that you store your mail in the
Maildir-format. If you don't do so, you can still use the other commands, but
cannot index/search your mail.
.SH INDEXING YOUR E-MAIL
Before you can search e-mails, you'll first need to index them:
Before you can search e-mails, you'll first need to index them:
.nf
\fB$ mu index\fR
.fi
The process can take a few minutes, depending on the amount of mail you
have, the speed of your computer, drive etc. Usually, indexing should be able
to reach a speed of a few hundred messages per second.
The process can take a few minutes, depending on the amount of mail you have,
the speed of your computer, hard drive etc. Usually, indexing should be able to
reach a speed of a few hundred messages per second.
Indexing gives some progress information, and it shows which directories it is
indexing. If the Maildir-directory it guessed is not the right one, you can
use the \fI--maildir\fR option. See the \fBmu-index\fR man page for more
\fBmu index\fR guesses the top-level Maildir to do its job; if it guesses
wrong, you can use the \fI--maildir\fR option to specify the top-level
directory that should be processed. See the \fBmu-index\fR man page for more
detail.
Note, you
.SH SEARCHING YOUR E-MAIL
After you have indexed your mail, you can search it. Normally, the search
results are to standard output, but the output can also be in the form of
@ -78,9 +76,9 @@ return something like:
This is the same message found before, only with some different fields displayed.
By default, \fBmu\fR uses the logical \fBand\fR for the search parameters --
that is, it displays messages that match all the parameters. However, we can
use logical \fBor\fR as well:
By default, \fBmu\fR uses the logical AND for the search parameters -- that
is, it displays messages that match all the parameters. However, we can use
logical OR as well:
.nf
\fB$ mu find t:julius OR f:socrates\fR

2
man/mu-index.1
View File

@ -50,7 +50,7 @@ tries to shutdown gracefully; it tries to save and commit data, and close the
database etc. If it receives another signal (e.g,, when pressing Ctrl-C once
more), \fBmu index\fR will terminate immediately.
.SS Indexing options
.SH OPTIONS
.TP
\fB\-m\fR, \fB\-\-maildir\fR=\fI<maildir>\fR

18
man/mu.1
View File

@ -1,4 +1,4 @@
.TH MU 1 "September 2010" "User Manuals"
.TH MU 1 "October 2010" "User Manuals"
.SH NAME
@ -29,9 +29,9 @@ scanning a Maildir directory tree and analyzing the e-mail messages found. The
results of this analysis are stored in a database, which can then be queried.
In addition to indexing and searching, \fBmu\fR also offers functionality for
viewing messages and creating maildirs.
viewing messages, extracting attachments and creating maildirs.
\fBmu\fR can be used from the command line, or can be integrated with e-mail
\fBmu\fR can be used from the command line or can be integrated with e-mail
clients. Note: the various sub-commands have their own manpages.
.SH COMMANDS
@ -53,7 +53,8 @@ corresponding message file in the file system. See
\.
.TP
\fBfind\fR for finding messages in your database, using certain search
\fBfind\fR
for finding messages in your database, using certain search
parameters. See
.BR mu-find(1)
\.
@ -70,22 +71,23 @@ for creating Maildirs. See
.BR mu-mkdir(1)
\.
.TP
\fBextract\fR
for extract MIME-parts (such as attachments) from messages. See
.BR mu-extract(1)
\.
Subcommands \findex\fR, \ffind\fR and \cleanup\fR work with the database,
.SH " "
Commands \fBmu index\fR, \fBfind\fR and \fBcleanup\fR work with the database,
while the other ones work on invidual mail files. Hence, running \fview\fR,
\fBmkdir\fR and \fBextract\fR does not require the mu database.
.TP
The various commands are discussed in more detail in their own separate
man-pages; here the general options are discussed.
.SH GENERAL OPTIONS
.SH OPTIONS
\fBmu\fR offers a number of general options that apply to all commands,
including \fBmu\fR without any command.