'\" t .\" Title: offlineimapui .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 02/25/2021 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" .TH "OFFLINEIMAPUI" "7" "02/25/2021" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" offlineimapui \- The User Interfaces .SH "DESCRIPTION" .sp OfflineIMAP comes with different UIs, each aiming its own purpose\&. .SH "TTYUI" .sp TTYUI interface is for people running in terminals\&. It prints out basic status messages and is generally friendly to use on a console or xterm\&. .SH "BASIC" .sp Basic is designed for situations in which OfflineIMAP will be run non\-attended and the status of its execution will be logged\&. .sp 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\&. .SH "BLINKENLIGHTS" .sp Blinkenlights is an interface designed to be sleek, fun to watch, and informative of the overall picture of what OfflineIMAP is doing\&. .sp 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\&. .sp Each light in the Blinkenlights interface represents a thread of execution \(em that is, a particular task that OfflineIMAP is performing right now\&. The colors indicate what task the particular thread is performing, and are as follows: .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Black .sp .if n \{\ .RS 4 .\} .nf indicates that this light\*(Aqs thread has terminated; it will light up again later when new threads start up\&. So, black indicates no activity\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Red (Meaning 1) .sp .if n \{\ .RS 4 .\} .nf is the color of the main program\*(Aqs thread, which basically does nothing but monitor the others\&. It might remind you of HAL 9000 in 2001\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Gray .sp .if n \{\ .RS 4 .\} .nf indicates that the thread is establishing a new connection to the IMAP server\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Purple .sp .if n \{\ .RS 4 .\} .nf is the color of an account synchronization thread that is monitoring the progress of the folders in that account (not generating any I/O)\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Cyan .sp .if n \{\ .RS 4 .\} .nf indicates that the thread is syncing a folder\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Green .sp .if n \{\ .RS 4 .\} .nf means that a folder\*(Aqs message list is being loaded\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Blue .sp .if n \{\ .RS 4 .\} .nf is the color of a message synchronization controller thread\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Orange .sp .if n \{\ .RS 4 .\} .nf indicates that an actual message is being copied\&. (We use fuchsia for fake messages\&.) .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Red (meaning 2) .sp .if n \{\ .RS 4 .\} .nf indicates that a message is being deleted\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Yellow / bright orange .sp .if n \{\ .RS 4 .\} .nf indicates that message flags are being added\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Pink / bright red .sp .if n \{\ .RS 4 .\} .nf indicates that message flags are being removed\&. .fi .if n \{\ .RE .\} .RE .sp .RS 4 .ie n \{\ \h'-04'\(bu\h'+03'\c .\} .el \{\ .sp -1 .IP \(bu 2.3 .\} Red / Black Flashing .sp .if n \{\ .RS 4 .\} .nf corresponds to the countdown timer that runs between synchronizations\&. .fi .if n \{\ .RE .\} .RE .sp The name of this interfaces derives from a bit of computer history\&. Eric Raymond\(cqs Jargon File defines blinkenlights, in part, as: .sp .if n \{\ .RS 4 .\} .nf 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\&. .fi .if n \{\ .RE .\} .sp 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 ran in its entirety as follows: .sp .if n \{\ .RS 4 .\} .nf ACHTUNG! ALLES LOOKENSPEEPERS! .fi .if n \{\ .RE .\} .sp .if n \{\ .RS 4 .\} .nf Das computermachine ist nicht fuer gefingerpoken und mittengrabben\&. 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 blinkenlichten\&. .fi .if n \{\ .RE .\} .SH "QUIET" .sp It will output nothing except errors and serious warnings\&. Like Basic, 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\&. .SH "SYSLOG" .sp Syslog is designed for situations where OfflineIMAP is run as a daemon (e\&.g\&., as a systemd \-\-user service), but errors should be forwarded to the system log\&. Like Basic, 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\&. .SH "MACHINEUI" .sp MachineUI generates output in a machine\-parsable format\&. It is designed for other programs that will interface to OfflineIMAP\&. .SH "SEE ALSO" .sp .if n \{\ .RS 4 .\} .nf offlineimap(1) .fi .if n \{\ .RE .\}