tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MANUAL: split long lines

Browse Source 
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
This commit is contained in:
Nicolas Sebrecht 2015-01-10 01:16:56 +01:00
parent 561a3d4329
commit 18bf7b7dc9
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/MANUAL.rst
View File

@ -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 a connection to your IMAP server open and immediately be notified (and
synchronized) when a new mail arrives (aka Push mail). 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 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 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
------ ------
Basic is designed for situations in which OfflineIMAP will be run Basic is designed for situations in which OfflineIMAP will be run non-attended
non-attended and the status of its execution will be logged. This user and the status of its execution will be logged. This user interface is not
interface is not capable of reading a password from the keyboard; capable of reading a password from the keyboard; account passwords must be
account passwords must be specified using one of the configuration file specified using one of the configuration file options. For example, it will not
options. For example, it will not print periodic sleep announcements and tends to be a tad less verbose, in general. print periodic sleep announcements and tends to be a tad less verbose, in
general.
Quiet Quiet
@ -243,7 +247,11 @@ achieve this.
Upgrading from plain text cache to SQLITE based cache 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 1) Sync to make sure things are reasonably similar
@ -335,7 +343,11 @@ core.
Folder filtering and nametrans 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 KNOWN BUGS
========== ==========