From d6a58cdbf3f0e37b49383a1800ecf6cecfddff70 Mon Sep 17 00:00:00 2001 From: jgoerzen Date: Wed, 8 Jan 2003 04:04:35 +0100 Subject: [PATCH] /offlineimap/head: changeset 336 --- offlineimap/head/offlineimap.sgml | 132 ++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) diff --git a/offlineimap/head/offlineimap.sgml b/offlineimap/head/offlineimap.sgml index b6494c0..518bf73 100644 --- a/offlineimap/head/offlineimap.sgml +++ b/offlineimap/head/offlineimap.sgml @@ -152,6 +152,138 @@ remoteuser = jgoerzen + + + Installation + + If you are reading this document via the "man" command, it is + likely + that you have no installation tasks to perform; your system + administrator has already installed it. If you need to install it + yourself, you have three options: a system-wide installation with + Debian, system-wide installation with other systems, and a single-user + installation. You can download the latest version of &OfflineIMAP; from + the &OfflineIMAP; + website. + + + + Prerequisites + + In order to use &OfflineIMAP;, you need to have these conditions + satisfied: + + + + + Your mail server must support IMAP. Most Internet Service + Providers + and corporate networks do, and most operating systems + have an IMAP + implementation readily available. + + + + + You must have Python version 2.2.1 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 + Python must have been built with SSL support. + + + + + Have a mail reader that supports the Maildir mailbox format. Most + modern mail readers have this support built-in, so you can choose from + a wide variety of mail servers. This format is also known as the + "qmail" format, so any mail reader compatible with it will work with + &OfflineIMAP;. + + + + + System-Wide Installation, Debian + + If you are tracking Debian unstable, you may install + &OfflineIMAP; by simply running the following command as root: + + + apt-get install offlineimap + + + If you are not tracking Debian unstable, download the Debian .deb + package from the &OfflineIMAP; website + and then run dpkg -i to install the downloaded + package. Then, skip to below. You will type offlineimap to + invoke the program. + + + + + System-Wide Installation, Other + + Download the tar.gz version of the package from the + website. + Then run + these commands, making sure that you are the "root" user first: + + + tar -zxvf offlineimap_x.y.z.tar.gz +cd offlineimap-x.y.z +python2.2 setup.py install + On some systems, you will need to use + python instead of python2.2. + Next, proceed to below. You will type offlineimap to + invoke the program. + + + + + Single-Account Installation + + Download the tar.gz version of the package from the + website. + Then run these commands: + + + tar -zxvf offlineimap_x.y.z.tar.gz +cd offlineimap-x.y.z + + When you want to run &OfflineIMAP;, you will issue the + cd command as above and then type + ./offlineimap.py; there is no installation + step necessary. + + + + + + Configruation + + &OfflineIMAP; is regulated by a configuration file that is normally + stored in ~/.offlineimaprc. &OfflineIMAP; + ships with a file named offlineimap.conf + that you should copy to that location and then edit. This file is + vital to proper operation of the system; it sets everything you need + to run &OfflineIMAP;. Full documentation for the configuration file + is included within the sample file. + + + &OfflineIMAP; also ships a file named + offlineimap.conf.minimal that you can also try. + It's useful if you want to get started with + the most basic feature set, and you can read about other features + later with offlineimap.conf. + + + + + See Also This is also a test. Foo bar.