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

* update for 0.9.3

This commit is contained in:
Dirk-Jan C. Binnema 2011-02-13 15:44:36 +02:00
parent 2741ef7ce6
commit 2bb1272623
4 changed files with 3 additions and 424 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
configure.ac
View File

@ -14,7 +14,7 @@
## along with this program; if not, write to the Free Software Foundation,
## Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
AC_INIT([mu],[0.9.2],[http://code.google.com/p/mu0/issues/list])
AC_INIT([mu],[0.9.3],[http://code.google.com/p/mu0/issues/list])
AC_CONFIG_HEADERS([config.h])
AC_CONFIG_SRCDIR([src/mu.cc])
AM_INIT_AUTOMAKE([dist-bzip2])

93
www/faq.org
View File

@ -1,93 +0,0 @@
Questions & answers about mu.
** Indexing
*Q*: I have some maildirs with spam and junk e-mail that I /don't/ want to
include in the indexing process. How can I tell =mu= to ignore those?
*A*: Put a file called =.noindex= in the directory (maildir) you'd like
to ignore, and mu will not index that directory, nor any of its
sub-maildirs.
*Q*: =mu index= complains about some messages being too big; what can I do
about that?
*A*: since =0.9.2=, there is =--max-msg-size= where you can set the maximum
size (in bytes) of messages that =mu= should consider. In older versions,
you'd need to update =MU_MAILDIR_WALK_MAX_FILE_SIZE= in =mu-maildir.c= and
recompile.
** Searching
*Q*: Do you have some examples of queries?
*A*: sure, see the =mu-easy= man page (=man mu-easy=), or see below.
*Q*: I have some folders with spaces in their names; how can I match those?
*A*: You'll have to quote the folder name; and from the command line that
means you'll have to escape those quotes; for example:
#+begin_example
$ mu find maildir:"\"Sent Items\""
#+end_example
Note that matching maildirs with 'special' characters like dots, '@' was
problematic in some older =mu=-versions, but should work well with the
=0.9.2= and beyond.
*Q*: I'd like to get the result of a query as a list of the message files. Is
that possible?
*A*: Yes; using the =l= (small letter L) in the format, you can do something
like:
#+begin_example
$ mu find --fields=l athens
#+end_example
to get the file names (paths) of all messages about Athens. Of course, you
can use that for further processing. For example, to get list of e-mail files
sorted by their length in lines:
#+begin_example
$ mu find --fields=l athens | xargs wc -l | sort -n
#+end_example
** Showing the results
*Q*: Can I get the output in some other format that lines of plain text? Say,
in XML?
*A*: Starting with version 0.9.2, there is (experimental) support for output
in XML, JSON and s-expressions. Use =--format=xml=-argument (or
=--format=sexp=, =--format=json= ) to =mu find= for this. Note that this is
still experimental, and the exact formats have not been fixed yet.
*Q*: Can I integrate =mu find= with my e-mail client?
*A*: Yes, at least for some mail clients like =mutt= and =Wanderlust= (for
emacs) you can do that. For this, =mu= uses a special trick where the
results of a search are put in a special temporary maildir with symbolic
links to the found messages, and the visiting this temporary maildir with
the mail client. The =mu-find= man page has some examples on how to
integrate this with mail clients.
*Q*: Is there some GUI for =mu=?
*A*: A GUI is being developed, but it will take some time to be
ready. However, as of version 0.9.1, in the =toys/=-directory of the =mu=
source package you'll find =mug= and =mug2=, which show-case parts of the
future GUI. =mug2= is the more feature-rich one, and requires a fairly
recent GTK+/Glib and Webkit, while =mug= only requires GTK+. If you have the
required packages, =mug=/=mug2= will automatically be built; however, =make
install= will *not* install them. You'll need to run them from their
directory. [[http://www.djcbsoftware.nl/code/mu/mug-full.png][Screenshot]].
** Example queries

328
www/index.html
View File

@ -1,328 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
<title>mu - e-mail searching and indexing</title>
<style type="text/css">
body {
margin:0px;
background:#666666;
color: black;
padding: 0px;
font-family: arial, Helvetica, 'Bitstream Vera Sans', 'Luxi Sans', Verdana,
Sans-Serif;
font-size: 12px;
}
a.menu {font-weight: bold}
a.menu:link {color: #ffffff; text-decoration: none; }
a.menu:active {color: #ff0000; text-decoration: none; }
a.menu:visited {color: #ffffff; text-decoration: none; }
a.menu:hover {color: #ff0000; text-decoration: underline; }
.mine {color: #ffffff; font-weight: bold}
</style>
</head>
<body>
<table width="100%" bgcolor="#666666">
<tr>
<td><img src="mu-small.png" align="left" alt="mu-small"> </td>
<td align="right" class="menu">
<a class="menu" href="#welcome" >welcome</a> |
<a class="menu" href="#mug" >mug</a> |
<a class="menu" href="#news" >news</a> |
<a class="menu" href="#features" >features</a> |
<a class="menu" href="#download" >download</a> |
<a class="menu" href="#repo" >repository</a> |
<a class="menu" href="#building" >building</a> |
<a class="menu" href="#license" >license</a> |
<a class="menu" href="#contact" >contact</a></td>
</tr>
</table>
<table width="800" align="center" bgcolor="#cccccc">
<tr><td>
<!-- <img src="mu.jpg" align="left"> -->
<img src="mu.jpg" align="right" alt="mu">
<!-- <img src="mu.png" align="right"> -->
<h2><a name="welcome">welcome to mu</a></h2>
<p>For many people, e-mail is the 'flow' in their work-flow. One spends
a <em>lot</em> of time searching for old e-mails, digging up some important
piece of information. With people having tens of thousands of e-mails (or
more), this is becoming harder and harder. How to find that one message in the
evergrowing information haystack?
<p>Enter <strong>mu</strong>. 'mu' is a set of command-line tools for
Linux/Unix that enable you to quickly find the e-mails you are looking for.
The main requirement is that you store your e-mails <strong>in
Maildirs</strong>. If you have no idea what 'Maildirs' are, you are probably
not using them.
<h3>how does it work?</h3>
<p>First, you need to <i>index</i> your messages. Indexing means filling a
database with information about your e-mails; this may take a couple of
minutes the first time you do it, but after that it's a lot
faster. <tt>mu</tt> indexes your mail with the <tt>index</tt> command:
<pre>
$ mu index
</pre>
It tries to pick reasonable defaults, but you can specify your own options as
well. You could run <tt>mu index</tt> periodically to keep your database
up-to-date. Or you could trigger it when new mails have arrived.
<p>After building the database, it's easy to search for messages. For example:
<ul>
<li>
<i>get all mails about birds <b>and</b> bees</i> somewhere in the message
or headers: <pre>
$ mu find birds bees</pre>
if you want to find message with either one of those, you can do:<pre>
$ mu find 'birds OR bees'</pre>
</li>
<li>
<i>get all Smith's mails with 'capybara' in the subject line</i><pre>
$ mu find from:smith subject:capybara</pre>
</li>
<li>
<i>get the mails in the archive folder where Mary was Cc'd</i><pre>
$ mu find maildir:/archive cc:mary</pre>
</li>
</ul>
Starting with version 0.9, you can search for date ranges, message flags and
message priority as well:
<ul>
<li>
<i>get mails with attachments from the last two weeks:</i><pre>
$ mu find flag:attach date:2w..now</pre>
</li>
<li>
<i>get all important mails in March and April 2010:</i><pre>
$ mu find prio:high date:2010-03..2010-04</pre>
</li>
</ul>
<p>Searches are case-insensitive as well as 'accent insensitive' (version 0.9
and up); so <i>angStroM</i> will match <i>Ångström</i>. Often-used queries
can be stored in bookmarks file.
<p>The way to express the searches may be a bit cryptic at first, but easy to
learn (in the author's biased opinion); the mu manpages discuss syntax and
usage. There is also the <tt>mu-easy</tt> man-page which contains a lot of
simple examples to get you going.
<p>NOTE: while searching from the command-line is useful, mu can also easily
be integrated with some e-mail clients. The documentation includes examples
for integration with <em>mutt</em> and <em>Wanderlust</em>.
<p><strong>mu</strong> is <em>Free Software</em> (GPLv3), runs on
Unix/Linux-based systems, and uses the <a href="http://www.xapian.org"
>Xapian</a> text indexing engine. <strong>Important</strong>: for mu to work,
your mails must be stored in a set of <a
href="http://www.qmail.org/qmail-manual-html/man5/maildir.html" >maildirs</a>
<h2><a name="mug" >mug</a><a href="mug-full.png"><img src="mug-thumb.png"
align="right" border="0"></a></h2> Starting with version 0.9.2, there is
now <b>two</b> toy UIs for <tt>mu</tt>, called <tt>mug</tt>
and <tt>mug2</tt>. The latter has more features, but also adds some
dependencies if you want it - both <tt>mug</tt>/<tt>mug2</tt> are
optional. The longer-term goal is to have a bit more complete graphical
user-interface. Currently, the UIs are not installed, you need to run them
from their build directory. If you have defined bookmarks, the are shown in
the toolbar on the left side of the window, as can be seen in the screenshot.
<h2><a name="news" >news</a></h2>
<ul>
<li>[2011-02-02] <strong>mu version 0.9.2</strong> released, with a few new
features, such as size-based matching (e.g,. <tt>size:2k..2m</tt> to match
message between 2kB and 2MB), (experimental) output in XML/JSON/s-expression
format, updated toy-UI ('mug' and 'mug2'), support for Solaris and
Gentoo. For a complete list of the user-visible changes and some of the
changes in command-line parameters, see
<a href="http://gitorious.org/mu/mu-ng/blobs/master/NEWS">NEWS</a>.
<li>[2010-12-05] <strong>mu version 0.9.1</strong> released; fixes a couple
of issues users found with a missing icon, the unit-tests.
<li>[2010-12-04] <strong>mu version 0.9</strong> released. Compared to the
bèta-release, there were a number of improvements to the documentation and
the unit tests. Pre-processing queries is a little bit smarter now, making
matching e-mail address more eager. Experimental support for Fedora-14.
<li>[2010-11-27] <strong>mu version 0.9-beta</strong> released. New
features: searching is now accent-insensitive; you can now search for
message priority (<tt>prio:</tt>), time-interval (<tt>date:</tt>) and
message flags (<tt>flag:</tt>). Also, you can now store ('bookmark')
often-used queries. To top it off, there is a simple graphical UI now,
called <tt>mug</tt>. Documentation has been update, and all known bugs have
been fixed.
<li>[2010-10-30] <strong>mu version 0.8</strong> released, with only some
small cosmetic updates compared to 0.8-beta. Hurray!
<li>[2010-10-23] <strong>mu version 0.8-beta</strong> released. The new
version brings <tt>mu extract</tt> for getting the attachments from
messages, improved searching (matching is a bit more 'greedy'), updated and
extended documentation, including the <tt>mu-easy</tt> manpage with simple
examples. All known non-enhancement bugs were fixed.
<li>[2010-02-27] <strong>mu version 0.7</strong> released. Compared to the
beta version, there are few changes. The maildir-matching syntax now
contains a starting <tt>/</tt>, so <tt>~/Maildir/foo/bar/(cur|new)/msg</tt>
can be matched with <tt>m:/foo/bar</tt>. The top-level maildir can be
matched with <tt>m:/</tt>. Apart from that, there are so small cosmetic
fixes and documentation updates.
<li>[2010-02-11] <strong>mu version 0.7-beta</strong> released. A lot of changes:
<ul>
<li>Automatic database scheme version check, notifies users when an upgrade
is needed</li>
<li>Adds the <tt>mu view</tt> command, to view mail message files</li>
<li>Removes the 10K match limit</li>
<li>Support for unattended upgrades - that is, the database can automatically
by upgraded (--autoupgrade). Also, the log file is automatically cleaned
when it gets too big (unless you use --nocleanup)</li>
<li>Search for a certain Maildir using the
<tt>maildir:</tt>,<tt>m:</tt> search prefixes. For
example, you can find all messages located in <tt>~/Maildir/foo/bar/(cur|new)/msg</tt>
with <tt>m:foo/bar</tt>. This replaces the search for path/p in 0.6</li>
<li>Fixes for reported issues #17 and #18</li>
<li>A test suite with a growing number of unit tests</li>
<li>Updated documentation</li>
<li>Many internal refactoring and other changes</li>
</ul>
<p>This version has been tagged as <tt>v0.7-beta</tt> in repository, and must
be considered a code-complete preview of the upcoming release 0.7. Please
report any problems you encounter with it.</li>
</li>
<li>[2010-01-23] <strong>mu version 0.6</strong> released. Changes compared
to the beta version are:
<ul>
<li>improved documentation, with more examples and more extensive
discussion of various technical aspects</li>
<li>some fixes, thanks to bug reports from beta-testers</li>
<li>added search for the the Message-Id field.</li>
</ul>
There is a separate branch for 0.6 in the git repository (see below), HEAD
will become 0.7</li>
</li>
<li>[2010-01-16] <strong>mu version 0.6-beta</strong>. After some
hiatus in the release schedule, <tt>mu</tt> is back now! The new
version is a total overhaul of what was there before. It's smaller
and faster, and removes quite a bit of the (in the eyes of the
author) needless complexity.
It adds some new features that users asked for, such as a way to
exclude directories from indexing (simply put a file called
<tt>.noindex</tt> in it.
The queries are bit less featureful, the more useful parts will
slowly be added again in future versions.
Note, this is version 0.6-beta, the 'real' 0.6 will follow soon.</li>
<li>[2008-11-01] <strong>mu version 0.4</strong> released. This version adds
extensions to the query language and the ability to get statistics about the
messages that match some queries. <tt>mu-index</tt> is substantially faster.
Also, <tt>mu-msginfo</tt> has been extended. Small optimizations have been
done, and some bugs have been fixed. Finally, some GTK+-widgets have been
added; they are to be considered 'experimental'.</li>
<li>[2008-09-25] <strong>mu version 0.3</strong> released; this version adds
further signicant indexing speedups (esp. on <tt>ext3</tt>-file
systems). Added searching for relative dates ('3w' for 'three weeks ago');
search for message properties such as has-attachment/signed/encrypted;
search for message priority; updated documentation; define bookmarks for
search queries; more unit-tests.</li>
<li>[2008-09-10] <strong>mu version 0.2</strong> released; this version adds
supports for message-body searches (Xapian); indexing is much faster; added
Maildir++ support; sorting of results; added
<tt>mu-mkmdir</tt>/<tt>mu-msginfo</tt>. Improved documentation, unit
tests.</li>
<li>[2008-08-25] <strong>mu version 0.1</strong> released</li>
</ul>
<h2><a name="features" >features</a></h2>
<strong><tt>mu find</tt></strong>:
<ul>
<li>search for sender and recipient; subject,message body text</li>
<li>output to stdout, or as maildirs with links to the original messages</li>
</ul>
<strong><tt>mu index</tt></strong>:
<ul>
<li>scan messages in recursive Maildirs, Maildir++ or separate files;</li>
<li>only changed messages are considered when re-indexing;</li>
</ul>
<h2><a name="download" >download and license</a></h2>
You can download mu releases from their <a
href="http://code.google.com/p/mu0/downloads/list" >download page</a> (Google
Code). <tt>mu</tt> is released under the terms of the <a
href="http://www.gnu.org/licenses/gpl-3.0.html" >GNU General Public
License</a> (GPL), version 3 or later.
<P>
<h2><a name="repo">development</a></h2>
The mu source code is available <a href="http://gitorious.org/mu/mu-ng">in
Gitorious</a>; get it from there:
<pre>
$ git clone git://gitorious.org/mu/mu-ng.git
</pre>
This is the source code for future versions of mu; there are tags
for released versions. If you're not planning on getting involved in the
development of mu, it is recommended you use the actual releases. The git
version, in particular the 'master' branch, may break at times.
<p>There is now also a <a href="http://groups.google.com/group/mu-discuss"
>mailing list</a> available.
<h2><a name="building">building and dependencies</a></h2>
<tt>mu</tt> uses <a href="http://spruce.sourceforge.net/gmime/" >GMime
2.4</a> and <a href="http://xapian.org" >Xapian</a>; you'll need to
have those installed to build <tt>mu</tt>. On Debian/Ubuntu, the
following should get you all you need:
<pre> # apt-get install libxapian-dev libgmime-2.4-dev </pre>
(obviously, you also need the normal build tools;
<tt>gcc</tt>/<tt>g++</tt>, <tt>make</tt> and friends).
<p>mu uses autotools, so building follows the normal
<tt>./configure</tt>/<tt>make</tt> pattern.
<p>This should work without any problems at least on recent Debian/Ubuntu, for
both 32-bit and 64-bit architectures. If it does not work for your
distribution, please <a href="http://code.google.com/p/mu0/issues/list" >file
a bug</a> with all the error messages, relevant information about your system
etc. that you got.
<h2><img src="mu.png" align="right"><a name="contact" >contact</a></h2> If you
think you have found a bug, or you have a good idea for a feature, please put
them in the <a href="http://code.google.com/p/mu0/issues/list" >issue list</a>
(Google Code).
<p><tt>mu</tt> was designed and implemented by me, <strong>Dirk-Jan
C. Binnema</strong>, as a hobby project for my copious free time. It has no
relation to my employer.
<p>You can send e-mail to djcb-at-djcbsoftware-dot-nl.</td>
</tr>
</table>
<div align="right" class="mine">
&copy;2008-2010 Dirk-Jan C. Binnema
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-578531-1");
pageTracker._trackPageview();
</script>
</body> </html>

4
www/index.org
View File

@ -19,8 +19,8 @@
** News
- 2011-02-13: Updated the web page with pages for [[file:mug.org][mug]] (the experimental UI)
and the [[file:cheatsheet.org][mu cheatsheet]].
- 2011-02-13: *mu 0.9.3*; fixes a bunch of minor issues in 0.9.2; updated the
web page with pages for [[file:mug.org][mug]] (the experimental UI) and the [[file:cheatsheet.org][mu cheatsheet]].
- 2011-02-02: *mu 0.9.2* released, which adds support for matching on message
size, and various new output format. See [[http://gitorious.org/mu/mu-ng/blobs/master/NEWS][NEWS]] for all the user-visible