/offlineimap/head: changeset 336
This commit is contained in:
jgoerzen
parent
fbb0a21ccf
commit
d6a58cdbf3
@ -152,6 +152,138 @@ remoteuser = jgoerzen
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Installation</title>
|
||||
|
||||
<para>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
|
||||
<ulink url="http://quux.org/devel/offlineimap/">the &OfflineIMAP;
|
||||
website</ulink>.
|
||||
</para>
|
||||
|
||||
<refsect2>
|
||||
<title>Prerequisites</title>
|
||||
|
||||
<para>In order to use &OfflineIMAP;, you need to have these conditions
|
||||
satisfied:
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Your mail server must support IMAP. Most Internet Service
|
||||
Providers
|
||||
and corporate networks do, and most operating systems
|
||||
have an IMAP
|
||||
implementation readily available.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
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
|
||||
<ulink url="http://www.python.org/">the Python website</ulink>.
|
||||
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.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
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;.
|
||||
</itemizedlist>
|
||||
</refsect2>
|
||||
|
||||
<refsect2>
|
||||
<title>System-Wide Installation, Debian</title>
|
||||
<para>
|
||||
If you are tracking Debian unstable, you may install
|
||||
&OfflineIMAP; by simply running the following command as root:
|
||||
</para>
|
||||
<para>
|
||||
<command>apt-get install offlineimap</command>
|
||||
</para>
|
||||
<para>
|
||||
If you are not tracking Debian unstable, download the Debian .deb
|
||||
package from the <ulink url="http://quux.org/devel/offlineimap/">&OfflineIMAP; website</ulink>
|
||||
and then run <command>dpkg -i</command> to install the downloaded
|
||||
package. Then, skip to <xref linkend="configuration" endterm="configuration-title"> below. You will type <command>offlineimap</command> to
|
||||
invoke the program.
|
||||
</para>
|
||||
</refsect2>
|
||||
|
||||
<refsect2>
|
||||
<title>System-Wide Installation, Other</title>
|
||||
<para>
|
||||
Download the tar.gz version of the package from the
|
||||
<ulink url="http://quux.org/devel/offlineimap/">website</ulink>.
|
||||
Then run
|
||||
these commands, making sure that you are the "root" user first:
|
||||
</para>
|
||||
|
||||
<ProgramListing>tar -zxvf offlineimap_x.y.z.tar.gz
|
||||
cd offlineimap-x.y.z
|
||||
python2.2 setup.py install</ProgramListing>
|
||||
<para>On some systems, you will need to use
|
||||
<command>python</command> instead of <command>python2.2</command>.
|
||||
Next, proceed to <xref linkend="configuration" endterm="configuration-title"> below. You will type <command>offlineimap</command> to
|
||||
invoke the program.
|
||||
</para>
|
||||
</refsect2>
|
||||
|
||||
<refsect2>
|
||||
<title>Single-Account Installation</title>
|
||||
<para>
|
||||
Download the tar.gz version of the package from the
|
||||
<ulink url="http://quux.org/devel/offlineimap/">website</ulink>.
|
||||
Then run these commands:
|
||||
</para>
|
||||
|
||||
<ProgramListing>tar -zxvf offlineimap_x.y.z.tar.gz
|
||||
cd offlineimap-x.y.z</ProgramListing>
|
||||
|
||||
<para>When you want to run &OfflineIMAP;, you will issue the
|
||||
<command>cd</command> command as above and then type
|
||||
<command>./offlineimap.py</command>; there is no installation
|
||||
step necessary.
|
||||
</para>
|
||||
</refsect2>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id="configuration">
|
||||
<title id="configuration-title">Configruation</title>
|
||||
<para>
|
||||
&OfflineIMAP; is regulated by a configuration file that is normally
|
||||
stored in <filename>~/.offlineimaprc</filename>. &OfflineIMAP;
|
||||
ships with a file named <filename>offlineimap.conf</filename>
|
||||
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.
|
||||
</para>
|
||||
<para>
|
||||
&OfflineIMAP; also ships a file named
|
||||
<filename>offlineimap.conf.minimal</filename> 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 <filename>offlineimap.conf</filename>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>This is also a test. Foo bar.</para>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user