From ec8bd8445f161c54d082e22740d0d8a7139fcc84 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Mon, 29 Nov 2010 21:32:15 +0200 Subject: [PATCH] * update NEWS, TODO and manpages --- NEWS | 2 ++ TODO | 3 ++- man/mu-find.1 | 40 +++++++++++++--------------------------- man/mu-index.1 | 21 +++++++++------------ 4 files changed, 26 insertions(+), 40 deletions(-) diff --git a/NEWS b/NEWS index f667e21e..0d5cd342 100644 --- a/NEWS +++ b/NEWS @@ -16,6 +16,8 @@ - make matching case-insensitive and accent-insensitive (accent-insensitive for characters in Unicode Blocks 'Latin-1 Supplement' and 'Latin Extended-A' ) + - more extensive pre-processing is done to make searching for email-addresses + and message-ids less likely to not work - updated the man-pages ** Release 0.8 <2010-10-30 Sat> diff --git a/TODO b/TODO index b41eceff..b03dc5cb 100644 --- a/TODO +++ b/TODO @@ -14,7 +14,7 @@ ** release 0.9 [100%] - [X] bookmarks - [X] gtk-ui for searching - - [X] clean up mu-msg-field, add formatting(?) + - [X] clean up mu-msg-field - [X] normalize search fields - [X] cleanup version check - [X] propagate errors to ui @@ -27,6 +27,7 @@ - [X] fix sorting by date in mug - [X] make mug icon square - [X] fix sort-order + - [X] pre-process terms, queries for '@'/':'/'.' * Releases already done diff --git a/man/mu-find.1 b/man/mu-find.1 index f0d27103..ee79ed4e 100644 --- a/man/mu-find.1 +++ b/man/mu-find.1 @@ -65,23 +65,6 @@ would do in an internet search engine. For example, will find all messages that contain both 'monkey' and 'banana' in either body or subject or one of the address-fields (to/from/cc). -Note that due to the way to Xapian query parser functions, the match with -e-mail addresses may fail, because Xapian handles characters like '@', '.' (as -seen in e-mail addresses) in a special way. However, you can match those still -if you an explicit search prefix; in other words, if, for example: - -.nf - $ mu find foo@example.com -.fi - -might not work, while - -.nf - $ mu find f:foo@example.com -.fi - -does. - As mentioned, matching is case-insensitive and accent-insensitive; thus @@ -142,8 +125,8 @@ attachment: .fi The message-priority has three possible values: low, normal or high. We can -match them using 'prio' - for example, to get all high-priority messages with -a subject containing some bird: +match them using \fBprio:\fR - for example, to get all high-priority messages +with a subject containing some bird: .nf $ mu find prio:high subject:nightingale @@ -168,20 +151,21 @@ can do with a single '/': (and of course you can use the \fBm:\fR shortcut instead of \fBmaildir:\fR) -The date:/d: search parameter is 'special' in the fact that it takes a range -of dates. For now, these dates are in ISO 8601 format (YYYYMMDDHHMM); you can -leave out the right part, and mu will add the rest, depending on whether this -is the beginning or end of the date interval. For example, for the beginning -of the interval "201012" would be interpreted as "20101201010000", or December -1, 2010 at 00:00, while for the end of the interval, this would be interpreted -as "20101231122359", or December 31, 2010 at 23:59. +The \fBdate:\fR (or \fBd:\fR) search parameter is 'special' in the fact that +it takes a range of dates. For now, these dates are in ISO 8601 format +(YYYYMMDDHHMM); you can leave out the right part, and mu will add the rest, +depending on whether this is the beginning or end of the date interval. For +example, for the beginning of the interval "201012" would be interpreted as +"20101201010000", or December 1, 2010 at 00:00, while for the end of the +interval, this would be interpreted as "20101231122359", or December 31, 2010 +at 23:59. To get all messages between (inclusive) the 5th of May 2009 and the 2nd of June 2010, you could use: .nf $ mu find date:20090505..20100602 .fi -Characters like ':', '/', '-' and single '.' are ignore, so the following is +Characters like ':', '/', '-' and single '.' are ignored, so the following is equivalent but more readable: .nf $ mu find date:2009-05-05..2010-06-02 @@ -429,6 +413,8 @@ definitions can be used; typing 'Q' will start a query. Please report bugs if you find them: .BR http://code.google.com/p/mu0/issues/list +If you have specific messages which are not matched correctly, please attach +them (appropriately censored of course). .SH AUTHOR diff --git a/man/mu-index.1 b/man/mu-index.1 index 5b5433c9..eaa2a640 100644 --- a/man/mu-index.1 +++ b/man/mu-index.1 @@ -1,4 +1,4 @@ -.TH MU-INDEX 1 "September 2010" "User Manuals" +.TH MU-INDEX 1 "November 2010" "User Manuals" .SH NAME @@ -155,21 +155,18 @@ which put the database in \fI~/.mu/xapian\-\fR. These older databases can safely be deleted. Starting from version 0.7, this manual cleanup should no longer be needed. -By default, \fBmu\fR stores logs of its operations and queries in \fI~/.mu/mu.log\fR. -Upon startup, \fBmu\fR checks the size of this log file. If it exceeds 1 MB, -it will be moved to \fI~/.mu/mu.log.old\fR, overwriting any existing file of -that name, and start with an empty \fI~/.mu/mu.log\fR. This scheme allows for -continued use of \fBmu\fR without the need for any manual maintenance of log -files. - -To store these files elsewhere from their default location, one can use the -\fI\-\-muhome\fR option, as discussed in the \fBmu\fR-manpage. +\fBmu\fR stores logs of its operations and queries in \fI/mu.log\fR +(by default, this is \fI~/.mu/mu.log\fR). Upon startup, \fBmu\fR checks the +size of this log file. If it exceeds 1 MB, it will be moved to +\fI~/.mu/mu.log.old\fR, overwriting any existing file of that name, and start +with an empty log file. This scheme allows for continued use of \fBmu\fR +without the need for any manual maintenance of log files. .SH ENVIRONMENT \fBmu index\fR uses \fBMAILDIR\fR to find the user's Maildir if it has not -been specified explicitly with \fB\-\-maildir\fR=\fI\fR. If MAILDIR -is not set, \fBmu index\fR will try \fI~/Maildir\fR. +been specified explicitly with \fB\-\-maildir\fR=\fI\fR. If +\fBMAILDIR\fR is not set, \fBmu index\fR will try \fI~/Maildir\fR. .SH BUGS