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

* manpages updated

Browse Source
This commit is contained in:
Dirk-Jan C. Binnema
2010-11-30 22:11:40 +02:00
parent 2b393ed7c5
commit bc039e22d6
4 changed files with 32 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
man/mu-bookmarks.5
View File

@ -9,7 +9,7 @@ bookmarks \- file with bookmarks (shortcuts) for mu
Bookmarks are named shortcuts for search queries. They allow using a Bookmarks are named shortcuts for search queries. They allow using a
convenient name for oft-used queries. convenient name for oft-used queries.
\fBmu\fR supports bookmarks stored in a file called \bFbookmarks\fR in the \fBmu\fR supports bookmarks stored in a file called \fBbookmarks\fR in the
mu home directory (typically, \fI~/.mu/\fR). mu home directory (typically, \fI~/.mu/\fR).
The bookmarks file is a typical key=value \fB.ini\fR-file, which is best shown The bookmarks file is a typical key=value \fB.ini\fR-file, which is best shown
@ -26,6 +26,7 @@ The \fB[mu]\fR group header is required.
For practical uses of bookmarks, see mu-find(1) or mug(1). For practical uses of bookmarks, see mu-find(1) or mug(1).
.SH LOCATION .SH LOCATION
The bookmarks file is read from \fI<muhome>/bookmarks\fR. Typically, this The bookmarks file is read from \fI<muhome>/bookmarks\fR. Typically, this
would be \fI~/.mu/bookmarks\fR, but this can be influenced using the would be \fI~/.mu/bookmarks\fR, but this can be influenced using the
\fB\-\-muhome\fR parameter for mu-find(1) and mug(1). \fB\-\-muhome\fR parameter for mu-find(1) and mug(1).

12
man/mu-cleanup.1
View File

@ -1,4 +1,4 @@
.TH MU CLEANUP 1 "October 2010" "User Manuals" .TH MU CLEANUP 1 "November 2010" "User Manuals"
.SH NAME .SH NAME
@ -10,15 +10,13 @@ mu cleanup \- clean up the mu database
.SH DESCRIPTION .SH DESCRIPTION
\fBmu cleanup\fR is the \fBmu\fR sub-command for removing messages from the mu \fBcleanup\fR removes messages for which no corresponding file can
database that are no longer present in the file system. be found, from the database. This is done automatically when running
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).
\fBmu cleanup\fR does not remove messages that are outside the currently \fBmu cleanup\fR does not remove messages that are outside the currently
specified Maildir as long as they still exist. specified Maildir, as long as they still exist. The command only takes global
options, which are described in the \fBmu (1)\fR man page.
.SH BUGS .SH BUGS

50
man/mu-easy.1
View File

@ -6,24 +6,24 @@ mu easy \- a quick introduction to mu
.SH DESCRIPTION .SH DESCRIPTION
As you may know, \fBmu\fR is a set of tools for dealing with e-mail messages \fBmu\fR is a set of tools for dealing with e-mail messages in Maildirs. There
in Maildirs. There are many options, which are all described in the individual are many options, which are all described in the individual man pages for the
man pages for the various sub-commands. This man pages jumps over all the various sub-commands. This man pages jumps over all the details and gives
details and gives examples of the more common use cases. If the use cases examples of the more common use cases. If the use cases described here do not
described here do not precisely do what you want, please check the more precisely do what you want, please check the more extensive information in the
extensive information in the man page about the sub-command you are using -- man page about the sub-command you are using -- for example, the mu-index or
for example, the mu-index or mu-find man pages. mu-find man pages.
\fBNOTE\fR: the \fBindex\fR command (and therefore, the ones that depend on \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 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 Maildir-format. If you don't do so, you can still use the other commands, but
cannot index/search your mail. you won't be able to index/search your mail.
.SH INDEXING YOUR E-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 .nf
\fB$ mu index\fR \fB$ mu index\fR
.fi .fi
The process can take a few minutes, depending on the amount of mail you have, The process can take a few minutes, depending on the amount of mail you have,
@ -71,7 +71,7 @@ date/sender/subject. However, we can change this using the \fI--fields\fR
parameter (see the \fBmu-find\fR man page for the details): parameter (see the \fBmu-find\fR man page for the details):
.nf .nf
\fB$ mu find --fields="t s" t:julius fruit\fR \fB$ mu find --fields="t s" t:julius fruit\fR
.fi .fi
In other words, display the 'To:'-field (t) and the subject (s). This should In other words, display the 'To:'-field (t) and the subject (s). This should
@ -88,7 +88,7 @@ is, it displays messages that match all the parameters. However, we can use
logical OR as well: logical OR as well:
.nf .nf
\fB$ mu find t:julius OR f:socrates\fR \fB$ mu find t:julius OR f:socrates\fR
.fi .fi
In other words, display messages that are either sent to Julius Caesar In other words, display messages that are either sent to Julius Caesar
@ -104,7 +104,7 @@ of) the message contents by using the --summary-len=\fIn\fR option, which
will 'summarize' the first \fIn\fR lines of the message: will 'summarize' the first \fIn\fR lines of the message:
.nf .nf
\fB$ mu find --summary-len=4 napoleon m:/archive\fR \fB$ mu find --summary-len=4 napoleon m:/archive\fR
.fi .fi
.nf .nf
@ -162,8 +162,6 @@ Get all message we got in the last two weeks about emacs:
\fB$ mu find date:2w..now emacs\fR \fB$ mu find date:2w..now emacs\fR
.fi .fi
.SH DISPLAYING MESSAGES .SH DISPLAYING MESSAGES
We might also want to display complete messages. This can be done using \fBmu We might also want to display complete messages. This can be done using \fBmu
@ -175,7 +173,7 @@ need its path. To get the path (think \fBl\fRocation) for our first example we
can use: can use:
.nf .nf
\fB$ mu find --fields="l" t:julius fruit\fR \fB$ mu find --fields="l" t:julius fruit\fR
.fi .fi
And we'll get someting like: And we'll get someting like:
@ -185,23 +183,19 @@ And we'll get someting like:
We can now display this message: We can now display this message:
.nf .nf
\fB$ mu view /home/someuser/Maildir/archive/cur/1266188485_0.6850.cthulhu:2,\fR \fB$ mu view /home/someuser/Maildir/archive/cur/1266188485_0.6850.cthulhu:2,\fR
From: John Milton <jm@example.com> From: John Milton <jm@example.com>
To: Julius Caesar <jc@example.com> To: Julius Caesar <jc@example.com>
Subject: Fere libenter homines id quod volunt credunt Subject: Fere libenter homines id quod volunt credunt
Date: 2008-07-31T21:57:25 EEST Date: 2008-07-31T21:57:25 EEST
OF Mans First Disobedience, and the Fruit OF Mans First Disobedience, and the Fruit
Of that Forbidden Tree, whose mortal tast Of that Forbidden Tree, whose mortal tast
Brought Death into the World, and all our woe, Brought Death into the World, and all our woe,
[...] [...]
.fi .fi
.SH BUGS
Please report bugs if you find them:
.BR http://code.google.com/p/mu0/issues/list
.SH AUTHOR .SH AUTHOR
Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>

14
man/mu.1
View File

@ -136,6 +136,7 @@ lists the various command line options, while \fB\-\-help\-index\fR,
respectively the specified command or for all commands. respectively the specified command or for all commands.
.SH BUGS .SH BUGS
Please report bugs if you find them: Please report bugs if you find them:
.BR http://code.google.com/p/mu0/issues/list .BR http://code.google.com/p/mu0/issues/list
@ -145,14 +146,5 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO" .SH "SEE ALSO"
.BR mu-index(1) .BR mu-index(1) mu-cleanup(1) mu-find(1) mu-mkdir(1) mu-view(1)
.BR mu-extract(1) mu-easy(1) mu-bookmarks(5)
.BR mu-cleanup(1)
.BR mu-find(1)
.BR mu-mkdir(1)
.BR mu-view(1)
.BR mu-extract(1)