[PATCH] Document a feature in the FAQ

Daniel Shahaf d.s at daniel.shahaf.name
Sun Apr 3 03:49:20 BST 2011


Add a FAQ entry for the Blinkenlight UI's 'Force an immediate resync' feature.

Signed-off-by: Daniel Shahaf <d.s at daniel.shahaf.name>
---

I discovered the feature by accident, and didn't find it documented
anywhere.  I didn't mention the plans for SIGUSR1 "resync all accounts"
(from README) in the FAQ.

Also, in SubmittingPatches.rst, there are some places that use tabs for
vertical alignment (such as section (d) of the Certificate of Origin)
--- they should probably be using spaces.

 docs/FAQ.rst |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

diff --git a/docs/FAQ.rst b/docs/FAQ.rst
index 9b66e29..fcc55b3 100644
--- a/docs/FAQ.rst
+++ b/docs/FAQ.rst
@@ -205,6 +205,20 @@ How is OfflineIMAP conformance?
 * Maildir as specified in the Maildir manpage and the qmail website
 * Standard Python 2.6 as implemented on POSIX-compliant systems
 
+Can I force OfflineIMAP to sync a folder right now?
+---------------------------------------------------
+
+Yes, if you use the `Blinkenlights` UI.  That UI shows the active accounts
+as follows::
+
+  4: [active]      *Control: .
+  3: [  4:36]      personal:
+  2: [  3:37]          work: .
+  1: [  6:28]           uni:
+
+Simply press the appropriate digit (`3` for `personal`, etc.) to resync that
+account immediately.  This will be ignored if a resync is already in progress
+for that account.
 
 Configuration Questions
 =======================
-- 
1.7.2.5





More information about the OfflineIMAP-project mailing list