add some more info to the initial tagging page

[notmuch-wiki] / howto.mdwn

diff --git a/howto.mdwn b/howto.mdwn
index 30e81348c68c8c35f910953ecfee2f0edc6bdb7b..c62409fc9b35a2b243717202afacfd059f0afc0f 100644 (file)
--- a/howto.mdwn
+++ b/howto.mdwn
@@ -1,13 +1,44 @@
 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
 #How to...
 
-##<span id="print_filenames">.. print only filenames of a search</span>
+Some tips about how to do some useful things with notmuch, and the
+various "third party" notmuch utilities.
 
-Given you have the python bindings installed (or simply set your PYTHONPATH environment variable to point to the .../bindings/python directory), this script will print the filenames of a matching search:
+* <span id="print_filenames">Print only filenames of a search</span>
+
+  Given you have the python bindings installed (or simply set your
+  PYTHONPATH environment variable to point to the .../bindings/python
+  directory), this script will print the filenames of a matching
+  search:
+
+                             #!/usr/bin/env python
+                             import sys
+                             import notmuch
+                             search = " ".join(sys.argv[1:])
+                             q = notmuch.Database().create_query(search)
+                             for m in q.search_messages():
+                                 print m.get_filename()
+
+* <span id="sync_maildir_flags">Sync notmuch tags and maildir flags</span>
+
+  Some IMAP users rely on maildir flags that convey the status "seen",
+  "replied", "trashed", in order to synchronize the status of their
+  mail across mail clients (a [maildir
+  flag](http://cr.yp.to/proto/maildir.html) is simply a defined part
+  of their filename).  Notmuch will by default happily ignore those
+  flags and will never modify them either, as there is no built-in
+  support for sunchronizing your notmuch tags with your imap maildir
+  flags (seen, replied, trashed, etc). However there are currently 2
+  ways in which you can achieve synchronization.
+
+  [notmuchsync](http://spaetz.github.com/notmuchsync/) is a utility
+  that allows synchronization in either direction, as well as pruning
+  of deleted files.
+
+  The second solution allows for fast maildir flag to notmuch tag
+  synchronization (and only in that direction) requires patching the
+  notmuch source code. The patch has been posted in this mail
+  *id:1267450136-31749-1-git-send-email-Sebastian@SSpaeth.de* and can
+  be viewed as a [source diff in this git
+  repository](http://github.com/spaetz/notmuch-all-feature/commit/df3b087cefb85e9d16fd17540e348bcb854dd7ee).
 
-                                #!/usr/bin/env python
-                                import sys
-                                import notmuch
-                                
-                                q = notmuch.Database().create_query(" ".join(sys.argv[1:]))
-                                for m in q.search_messages(): print m.get_filename()