diff options
| author | Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> | 2010-11-13 17:29:20 +0200 |
|---|---|---|
| committer | Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> | 2010-11-13 17:29:20 +0200 |
| commit | 10d2cdd5dac6fa533847331b3c3a99e2b0549e58 (patch) | |
| tree | 99315107246f0a84d44601efe0960f79ff00e495 /man | |
| parent | 7e45c48a0511b75fcb437a891e9a388620ea98ff (diff) | |
* man: add documentation for bookmarks
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 1 | ||||
| -rw-r--r-- | man/mu-bookmarks.5 | 39 | ||||
| -rw-r--r-- | man/mu-find.1 | 5 |
3 files changed, 45 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index 2dbfe19..a1cdd73 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -18,6 +18,7 @@ include $(top_srcdir)/gtest.mk dist_man_MANS = \ mu-cleanup.1 \ + mu-bookmarks.5 \ mu-easy.1 \ mu-extract.1 \ mu-find.1 \ diff --git a/man/mu-bookmarks.5 b/man/mu-bookmarks.5 new file mode 100644 index 0000000..b10b9d9 --- /dev/null +++ b/man/mu-bookmarks.5 @@ -0,0 +1,39 @@ +.TH MU-BOOKMARKS 5 "November 2010" "User Manuals" + +.SH NAME + +bookmarks \- file with bookmarks (shortcuts) for mu + +.SH DESCRIPTION + +Bookmarks are named shortcuts for search queries. They allow using a +convenient name for oft-used queries. + +.B mu +supports bookmarks stored in a file called \bFbookmarks\fR in the mu home +directory (typically, \fI~/.mu/\fR). + +The bookmarks file is a typical key=value '.ini' file, which is best shown +trough an example: +.nf + [mu] + inbox=maildir:/inbox # inbox + oldhat=maildir:/archive subject:hat # archived with subject containing 'hat' +.fi + +The \fB[mu]\fR group header is required. + +For practical use 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). + +.SH AUTHOR + +Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> + +.SH "SEE ALSO" + +mu(1) mu-find(1) mug(1) diff --git a/man/mu-find.1 b/man/mu-find.1 index bb72e69..8d185cd 100644 --- a/man/mu-find.1 +++ b/man/mu-find.1 @@ -220,6 +220,11 @@ Note: when \fBmu\fR creates a Maildir for these links, it automatically inserts a \fI.noindex\fR file, to exclude the directory from \fBmu index\fR. +.TP +\fB\-b\fR, \fB\-\-bookmark\fR=\fI<bookmark>\fR +use a bookmarked search query. Using this option, a query from your bookmark +file will be prepended to other search queries. See mu-bookmarks(1) for the +details of the bookmarks file. .SS Example queries |