mirror of https://github.com/djcb/mu.git
* man: add documentation for bookmarks
This commit is contained in:
parent
7e45c48a05
commit
10d2cdd5da
|
@ -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 \
|
||||
|
|
|
@ -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)
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in New Issue