X-Git-Url: https://code.delx.au/offlineimap/blobdiff_plain/71c8b2e7c489b6277dd862e9174784ca237ebead..c046383dc2499b2af2887a4f436c3eda4c544444:/offlineimap.sgml
diff --git a/offlineimap.sgml b/offlineimap.sgml
index 0bd0ce3..83f4ac0 100644
--- a/offlineimap.sgml
+++ b/offlineimap.sgml
@@ -32,6 +32,8 @@
-a accountlist
-c configfile
-d debugtype[,...]
+ -f foldername[,...]
+ -k [section:]option=value
-l filename
-o
-u interface
@@ -204,18 +206,19 @@ remoteuser = jgoerzen
and corporate networks do, and most operating systems
have an IMAP
implementation readily available.
+ A special Gmail mailbox type is
+ available to interface with Gmail's IMAP front-end.
- You must have Python version 2.2.1 or above installed.
+ You must have Python version 2.4 or above installed.
If you are
running on Debian GNU/Linux, this requirement will automatically be
taken care of for you. If you do not have Python already, check with
your system administrator or operating system vendor; or, download it from
the Python website.
- If you intend to use the Tk interface, you must have Tkinter
- (python-tk) installed. If you intend to use the SSL interface, your
+ If you intend to use the SSL interface, your
Python must have been built with SSL support.
@@ -231,6 +234,7 @@ remoteuser = jgoerzen
IMAP server and point both &OfflineIMAP; and your mail
reader at it.
+
@@ -373,6 +377,26 @@ cd offlineimap-x.y.z
will debug the threading model.
+ -f foldername[,foldername]
+ Only sync the specified folders. The
+ foldernames are the
+ untranslated foldernames. This command-line option
+ overrides any folderfilter
+ and folderincludes options in the
+ configuration file.
+
+
+ -k [section:]option=value
+
+ Override configuration file option. If
+ "section" is omitted, it defaults
+ to general. Any underscores "_" in
+ the section name are replaced with spaces: for instance,
+ to override option autorefresh in
+ the "[Account Personal]" section in the config file one
+ would use "-k Account_Personal:autorefresh=30".
+
+
-l
filename
@@ -389,6 +413,11 @@ cd offlineimap-x.y.z
file.
+ -q
+ Run only quick synchronizations. Ignore any flag
+ updates on IMAP servers.
+
+
-h --help
Show summary of options.
@@ -412,27 +441,22 @@ cd offlineimap-x.y.z
option can override the configuration file setting. The available
values for the configuration file or command-line are described
in this section.
+
- Tk.Blinkenlights
- Tk.Blinkenlights is an interface designed to be sleek, fun to watch, and
+ Curses.Blinkenlights
+
+ Curses.Blinkenlights is an interface designed to be sleek, fun to watch, and
informative of the overall picture of what &OfflineIMAP;
is doing. I consider it to be the best general-purpose interface in
&OfflineIMAP;.
- Tk.Blinkenlights contains, by default, a small window with a row of
- LEDs, a small log, and a row of command buttons.
- The total size of the window is
- very small, so it uses little desktop space, yet it is quite
- functional. The optional, toggleable, log shows more
+ Curses.Blinkenlights contains a row of
+ "LEDs" with command buttons and a log.
+ The log shows more
detail about what is happening and is color-coded to match the color
of the lights.
-
- Tk.Blinkenlights is the only user interface that has configurable
- parameters; see the example offlineimap.conf
- for more details.
-
Each light in the Blinkenlights interface represents a thread
of execution -- that is, a particular task that &OfflineIMAP;
@@ -538,32 +562,6 @@ cd offlineimap-x.y.z
-
- Curses.Blinkenlights
-
- Curses.Blinkenlights is an interface very similar to Tk.Blinkenlights,
- but is designed to be run in a console window (an xterm, Linux virtual
- terminal, etc.) Since it doesn't have access to graphics, it isn't
- quite as pretty, but it still gets the job done.
-
- Please see the Tk.Blinkenlights section above for more
- information about the colors used in this interface.
-
-
-
-
- Tk.VerboseUI
-
- Tk.VerboseUI (formerly known as Tk.TkUI) is a graphical interface
- that presents a variable-sized window. In the window, each
- currently-executing thread has a section where its name and current
- status are displayed. This interface is best suited to people running
- on slower connections, as you get a lot of detail, but for fast
- connections, the detail may go by too quickly to be useful. People
- with fast connections may wish to use Tk.Blinkenlights instead.
-
-
-
TTY.TTYUI
@@ -598,6 +596,15 @@ cd offlineimap-x.y.z
+
+ Machine.MachineUI
+
+ Machine.MachineUI generates output in a machine-parsable format.
+ It is designed for other programs that will interface
+ to OfflineIMAP.
+
+
+
@@ -694,7 +701,7 @@ holdconnectionopen = no
is based on one supplied by Tommi Virtanen for this feature.
- In ~/.offlineimap.rc, he adds these options:
+ In ~/.offlineimaprc, he adds these options:
[general]
pythonfile=~/.offlineimap.py
@@ -731,6 +738,24 @@ def test_mycmp():
+
+
+ Signals
+
+ OfflineIMAP writes its current PID into
+ ~/.offlineimap/pid when it is
+ running. It is not guaranteed that this file will
+ not exist when OfflineIMAP is not running.
+
+
+
Errors
@@ -766,11 +791,11 @@ def test_mycmp():
rm -r ~/Folders/INBOX
-rm -r ~/.offlineimap/Account-AccountName
-rm -r ~/.offlineimap/Repository-RepositoryName
+rm -r ~/.offlineimap/Account-AccountName/LocalStatus/INBOX
+rm -r ~/.offlineimap/Repository-RemoteRepositoryName/FolderValidity/INBOX
- (Of course, replace AccountName and RepositoryName
+ (Of course, replace AccountName and RemoteRepositoryName
with the names as specified
in ~/.offlineimaprc).
@@ -836,8 +861,8 @@ rm -r ~/.offlineimap/Repository-RepositoryName
&OfflineIMAP; is not designed to have several instances (for instance, a cron job and an interactive invocation) run over the same
mailbox simultaneously. It will perform a check on startup and
abort if another &OfflineIMAP; is already running. If you need
- to schedule synchronizations, please use the
- autorefresh settings rather than cron.
+ to schedule synchronizations, you'll probably find
+ autorefresh settings more convenient than cron.
Alternatively, you can set a separate metadata
directory for each instance.