From: Carl Worth <cworth@cworth.org>
Date: Thu, 11 Nov 2010 12:06:23 +0000 (-0800)
Subject: notmuch config: Add more documentation for maildir.synchronize_flags
X-Git-Tag: 0.5~24
X-Git-Url: https://git.cworth.org/git?a=commitdiff_plain;h=937ecd5057659474aa3f7ffe9d2a5d850a641567;hp=ebe733632dbd048dae7cabb3b40e9f4d8326a8c9;p=obsolete%2Fnotmuch-old

notmuch config: Add more documentation for maildir.synchronize_flags

Including details on which actual flags are synchronized with which tags.
---

diff --git a/notmuch-config.c b/notmuch-config.c
index 9ad56467..bace8e56 100644
--- a/notmuch-config.c
+++ b/notmuch-config.c
@@ -64,10 +64,24 @@ static const char user_config_comment[] =
 static const char maildir_config_comment[] =
     " Maildir compatibility configuration\n"
     "\n"
-    " Here you can configure whether notmuch will synchronize its tags with\n"
-    " maildir flags."
+    " The following option is supported here:\n"
     "\n"
-    "\tsynchronize_flags      Valid values are true and false.\n";
+    "\tsynchronize_flags      Valid values are true and false.\n"
+    "\n"
+    "\tIf true, then the following maildir flags (in message filenames)\n"
+    "\twill be syncrhonized with the corresponding notmuch tags:\n"
+    "\n"
+    "\t\tFlag	Tag\n"
+    "\t\t----	-------\n"
+    "\t\tD	draft\n"
+    "\t\tF	flagged\n"
+    "\t\tP	passed\n"
+    "\t\tR	replied\n"
+    "\t\tS	unread (added when 'S' tag is not present)\n"
+    "\n"
+    "\tThe \"notmuch new\" command will notice flag changes in filenames\n"
+    "\tand update tags, while the \"notmuch tag\" and \"notmuch restore\"\n"
+    "\tcommands will notice tag changes and update flags in filenames\n";
 
 struct _notmuch_config {
     char *filename;