PIM
/
offlineimap
mirror of https://github.com/OfflineIMAP/offlineimap.git
1
0
Fork 0
Code Issues Releases Wiki Activity

/offlineimap/head: changeset 324 

Updated documentation and information with information about new
settings
This commit is contained in:
jgoerzen 2003-01-07 03:37:19 +01:00
parent 0c7bdb2630
commit 1cc5cfda0a
8 changed files with 1471 additions and 957 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
offlineimap/head/debian/changelog
View File

@ -13,6 +13,14 @@ offlineimap (3.99.6) unstable; urgency=low
*** NOTE *** THIS CHANGE BREAKS COMPATIBILITY WITH OLDER VERSIONS.
* New color console interface: Curses.Blinkenlights! Try it out!
Closes: #167357.
* Due to possibly having one account sleep while another is reading a
password, and other tricky situations, support for nice updating and
cancelling of a sleep in TTY.TTYUI has been removed. (Sleep will
still work; there is just no way to cancel it early.)
.
However, this is not going to be a huge problem because the new Curses
Blinkenlights interface has this support, and does it a lot better than
TTY.TTYUI ever could have.
-- John Goerzen <jgoerzen@complete.org> Thu, 2 Jan 2003 13:59:44 -0600

2
offlineimap/head/debian/control
View File

@ -2,7 +2,7 @@ Source: offlineimap
Section: mail
Priority: optional
Maintainer: John Goerzen <jgoerzen@complete.org>
Build-Depends-Indep: debhelper (>> 3.0.0), python2.2 (>= 2.2.1-4), python2.2-dev (>= 2.2.1-4)
Build-Depends-Indep: debhelper (>> 3.0.0), python2.2 (>= 2.2.1-4), python2.2-dev (>= 2.2.1-4), groff
Standards-Version: 3.5.2
Package: offlineimap

371
offlineimap/head/manual.html
View File

File diff suppressed because it is too large Load Diff

BIN
offlineimap/head/manual.pdf
View File

Binary file not shown.

1914
offlineimap/head/manual.ps
View File

File diff suppressed because it is too large Load Diff

104
offlineimap/head/manual.txt
View File

@ -97,11 +97,11 @@ INSTALLATION
OTHER SYSTEM-WIDE INSTALLATION
Download the tar.gz version of the package from the website. Then run
these commands:
these commands, making sure that you are the "root" user first:
tar -zxvf offlineimap-x.y.z.tar.gz
tar -zxvf offlineimap_x.y.z.tar.gz
cd offlineimap-x.y.z
python2.2 setup.py
python2.2 setup.py install
Some systems will need to use python instead of python2.2. Next, pro-
ceed to configuration. You will type offlineimap to invoke the pro-
@ -187,14 +187,14 @@ OPTIONS
USER INTERFACES
OfflineIMAP has a pluggable user interface system that lets you choose
how the program communicates information to you. There are two graphi-
cal interfaces, one terminal interface, and two noninteractive inter-
cal interfaces, two terminal interfaces, and two noninteractive inter-
faces suitable for scripting or logging purposes. The ui option in the
configuration file specifies the user interface preferences. The -u
command-line option can override the configuration file. The available
values for the configuration file or command-line are describef in this
section.
Tk.Blinkenlights
Tk.Blinkenlights or Curses.Blinkenlights
This is an interface designed to be sleek, fun to watch, and informa-
tive of the overall picture of what OfflineIMAP is doing. I consider
it to be the best general-purpose interface in OfflineIMAP.
@ -205,27 +205,32 @@ USER INTERFACES
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
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.
Tk.Blinkenlights is the only user interface that has configurable
parameters; see the example offlineimap.conf for more details.
Each light in the Tk.Blinkenlights interface represents a thread of
execution -- that is, a particular task that OfflineIMAP is performing
right now. The color indicates what task the particular thread is per-
forming, and are as follows:
Each light in the Tk.Blinkenlights or Curses.Blinkenlights interface
represents a thread of execution -- that is, a particular task that
OfflineIMAP is performing right now. The color indicates what task the
particular thread is performing, and are as follows:
Black indicates that this light's thread has terminated; it will light
up again later when new threads start up. So, black indicates
up again later when new threads start up. So, black indicates
no activity.
Red (Meaning 1)
is the color of the main program's thread, which basically does
is the color of the main program's thread, which basically does
nothing but monitor the others. It might remind you of HAL 9000
in 2001.
Gray indicates that the thread is establishing a new connection to
Gray indicates that the thread is establishing a new connection to
the IMAP server.
Purple is the color of an account synchronization thread that is moni-
Purple is the color of an account synchronization thread that is moni-
toring the progress of the folders in that account (not generat-
ing any I/O).
@ -245,44 +250,43 @@ USER INTERFACES
Pink (bright red) indicates that message flags are being removed.
Red / Black Flashing
corresponds to the countdown timer that runs between synchro-
corresponds to the countdown timer that runs between synchro-
nizations.
The name of this interface derives from a bit of computer science his-
The name of this interface derives from a bit of computer science his-
tory. Eric Raymond's Jargon File defines blinkenlights, in part, as:
Front-panel diagnostic lights on a computer, esp. a dinosaur.
Now that dinosaurs are rare, this term usually refers to status
Front-panel diagnostic lights on a computer, esp. a dinosaur.
Now that dinosaurs are rare, this term usually refers to status
lights on a modem, network hub, or the like.
This term derives from the last word of the famous blackletter-
This term derives from the last word of the famous blackletter-
Gothic sign in mangled pseudo-German that once graced about half
the computer rooms in the English-speaking world. One version
the computer rooms in the English-speaking world. One version
ran in its entirety as follows:
ACHTUNG! ALLES LOOKENSPEEPERS!
Das computermachine ist nicht fuer gefingerpoken und mitten-
grabben. Ist easy schnappen der springenwerk, blowenfusen und
poppencorken mit spitzensparken. Ist nicht fuer gewerken bei
Das computermachine ist nicht fuer gefingerpoken und mitten-
grabben. Ist easy schnappen der springenwerk, blowenfusen und
poppencorken mit spitzensparken. Ist nicht fuer gewerken bei
das dumpkopfen. Das rubbernecken sichtseeren keepen das cotten-
pickenen hans in das pockets muss; relaxen und watchen das
pickenen hans in das pockets muss; relaxen und watchen das
blinkenlichten.
Tk.VerboseUI
This interface (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 connec-
This interface (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 connec-
tions may wish to use Tk.Blinkenlights instead.
TTY.TTYUI
This interface is the default for people running in terminals. It
prints out basic status messages, has an interruptible timer like the
graphical interfaces do, and is generally friendly to use on a console
or xterm.
This interface is the default for people running in terminals. It
prints out basic status messages and is generally friendly to use on a
console or xterm.
Noninteractive.Basic
This interface is designed for situations where OfflineIMAP will be run
@ -563,22 +567,38 @@ NOTES
sure that the message was properly uploaded before deleting it, so
there should be no risk of data loss.
USE WITH EVOLUTION
OfflineIMAP can work with Evolution. To do so, first configure your
OfflineIMAP account to have:
sep = /
in its configuration. Then, configure Evolution with the "Maildir-for-
mat mail directories" server type. For the path, you will need to
specify the name of the top-level folder inside your OfflineIMAP stor-
age location. You're now set!
USE WITH KMAIL
At this time, I believe that OfflineIMAP is not compatible with KMail.
KMail cannot work in any mode other than to move all messages out of
all folders immediately, which (besides being annoying and fundamen-
tally broken) is incompatible with OfflineIMAP.
MAILING LIST
There is an OfflineIMAP mailing list available.
To subscribe, send the text "Subscribe" in the subject of a mail to
offlineimap-request@complete.org. To post, send the message to
To subscribe, send the text "Subscribe" in the subject of a mail to
offlineimap-request@complete.org. To post, send the message to
offlineimap@complete.org.
BUGS
Reports of bugs should be sent via e-mail to the OfflineIMAP bug-track-
ing system (BTS) at offlineimap@bugs.complete.org or submitted on-line
using the Web interface at http://bugs.complete.org/. The Web site
also lists all current bugs, where you can check their status or con-
ing system (BTS) at offlineimap@bugs.complete.org or submitted on-line
using the Web interface at http://bugs.complete.org/. The Web site
also lists all current bugs, where you can check their status or con-
tribute to fixing them.
COPYRIGHT
OfflineIMAP is Copyright (C) 2002 John Goerzen.
OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John
Goerzen.
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
@ -612,8 +632,8 @@ AUTHOR
OfflineIMAP may also be downloaded using Subversion. Additionally, the
distributed tar.gz may be updated with a simple "svn update" command;
it is ready to go. For information on getting OfflineIMAP with
Subversion, please visit:
it is ready to go. For information on getting OfflineIMAP with Subver-
sion, please visit:
http://svn.complete.org/

15
offlineimap/head/offlineimap.1
View File

@ -288,7 +288,7 @@ The pre-defined options are listed in the USER INTERFACES section.
.B OfflineIMAP
has a pluggable user interface system that lets you choose how the
program communicates information to you. There are two graphical
interfaces, one terminal interface, and two noninteractive interfaces
interfaces, two terminal interfaces, and two noninteractive interfaces
suitable for scripting or logging purposes. The
.I ui
option in the configuration file specifies the user interface
@ -297,7 +297,7 @@ preferences. The
command-line option can override the configuration file. The
available values for the configuration file or command-line are
describef in this section.
.SS Tk.Blinkenlights
.SS Tk.Blinkenlights or Curses.Blinkenlights
This is an interface designed to be sleek, fun to watch, and
informative of the overall picture of what
.B OfflineIMAP
@ -310,12 +310,18 @@ functional. There is also an optional, toggable, log that shows more
detail about what is happening and is color-coded to match the color
of the lights.
.PP
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.
.PP
Tk.Blinkenlights is the only user interface that has configurable
parameters; see the example
.I offlineimap.conf
for more details.
.PP
Each light in the Tk.Blinkenlights interface represents a thread of
Each light in the Tk.Blinkenlights or Curses.Blinkenlights
interface represents a thread of
execution -- that is, a particular task that
.B OfflineIMAP
is performing right now. The color indicates what task the particular
@ -396,8 +402,7 @@ connections, the detail may go by too quickly to be useful. People
with fast connections may wish to use Tk.Blinkenlights instead.
.SS TTY.TTYUI
This interface is the default for people running in terminals. It
prints out basic status messages, has an interruptible timer like the
graphical interfaces do, and is generally friendly to use on a console
prints out basic status messages and is generally friendly to use on a console
or xterm.
.SS Noninteractive.Basic
This interface is designed for situations where

14
offlineimap/head/offlineimap.conf
View File

@ -35,12 +35,6 @@ metadata = ~/.offlineimap
accounts = Test
# You can have offlineimap continue running indefinately, automatically
# syncing your mail periodically. If you want that, specify how
# frequently to do that (in minutes) here.
# autorefresh = 5
# Offlineimap can synchronize more the one account at a time. If you
# want to enable this feature, set the below value to something
# greater than 1. To force it to synchronize only one account at a
@ -56,6 +50,8 @@ maxsyncaccounts = 1
# The pre-defined options are:
# Tk.Blinkenlights -- A graphical interface, shows LEDs and a single log
# Tk.VerboseUI -- A graphical interface, shows logs per thread
# Curses.Blinkenlights -- A text-based (terminal) interface similar to
# Tk.Blinkenlights
# TTY.TTYUI -- a text-based (terminal) interface
# Noninteractive.Basic -- Noninteractive interface suitable for cronning
# Noninteractive.Quiet -- Noninteractive interface, generates no output
@ -199,6 +195,12 @@ remoteuser = username
########## Advanced settings
# You can have offlineimap continue running indefinately, automatically
# syncing your mail periodically. If you want that, specify how
# frequently to do that (in minutes) here.
# autorefresh = 5
# Some IMAP servers need a "reference" which often refers to the
# "folder root". This is most commonly needed with UW IMAP, where