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

* use org-mode for the mu web pages, updated them.

This commit is contained in:
Dirk-Jan C. Binnema 2011-02-13 10:46:50 +02:00
parent 4dad5bcb66
commit 2741ef7ce6
5 changed files with 284 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
www/cheatsheet.org Normal file
View File

@ -0,0 +1,81 @@
#+style: <link rel="stylesheet" type="text/css" href="mu.css"/>
#+html:<a href="index.html"><img src="mu.png" border="0" align="right"/></a>
#+title: Mu Cheatsheet
* Mu Cheatsheet
Here are some tips for using =mu=. If you want to know more, please refer to the
=mu= man pages. For a quick warm-up, there's the =mu-easy= man-page.
** Indexing your mail
You can index your mail with:
#+begin_src sh
$ mu index
#+end_src
If =mu= did not guess the right Maildir, you can set it explicitly:
#+begin_src sh
$ mu index --maildir=~/MyMaildir
#+end_src
If you want to exclude certain directories from being indexed (for example,
directories with spam-messages), put a file called =.noindex= in the directory
to exlude, and it will be ignored when indexing (including its children)
** Finding messages
After you have indexed your messages, you can search them. Here are some
examples.
*** messages about Helsinki
#+begin_src sh
$ mu find Helsinki
#+end_src
*** messages to Jack with subject jellyfish containing the word tumbleweed
#+begin_src sh
$ mu find to:Jack subject:jellyfish tumbleweed
#+end_src
*** messages between 2 kilobytes and a 2Mb, written in December 2009 with an attachment from Bill
#+begin_src sh
$ mu find size:2k..2m date:20091201..20093112 flag:attach from:bill
#+end_src
** Further processing of matched messages
If you need to process the results of your queries with some other program,
you can return the results as a list of absolute paths to the messages found:
For example, to get the number of lines in all your messages mentioning
/banana/, you could use something like:
#+begin_src sh
$ mu find --fields="'l'" banana | xargs wc -l
#+end_src
Note that we use ='l'=, so the returned message paths will be quoted. This is
useful if you have maildirs with spaces in their names.
For further processing, also the ~--format=(xml|json|sexp)~ may be
interesting.
** Integration with mail clients
See the example in the =mu-find= man page.
#+html:<hr/><div align="center">&copy; 2011 Dirk-Jan C. Binnema</div>
#+begin_html
<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>
#+end_html

76
www/index.org Normal file
View File

@ -0,0 +1,76 @@
#+title: Mu
#+style: <link rel="stylesheet" type="text/css" href="mu.css">
#+html:<img src="mu.jpg" align="right" margin="10px"/>
* Welcome to mu!
Given the /enormous/ amounts of e-mail many people gather, and the importance
of e-mail message in our work-flows, it's essential to quickly deal with all
that mail - in particular, to instantly find that one important e-mail you
need right now.
*mu* is a tool for dealing with e-mail messages stored in the
[[http://en.wikipedia.org/wiki/Maildir][Maildir]]-format. *mu* main purpose is to help you to quickly find the messages
you need; in addition, it allows you to quickly to view messages, extract
attachments, create new maildirs, ... See the [[file:cheatsheet.org][mu cheatsheet]] for some examples.
Searching works by first indexing your messages into a [[http://xapian.org/][Xapian]]-database. After
that, you can quickly find message using a powerful query language.
** 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-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
changes, also from older releases.
- [[file:old-news.org][Old news]]
** Features
- fast indexing for Maildir, Maildir+ and Maildir-on-VFAT
- search for messages based on the sender, receiver, size, priority, words in
the message body, attachments, date range, certain flags (signed,
encrypted, new, replied, ...)
- known to work on Linux (Ubuntu/Fedora/Debian/GenToo), FreeBSD, MacOS,
Solaris, ...
- fully documented (man pages)
- can be integrated with e-mail clients; documentation has examples for [[http://www.mutt.org/][mutt]]
and [[http://www.emacswiki.org/emacs/WanderLust][Wanderlust]].
- output in plain text, xml, json, s-expressions (experimental)
- extract message parts, attachments, open them using their default
application
In addition, there is a toy UI for *mu* called [[file:mug.org][mug]]; the plan is to slowly
evolve this into a full-featured UI.
** Development & download
Some Linux-distributions already provide pre-built mu packages; if not, or if
you want the latest release, you can [[http://code.google.com/p/mu0/downloads/list][download mu source packages]] from Google
Code. In case you find a bug, or have a feature requests, please use the
[[http://code.google.com/p/mu0/issues/list][issue tracker]].
If you'd like to work with the mu source code, you can find it [[http://gitorious.org/mu/mu-ng][in Gitorious]],
and see the notes on [[http://gitorious.org/mu/mu-ng/blobs/master/HACKING][HACKING]] the mu source code.
There's also a [[http://groups.google.com/group/mu-discuss][mailing list]].
** License & Copyright
*mu* was designed and implemented by Dirk-Jan C. Binnema, and is Free
Software, licensed under the GNU GPLv3
#+html:<hr/><div align="center">&copy; 2011 Dirk-Jan C. Binnema</div>
#+begin_html
<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>
#+end_html

24
www/mu.css Normal file
View File

@ -0,0 +1,24 @@
/* stylesheet for mu website */
body {
background:#ffffff;
margin: 50px;
padding: 10px;
font-family: arial, Helvetica, 'Bitstream Vera Sans', 'Luxi Sans', Verdana,
Sans-Serif;
font-size: 12px;
}
.content {
margin:30px;
background: #5fb6de;
}
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}

39
www/mug.org Normal file
View File

@ -0,0 +1,39 @@
#+title: Mug
#+html:<a href="index.html"><img src="mu-small.png" border="0" align="right"/></a>
#+style: <link rel="stylesheet" type="text/css" href="mu.css">
* Mug
/Mug/ is a toy/demo user-interface for =mu=. It is not installable, you'll need
to run it from its source directory.
Mug comes in two flavors:
- =mug= (in toys/mug), old simple UI, only adding dependency to GTK+
- =mug2= (in toys/mug2), the new UI, which requires GTK+, Webkit and a
recent GLib.
The plan for =mug= is to be a testing ground for the widget-code which will
slowly evolve into a full-featured UI.
#+html:<a href="mug-full.png"><img src="mug-thumb.png" border="0" align="center"/></a>
=mug2= supports:
- HTML email
- attachments (including in-place opening, drag & drop to desktop)
- bookmarks (see the =mu-bookmarks= man page, the UI will load these in the
left pane)
- view source
#+html:<hr/><div align="center">&copy; 2011 Dirk-Jan C. Binnema</div>
#+begin_html
<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>
#+end_html

64
www/old-news.org Normal file
View File

@ -0,0 +1,64 @@
#+title: Mu - Old News
#+html:<a href="index.html"><img src="mu.png" border="0" align="right"/></a>
#+style: <link rel="stylesheet" type="text/css" href="mu.css">
* Old news
- [2010-12-05] *mu version 0.9.1* released; fixes a couple of issues users
found with a missing icon, the unit-tests.
- [2010-12-04] *mu version 0.9* 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.
- [2010-11-27] *mu version 0.9-beta* released. New features: searching is now
accent-insensitive; you can now search for message priority (=prio:=),
time-interval (=date:=) and message flags (=flag:=). Also, you can now store
('bookmark') often-used queries. To top it off, there is a simple graphical
UI now, called =mug=. Documentation has been update, and all known bugs have
been fixed.
- [2010-10-30] *mu version 0.8* released, with only some small cosmetic
updates compared to 0.8-beta. Hurray!
- [2010-10-23] *mu version 0.8-beta* released. The new version brings =mu
extract= for getting the attachments from messages, improved searching
(matching is a bit more 'greedy'), updated and extended documentation,
including the =mu-easy= manpage with simple examples. All known
non-enhancement bugs were fixed.
- [2010-02-27] *mu version 0.7* released. Compared to the beta version, there
are few changes. The maildir-matching syntax now contains a starting =/=, so
=~/Maildir/foo/bar/(cur|new)/msg= can be matched with =m:/foo/bar=. The
top-level maildir can be matched with =m:/=. Apart from that, there are so
small cosmetic fixes and documentation updates.
- [2010-02-11] *mu version 0.7-beta* released. A lot of changes:
- Automatic database scheme version check, notifies users when an
upgrade is needed
- Adds the =mu view= command, to view mail message files
- Removes the 10K match limit
- Support for unattended upgrades - that is, the database can
automatically be upgraded (=--autoupgrade=). Also, the log file is
automatically cleaned when it gets too big (unless you use
=--nocleanup=)
- Search for a certain Maildir using the =maildir:=,=m:= search
prefixes. For example, you can find all messages located in
=~/Maildir/foo/bar/(cur|new)/msg= with =m:foo/bar=. This replaces the
search for path/p in 0.6
- Fixes for reported issues #17 and #18
- A test suite with a growing number of unit tests
- Updated documentation
- Many internal refactoring and other changes
This version has been
tagged as =v0.7-beta= in repository, and must be considered a code-complete
preview of the upcoming release 0.7. Please report any problems you encounter
with it.
#+html:<hr/><div align="center">&copy; 2011 Dirk-Jan C. Binnema</div>
#+begin_html
<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>
#+end_html