offlineimapui(7)

1OFFLINEIMAPUI(7)                                              OFFLINEIMAPUI(7)
2
3
4

NAME

6       offlineimapui - The User Interfaces
7

DESCRIPTION

9       OfflineIMAP comes with different UIs, each aiming its own purpose.
10

TTYUI

12       TTYUI interface is for people running in terminals. It prints out basic
13       status messages and is generally friendly to use on a console or xterm.
14

BASIC

16       Basic is designed for situations in which OfflineIMAP will be run
17       non-attended and the status of its execution will be logged.
18
19       This user interface is not capable of reading a password from the
20       keyboard; account passwords must be specified using one of the
21       configuration file options. For example, it will not print periodic
22       sleep announcements and tends to be a tad less verbose, in general.
23

BLINKENLIGHTS

25       Blinkenlights is an interface designed to be sleek, fun to watch, and
26       informative of the overall picture of what OfflineIMAP is doing.
27
28       Blinkenlights contains a row of "LEDs" with command buttons and a log.
29       The log shows more detail about what is happening and is color-coded to
30       match the color of the lights.
31
32       Each light in the Blinkenlights interface represents a thread of
33       execution — that is, a particular task that OfflineIMAP is performing
34       right now. The colors indicate what task the particular thread is
35       performing, and are as follows:
36
37       •   Black
38
39               indicates that this light's thread has terminated; it will light up again
40               later when new threads start up.  So, black indicates no activity.
41
42       •   Red (Meaning 1)
43
44               is the color of the main program's thread, which basically does nothing but
45               monitor the others.  It might remind you of HAL 9000 in 2001.
46
47       •   Gray
48
49               indicates that the thread is establishing a new connection to the IMAP
50               server.
51
52       •   Purple
53
54               is the color of an account synchronization thread that is monitoring the
55               progress of the folders in that account (not generating any I/O).
56
57       •   Cyan
58
59               indicates that the thread is syncing a folder.
60
61       •   Green
62
63               means that a folder's message list is being loaded.
64
65       •   Blue
66
67               is the color of a message synchronization controller thread.
68
69       •   Orange
70
71               indicates that an actual message is being copied.  (We use fuchsia for fake
72               messages.)
73
74       •   Red (meaning 2)
75
76               indicates that a message is being deleted.
77
78       •   Yellow / bright orange
79
80               indicates that message flags are being added.
81
82       •   Pink / bright red
83
84               indicates that message flags are being removed.
85
86       •   Red / Black Flashing
87
88               corresponds to the countdown timer that runs between synchronizations.
89
90       The name of this interfaces derives from a bit of computer history.
91       Eric Raymond’s Jargon File defines blinkenlights, in part, as:
92
93           Front-panel diagnostic lights on a computer, esp. a dinosaur. Now that
94           dinosaurs are rare, this term usually refers to status lights on a modem,
95           network hub, or the like.
96
97       This term derives from the last word of the famous blackletter-Gothic
98       sign in mangled pseudo-German that once graced about half the computer
99       rooms in the English-speaking world. One version ran in its entirety as
100       follows:
101
102           ACHTUNG!  ALLES LOOKENSPEEPERS!
103
104           Das computermachine ist nicht fuer gefingerpoken und mittengrabben.
105           Ist easy schnappen der springenwerk, blowenfusen und poppencorken
106           mit spitzensparken.  Ist nicht fuer gewerken bei das dumpkopfen.
107           Das rubbernecken sichtseeren keepen das cotten-pickenen hans in das
108           pockets muss; relaxen und watchen das blinkenlichten.
109

QUIET

111       It will output nothing except errors and serious warnings. Like Basic,
112       this user interface is not capable of reading a password from the
113       keyboard; account passwords must be specified using one of the
114       configuration file options.
115

SYSLOG

117       Syslog is designed for situations where OfflineIMAP is run as a daemon
118       (e.g., as a systemd --user service), but errors should be forwarded to
119       the system log. Like Basic, this user interface is not capable of
120       reading a password from the keyboard; account passwords must be
121       specified using one of the configuration file options.
122

MACHINEUI

124       MachineUI generates output in a machine-parsable format. It is designed
125       for other programs that will interface to OfflineIMAP.
126