offlineimap rev 509

You are receiving this message because
all commits get sent to this address.

Author: jgoerzen
Date: 2003-07-18 13:49:13 -0500 (Fri, 18 Jul 2003)
New Revision: 509

Modified:
  offlineimap/head/UPGRADING
  offlineimap/head/debian/changelog
  offlineimap/head/offlineimap.1
  offlineimap/head/offlineimap.sgml

Log:
Added a section on upgrading to the documentation



Diff:
Added: offlineimap/head/UPGRADING
==============================================================================
--- offlineimap/head/UPGRADING	2003-07-17 22:12:41 UTC (rev 508)
+++ offlineimap/head/UPGRADING	2003-07-18 18:49:13 UTC (rev 509)
@@ -0,0 +1,9 @@
+NOTE:
+
+The configuration file has changed in incompatile ways with 4.0.  If you are
+upgrading from a previous version, please read the UPGRADING section in the 
+manual before invoking OfflineIMAP.
+
+-- John
+
+

Modified: offlineimap/head/debian/changelog
==============================================================================
--- offlineimap/head/debian/changelog	2003-07-17 22:12:41 UTC (rev 508)
+++ offlineimap/head/debian/changelog	2003-07-18 18:49:13 UTC (rev 509)
@@ -1,3 +1,10 @@
+offlineimap (4.0.0) unstable; urgency=low
+
+  * Poof, this is 4.0.
+  * Added UPGRADING file and UPGRADING instructions.
+
+ -- John Goerzen <[email protected]>  Fri, 18 Jul 2003 17:31:14 -0500
+
 offlineimap (3.99.20) unstable; urgency=low
 
   * OfflineIMAP now moves messages between new and cur in Maildir when flags

Modified: offlineimap/head/offlineimap.1
==============================================================================
--- offlineimap/head/offlineimap.1	2003-07-17 22:12:41 UTC (rev 508)
+++ offlineimap/head/offlineimap.1	2003-07-18 18:49:13 UTC (rev 509)
@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <[email protected]>.
-.TH "OFFLINEIMAP" "1" "02 June 2003" "John Goerzen" "OfflineIMAP Manual"
+.TH "OFFLINEIMAP" "1" "18 July 2003" "John Goerzen" "OfflineIMAP Manual"
 
 .SH NAME
 OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support
@@ -77,7 +77,9 @@
 of choice at it.  This is often preferable to the mail
 reader's own IMAP support since \fBOfflineIMAP\fR supports many
 features (offline reading, for one) that most IMAP-aware
-readers don't.
+readers don't.  However, this feature is not as time-tested
+as traditional syncing, so my advice is to stick with normal
+methods of operation for the time being.
 .SH "QUICK START"
 .PP
 If you have already installed \fBOfflineIMAP\fR system-wide,
@@ -644,6 +646,11 @@
 crutch.  You'll get the best results if you don't use this setting, in
 fact.
 .TP
+\fBI've upgraded and now OfflineIMAP crashes when I start it up!  Why?\fR
+You need to upgrade your configuration
+file.  See [XRef to UPGRADING.4.0] at the end of this
+manual.
+.TP
 \fBHow do I specify the names of my folders?\fR
 You do not need to.  \fBOfflineIMAP\fR is smart
 enough to automatically figure out what folders are present
@@ -746,7 +753,7 @@
 .TP 0.2i
 \(bu
 Internet Message Access Protocol version 4rev1 (IMAP 4rev1) as
-specified in RFC2060
+specified in RFC2060 and RFC3501
 .TP 0.2i
 \(bu
 CRAM-MD5 as specified in RFC2195
@@ -832,6 +839,34 @@
 .PP
 The Web site also lists all current bugs, where you can check their
 status or contribute to fixing them.
+.SH "UPGRADING TO 4.0"
+.PP
+If you are upgrading from a version of \fBOfflineIMAP\fR prior to
+3.99.12, you will find that you will get errors when
+\fBOfflineIMAP\fR starts up (relating to ConfigParser or
+AccountHashGenerator) and the
+configuration file.  This is because the config file format
+had to change to accomodate new features in 4.0.  Fortunately,
+it's not difficult to adjust it to suit.
+.PP
+First thing you need to do is stop any running \fBOfflineIMAP\fR
+instance, making sure first that it's synced all your mail.
+Then, modify your
+\fI~/.offlineimaprc\fR file.  You'll need to
+split up each account section (make sure that it now starts
+with "Account ") into two Repository sections (one for the
+local side and another for the remote side.)  See the files
+\fIofflineimap.conf.minimal\fR and
+\fIofflineimap.conf\fR in the distribution if
+you need more assistance.
+.PP
+\fBOfflineIMAP\fR's status directory area has also changed.
+Therefore, you should delete everything in ~/.offlineimap as
+well as your local mail folders.
+.PP
+When you start up \fBOfflineIMAP\fR 4.0, it will re-download all
+your mail from the server and then you can continue using it
+like normal.
 .SH "COPYRIGHT"
 .PP
 OfflineIMAP, and this manual, are Copyright (C) 2002, 2003 John Goerzen.

Modified: offlineimap/head/offlineimap.sgml
==============================================================================
--- offlineimap/head/offlineimap.sgml	2003-07-17 22:12:41 UTC (rev 508)
+++ offlineimap/head/offlineimap.sgml	2003-07-18 18:49:13 UTC (rev 509)
@@ -114,7 +114,9 @@
 	  of choice at it.  This is often preferable to the mail
 	  reader's own IMAP support since &OfflineIMAP; supports many
 	  features (offline reading, for one) that most IMAP-aware
-	  readers don't.
+	  readers don't.  However, this feature is not as time-tested
+	  as traditional syncing, so my advice is to stick with normal
+	  methods of operation for the time being.
 	</para>
       </refsect2>
     </refsect1>
@@ -818,6 +820,15 @@
 	  </para></listitem>
 	</varlistentry>
 
+	<varlistentry><term>I've upgraded and now &OfflineIMAP;
+	crashes when I start it up!  Why?</term>
+	  <listitem><para>You need to upgrade your configuration
+	file.  See <xref linkend="upgrading.4.0"> at the end of this
+	      manual.
+	    </para>
+	  </listitem>
+	</varlistentry>
+
 	<varlistentry><term>How do I specify the names of my folders?</term>
   	  <listitem><para>
 	    You do not need to.  &OfflineIMAP; is smart
@@ -937,7 +948,7 @@
       <title>Conforming To</title>
       <itemizedlist>
 	<listitem><para>Internet Message Access Protocol version 4rev1 (IMAP 4rev1) as
-	  specified in RFC2060</para></listitem>
+	  specified in RFC2060 and RFC3501</para></listitem>
 	<listitem><para>CRAM-MD5 as specified in RFC2195</para></listitem>
 	<listitem><para>Maildir as specified in
 	  <ulink url="http://www.qmail.org/qmail-manual-html/man5/maildir.html">the Maildir manpage</ulink> and
@@ -1046,6 +1057,42 @@
       </refsect2>
     </refsect1>
 
+    <refsect1 id="upgrading.4.0">
+      <title>Upgrading to 4.0</title>
+      <para>
+	If you are upgrading from a version of &OfflineIMAP; prior to
+	3.99.12, you will find that you will get errors when
+	&OfflineIMAP; starts up (relating to ConfigParser or
+	AccountHashGenerator) and the
+	configuration file.  This is because the config file format
+	had to change to accomodate new features in 4.0.  Fortunately,
+	it's not difficult to adjust it to suit.
+      </para>
+      <para>
+	First thing you need to do is stop any running &OfflineIMAP;
+	instance, making sure first that it's synced all your mail.
+	Then, modify your
+	<filename>~/.offlineimaprc</filename> file.  You'll need to
+	split up each account section (make sure that it now starts
+	with "Account ") into two Repository sections (one for the
+	local side and another for the remote side.)  See the files
+	<filename>offlineimap.conf.minimal</filename> and
+	<filename>offlineimap.conf</filename> in the distribution if
+	you need more assistance.
+      </para>
+      <para>
+	&OfflineIMAP;'s status directory area has also changed.
+	Therefore, you should delete everything in ~/.offlineimap as
+	well as your local mail folders.
+      </para>
+      <para>
+	When you start up &OfflineIMAP; 4.0, it will re-download all
+	your mail from the server and then you can continue using it
+	like normal.
+      </para>
+    </refsect1>
+	
+
     <refsect1>
       <title>Copyright</title>
       <para>OfflineIMAP, and this manual, are Copyright &copy; 2002, 2003 John Goerzen.</para>