emacs
/
mu
mirror of https://github.com/djcb/mu.git
1
0
Fork 0
Code Issues Releases Wiki Activity

* manpages updated

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
Show Stats 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
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).
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).
.SH LOCATION
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
\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
@ -10,15 +10,13 @@ mu cleanup \- clean up the mu database
.SH DESCRIPTION
\fBmu cleanup\fR is the \fBmu\fR sub-command for removing messages from the mu
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
\fBcleanup\fR removes messages for which no corresponding file can
be found, from the database. This is done automatically when running
\fBmu index\fR (unless \fB\-\-nocleanup\fR was specified).
\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

22
man/mu-easy.1
View File

@ -6,18 +6,18 @@ mu easy \- a quick introduction to mu
.SH DESCRIPTION
As you may know, \fBmu\fR is a set of tools for dealing with e-mail messages
in Maildirs. There are many options, which are all described in the individual
man pages for the various sub-commands. This man pages jumps over all the
details and gives examples of the more common use cases. If the use cases
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.
\fBmu\fR is a set of tools for dealing with e-mail messages in Maildirs. There
are many options, which are all described in the individual man pages for the
various sub-commands. This man pages jumps over all the details and gives
examples of the more common use cases. If the use cases 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 \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.
you won't be able to index/search your mail.
.SH INDEXING YOUR E-MAIL
Before you can search e-mails, you'll first need to index them:
@ -162,8 +162,6 @@ Get all message we got in the last two weeks about emacs:
\fB$ mu find date:2w..now emacs\fR
.fi
.SH DISPLAYING MESSAGES
We might also want to display complete messages. This can be done using \fBmu
@ -198,10 +196,6 @@ We can now display this message:
[...]
.fi
.SH BUGS
Please report bugs if you find them:
.BR http://code.google.com/p/mu0/issues/list
.SH AUTHOR
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.
.SH BUGS
Please report bugs if you find them:
.BR http://code.google.com/p/mu0/issues/list
@ -145,14 +146,5 @@ Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
.SH "SEE ALSO"
.BR mu-index(1)
.BR mu-cleanup(1)
.BR mu-find(1)
.BR mu-mkdir(1)
.BR mu-view(1)
.BR mu-extract(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)