From 18bf7b7dc9eac64f97276c6d02a5862fcde60501 Mon Sep 17 00:00:00 2001 From: Nicolas Sebrecht Date: Sat, 10 Jan 2015 01:16:56 +0100 Subject: [PATCH] MANUAL: split long lines Signed-off-by: Nicolas Sebrecht --- docs/MANUAL.rst | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/MANUAL.rst b/docs/MANUAL.rst index 8d87deb..e5fa9af 100644 --- a/docs/MANUAL.rst +++ b/docs/MANUAL.rst @@ -36,9 +36,12 @@ password. Finally, you can use IMAPs IDLE infrastructure to always keep a connection to your IMAP server open and immediately be notified (and synchronized) when a new mail arrives (aka Push mail). -Most configuration is done via the configuration file. However, any setting can also be overriden by command line options handed to OfflineIMAP. +Most configuration is done via the configuration file. However, any setting can +also be overriden by command line options handed to OfflineIMAP. -OfflineImap is well suited to be frequently invoked by cron jobs, or can run in daemon mode to periodically check your email (however, it will exit in some error situations). +OfflineImap is well suited to be frequently invoked by cron jobs, or can run in +daemon mode to periodically check your email (however, it will exit in some +error situations). The documentation is included in the git repository and can be created by issueing `make doc` in the `doc` folder (python-sphinx required), or it can @@ -171,11 +174,12 @@ status messages and is generally friendly to use on a console or xterm. Basic ------ -Basic is designed for situations in which OfflineIMAP will be run -non-attended and the status of its execution will be logged. This user -interface is not capable of reading a password from the keyboard; -account passwords must be specified using one of the configuration file -options. For example, it will not print periodic sleep announcements and tends to be a tad less verbose, in general. +Basic is designed for situations in which OfflineIMAP will be run non-attended +and the status of its execution will be logged. This user interface is not +capable of reading a password from the keyboard; account passwords must be +specified using one of the configuration file options. For example, it will not +print periodic sleep announcements and tends to be a tad less verbose, in +general. Quiet @@ -243,7 +247,11 @@ achieve this. Upgrading from plain text cache to SQLITE based cache ===================================================== -OfflineImap uses a cache to store the last know status of mails (flags etc). Historically that has meant plain text files, but recently we introduced sqlite-based cache, which helps with performance and CPU usage on large folders. Here is how to upgrade existing plain text cache installations to sqlite based one: +OfflineImap uses a cache to store the last know status of mails (flags etc). +Historically that has meant plain text files, but recently we introduced +sqlite-based cache, which helps with performance and CPU usage on large folders. +Here is how to upgrade existing plain text cache installations to sqlite based +one: 1) Sync to make sure things are reasonably similar @@ -335,7 +343,11 @@ core. Folder filtering and nametrans ============================== -OfflineImap offers flexible (and complex) ways of filtering and transforming folder names. Please see the docs/doc-src/nametrans.rst document about details how to use folder filters and name transformations. The documentation will be autogenerated by a "make doc" in the docs directory. It is also viewable at :ref:`folder_filtering_and_name_translation`. +OfflineImap offers flexible (and complex) ways of filtering and transforming +folder names. Please see the docs/doc-src/nametrans.rst document about details +how to use folder filters and name transformations. The documentation will be +autogenerated by a "make doc" in the docs directory. It is also viewable at +:ref:`folder_filtering_and_name_translation`. KNOWN BUGS ==========