/offlineimap/head: changeset 577

Fixed various doc bugs

offlineimap/head/debian/changelog

@@ -1,8 +1,14 @@
 offlineimap (4.0.3) unstable; urgency=low
 
-  * Fixed version numbers to read 4.0.3.
+  * Fixed version numbers to read 4.0.3.  Closes: #220536.
   * Switched defaults from Python 2.2 to Python 2.3.
-    Closes: #237560.
+    Closes: #237560, #239018.
+  * Fixed description typo.  Closes: #211251.
+  * Fixed nametrans example.  Closes: #252644.
+  * Applied patch from Johannes Berg for mycmp example in manual.
+    Closes: #252645.
+  * Fixed typos in manual.  Closes: #252646.
+  * Regenerated docs.
 
  -- John Goerzen <jgoerzen@complete.org>  Fri,  4 Jun 2004 10:10:00 -0500
 

offlineimap/head/debian/control

@@ -11,7 +11,7 @@ Depends: python2.3
 Suggests: python2.3-tk
 Description: IMAP/Maildir synchronization and reader support
  OfflineIMAP is a tool to simplify your e-mail reading.  With
- OfflimeIMAP, you can:
+ OfflineIMAP, you can:
  .
   * Read the same mailbox from multiple computers, and have your
     changes (deletions, etc.) be automatically reflected on

offlineimap/head/manual.html

@@ -247,7 +247,7 @@ NAME="AEN67"
 CLASS="APPLICATION"
 >OfflineIMAP</SPAN
 > system-wide,
-        or your system adminstrator has done that for you, your task
+        or your system administrator has done that for you, your task
         for setting up <SPAN
 CLASS="APPLICATION"
 >OfflineIMAP</SPAN
@@ -469,7 +469,7 @@ CLASS="COMMAND"
 	  package.  Then, skip to <A
 HREF="#CONFIGURATION"
 ><I
->Configruation</I
+>Configuration</I
 ></A
 > below.  You will type <B
 CLASS="COMMAND"
@@ -512,7 +512,7 @@ CLASS="COMMAND"
 	  Next, proceed to <A
 HREF="#CONFIGURATION"
 ><I
->Configruation</I
+>Configuration</I
 ></A
 > below.  You will type <B
 CLASS="COMMAND"
@@ -564,7 +564,7 @@ CLASS="REFSECT1"
 NAME="CONFIGURATION"
 ></A
 ><H2
->Configruation</H2
+>Configuration</H2
 ><P
 >	<SPAN
 CLASS="APPLICATION"
@@ -797,7 +797,7 @@ CLASS="REPLACEABLE"
 ><DD
 ><P
 >Specifies an alternative user interface module
-	      to use.  This overrides the defailt specified in the
+	      to use.  This overrides the default specified in the
 	      configuration file.  The pre-defined options are listed in
 	      the User Interfaces section.</P
 ></DD
@@ -943,7 +943,7 @@ CLASS="CITATION"
 ><DD
 ><P
 >indicates that an actual message is being copied.
-	      (We use fuschia for fake messages.)
+	      (We use fuchsia for fake messages.)
 	    </P
 ></DD
 ><DT
@@ -1293,9 +1293,13 @@ CLASS="PROGRAMLISTING"
 
 def mycmp(x, y):
    for prefix in prioritized:
-       if x.startswith(prefix):
+       xsw = x.startswith(prefix)
+       ysw = y.startswith(prefix)
+       if xsw and ysw:
+          return cmp(x, y)
+       elif xsw:
           return -1
-       elif y.startswith(prefix):
+       elif ysw:
           return +1
    return cmp(x, y)
 
@@ -1556,7 +1560,7 @@ CLASS="APPLICATION"
 CLASS="APPLICATION"
 >OfflineIMAP</SPAN
 > can help these programs by writing the names
-	    of the folders ni a format you specify.  See the example
+	    of the folders in a format you specify.  See the example
 	    <TT
 CLASS="FILENAME"
 >offlineimap.conf</TT
@@ -1782,7 +1786,7 @@ NAME="AEN499"
 CLASS="APPLICATION"
 >OfflineIMAP</SPAN
 > does a two-way synchronization.  That is, if you
-	  make a change to the mail on the server, it will be propogated to your
+	  make a change to the mail on the server, it will be propagated to your
 	  local copy, and vise-versa.  Some people might think that it would be
 	  wise to just delete all their local mail folders periodically.  If you
 	  do this with <SPAN
@@ -1995,7 +1999,7 @@ CLASS="APPLICATION"
 > 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,
+	had to change to accommodate new features in 4.0.  Fortunately,
 	it's not difficult to adjust it to suit.
       </P
 ><P
@@ -2147,6 +2151,69 @@ CLASS="APPLICATION"
 >(1)
       </P
 ></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN585"
+></A
+><H2
+>History</H2
+><P
+>	Detailed history may be found in the file ChangeLog in the
+	<SPAN
+CLASS="APPLICATION"
+>OfflineIMAP</SPAN
+> distribution.  Feature and bug histories may be
+	found in the file debian/changelog which, despite its name, is
+	not really Debian-specific.  This section provides a large
+	overview.
+      </P
+><P
+>	Development on <SPAN
+CLASS="APPLICATION"
+>OfflineIMAP</SPAN
+> began on June 18, 2002.  Version
+	1.0.0 was released three days later on June 21, 2002.  Point
+	releases followed, including speed optimizations and some
+	compatibility fixes.
+      </P
+><P
+>Version 2.0.0 was released on July 3, 2002, and
+	represented the first time the synchronization became
+	multithreaded and, to the best of my knowledge, the first
+	multithreaded IMAP syncrhonizing application in existance.
+	The last 2.0.x release, 2.0.8, was made on July 9.
+      </P
+><P
+>	Version 3.0.0 was released on July 11, 2002, and introduced
+	modular user interfaces and the first GUI interface for
+	<SPAN
+CLASS="APPLICATION"
+>OfflineIMAP</SPAN
+>.  This manual also was introduced with 3.0.0,
+	along with many command-line options.  Version 3.1.0 was
+	released on July 21, adding the Noninteractive user
+	interfaces, profiling support, and several bugfixes.  3.2.0
+	was released on July 24, adding support for the Blinkenlights
+	GUI interface.  <SPAN
+CLASS="APPLICATION"
+>OfflineIMAP</SPAN
+> entered maintenance mode for
+	awhile, as it had reached a feature-complete milestone in my
+	mind.
+      </P
+><P
+>	The 3.99.x branch began in on October 7, 2002, to begin work
+	for 4.0.  The Curses.Blinkenlights interface was added in
+	3.99.6, and many architectural changes were made.
+      </P
+><P
+>	4.0.0 was released on July 18, 2003, including the ability to
+            synchronize directly between two IMAP servers, the first
+            re-architecting of the configuration file to refine the
+            notion of an account, and the new Curses interface.
+      </P
+></DIV
 ></DIV
 ></BODY
 ></HTML

offlineimap/head/manual.txt

@@ -70,7 +70,7 @@ DESCRIPTION
 
 QUICK START
        If  you  have already installed OfflineIMAP system-wide, or your system
-       adminstrator  has  done  that  for  you,  your  task  for  setting   up
+       administrator  has  done  that  for  you,  your  task  for  setting  up
        OfflineIMAP  for  the first time is quite simple.  You just need to set
        up your configuration file, make your folder directory, and run it!
 
@@ -182,7 +182,7 @@ INSTALLATION
        above  and  then  type  ./offlineimap.py; there is no installation step
        necessary.
 
-CONFIGRUATION
+CONFIGURATION
        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.
@@ -254,7 +254,7 @@ OPTIONS
 
        -u interface
               Specifies an alternative user interface  module  to  use.   This
-              overrides  the defailt specified in the configuration file.  The
+              overrides  the default specified in the configuration file.  The
               pre-defined options are listed in the User Interfaces section.
 
 USER INTERFACES
@@ -308,8 +308,8 @@ USER INTERFACES
 
        Blue   is the color of a message synchronization controller thread.
 
-       Orange indicates that an actual  message  is  being  copied.   (We  use
+       Orange indicates that an actual message is being copied.  (We use fuch-
-              fuschia for fake messages.)
+              sia for fake messages.)
 
        Red (meaning 2)
               indicates that a message is being deleted.
@@ -471,9 +471,13 @@ EXAMPLES
 
        def mycmp(x, y):
           for prefix in prioritized:
-              if x.startswith(prefix):
+              xsw = x.startswith(prefix)
+              ysw = y.startswith(prefix)
+              if xsw and ysw:
+                 return cmp(x, y)
+              elif xsw:
                  return -1
-              elif y.startswith(prefix):
+              elif ysw:
                  return +1
           return cmp(x, y)
 
@@ -573,7 +577,7 @@ OTHER FREQUENTLY ASKED QUESTIONS
        What is the mailbox name recorder (mbnames) for?
               Some mail readers, such as Mutt, are not  capable  of  automati-
               cally  determining the names of your mailboxes.  OfflineIMAP can
-              help these programs by writing the names of  the  folders  ni  a
+              help these programs by writing the names of  the  folders  in  a
               format  you  specify.   See  the  example  offlineimap.conf  for
               details.
 
@@ -596,14 +600,15 @@ OTHER FREQUENTLY ASKED QUESTIONS
 
        [technical] Why are your Maildir message filenames so huge?
               OfflineIMAP has two relevant principles: 1) never modifying your
-              messages  in  any way and 2) ensuring 100% reliable synchroniza-
+              messages   in   any   way   and   2)   ensuring   100%  reliable
-              tions.  In order to do a reliable sync, OfflineIMAP must have  a
+              synchronizations.  In order to do a reliable  sync,  OfflineIMAP
-              way  to uniquely identify each e-mail.  Three pieces of informa-
+              must  have a way to uniquely identify each e-mail.  Three pieces
-              tion are required to do this:  your  account  name,  the  folder
+              of information are required to do this: your account  name,  the
-              name,  and  the message UID.  The account name can be calculated
+              folder  name, and the message UID.  The account name can be cal-
-              from the path in which your messages are.  The folder  name  can
+              culated from the path in which your messages  are.   The  folder
-              usually  be as well, BUT some mail clients move messages between
+              name can usually be as well, BUT some mail clients move messages
-              folders by simply moving the file, leaving the name intact.
+              between folders by simply moving  the  file,  leaving  the  name
+              intact.
 
               So,  OfflineIMAP must store both a UID folder ID.  The folder ID
               is necessary so OfflineIMAP can detect a message moved to a dif-
@@ -656,7 +661,7 @@ CONFORMING TO
 NOTES
    DELETING LOCAL FOLDERS
        OfflineIMAP  does  a  two-way  synchronization.  That is, if you make a
-       change  to  the mail on the server, it will be propogated to your local
+       change to the mail on the server, it will be propagated to  your  local
        copy, and vise-versa.  Some people might think that it would be wise to
        just delete all their local mail folders periodically.  If you do  this
        with  OfflineIMAP,  remember  to  also  remove  your local status cache
@@ -724,7 +729,7 @@ UPGRADING TO 4.0
        you  will  find  that  you  will  get errors when OfflineIMAP starts up
        (relating to ConfigParser or AccountHashGenerator) and  the  configura-
        tion  file.   This  is  because the config file format had to change to
-       accomodate  new  features  in  4.0.  Fortunately, it's not difficult to
+       accommodate new features in 4.0.  Fortunately, it's  not  difficult  to
        adjust it to suit.
 
        First  thing  you  need to do is stop any running OfflineIMAP instance,
@@ -782,6 +787,39 @@ AUTHOR
 SEE ALSO
        mutt(1), python(1)
 
+HISTORY
+       Detailed  history may be found in the file ChangeLog in the OfflineIMAP
+       distribution.  Feature and bug histories  may  be  found  in  the  file
+       debian/changelog  which,  despite  its  name, is not really Debian-spe-
+       cific.  This section provides a large overview.
+
+       Development on OfflineIMAP began on June 18, 2002.  Version  1.0.0  was
+       released  three  days later on June 21, 2002.  Point releases followed,
+       including speed optimizations and some compatibility fixes.
+
+       Version 2.0.0 was released on July 3, 2002, and represented  the  first
+       time  the  synchronization  became multithreaded and, to the best of my
+       knowledge, the first multithreaded IMAP  syncrhonizing  application  in
+       existance.  The last 2.0.x release, 2.0.8, was made on July 9.
+
+       Version  3.0.0  was  released  on July 11, 2002, and introduced modular
+       user interfaces and the first GUI interface for OfflineIMAP.  This man-
+       ual  also  was  introduced  with  3.0.0,  along  with many command-line
+       options.  Version 3.1.0 was released on July 21, adding the Noninterac-
+       tive  user  interfaces, profiling support, and several bugfixes.  3.2.0
+       was released on July 24,  adding  support  for  the  Blinkenlights  GUI
+       interface.   OfflineIMAP entered maintenance mode for awhile, as it had
+       reached a feature-complete milestone in my mind.
+
+       The 3.99.x branch began in on October 7, 2002, to begin work  for  4.0.
+       The Curses.Blinkenlights interface was added in 3.99.6, and many archi-
+       tectural changes were made.
+
+       4.0.0 was released on July 18, 2003, including the ability to  synchro-
+       nize  directly  between  two IMAP servers, the first re-architecting of
+       the configuration file to refine the notion of an account, and the  new
+       Curses interface.
 
 
-John Goerzen                     18 July 2003                   OFFLINEIMAP(1)
+
+John Goerzen                     04 June 2004                   OFFLINEIMAP(1)

offlineimap/head/offlineimap.1

@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "OFFLINEIMAP" "1" "25 July 2003" "John Goerzen" "OfflineIMAP Manual"
+.TH "OFFLINEIMAP" "1" "04 June 2004" "John Goerzen" "OfflineIMAP Manual"
 
 .SH NAME
 OfflineIMAP \- Powerful IMAP/Maildir synchronization and reader support
@@ -83,7 +83,7 @@ methods of operation for the time being.
 .SH "QUICK START"
 .PP
 If you have already installed \fBOfflineIMAP\fR system-wide,
-or your system adminstrator has done that for you, your task
+or your system administrator has done that for you, your task
 for setting up \fBOfflineIMAP\fR for the first time is quite
 simple.  You just need to set up your configuration file, make
 your folder directory, and run it!
@@ -308,7 +308,7 @@ Show summary of options.
 .TP
 \fB-u \fIinterface\fB\fR
 Specifies an alternative user interface module
-to use.  This overrides the defailt specified in the
+to use.  This overrides the default specified in the
 configuration file.  The pre-defined options are listed in
 the User Interfaces section.
 .SH "USER INTERFACES"
@@ -375,7 +375,7 @@ is the color of a message synchronization controller thread.
 .TP
 \fBOrange\fR
 indicates that an actual message is being copied.
-(We use fuschia for fake messages.)
+(We use fuchsia for fake messages.)
 .TP
 \fBRed (meaning 2)\fR
 indicates that a message is being deleted.
@@ -562,9 +562,13 @@ prioritized = ['INBOX', 'personal', 'announce', 'list']
 
 def mycmp(x, y):
    for prefix in prioritized:
-       if x.startswith(prefix):
+       xsw = x.startswith(prefix)
+       ysw = y.startswith(prefix)
+       if xsw and ysw:
+          return cmp(x, y)
+       elif xsw:
           return -1
-       elif y.startswith(prefix):
+       elif ysw:
           return +1
    return cmp(x, y)
 
@@ -673,7 +677,7 @@ Yes; see the Notes section below.
 Some mail readers, such as Mutt, are not capable
 of automatically determining the names of your mailboxes.
 \fBOfflineIMAP\fR can help these programs by writing the names
-of the folders ni a format you specify.  See the example
+of the folders in a format you specify.  See the example
 \fIofflineimap.conf\fR for details.
 .TP
 \fBCan I synchronize multiple accounts with OfflineIMAP?\fR
@@ -769,7 +773,7 @@ Standard Python 2.2.1 as implemented on POSIX-compliant systems.
 .SS "DELETING LOCAL FOLDERS"
 .PP
 \fBOfflineIMAP\fR does a two-way synchronization.  That is, if you
-make a change to the mail on the server, it will be propogated to your
+make a change to the mail on the server, it will be propagated to your
 local copy, and vise-versa.  Some people might think that it would be
 wise to just delete all their local mail folders periodically.  If you
 do this with \fBOfflineIMAP\fR, remember to also remove your local status
@@ -846,7 +850,7 @@ If you are upgrading from a version of \fBOfflineIMAP\fR prior to
 \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,
+had to change to accommodate 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

offlineimap/head/offlineimap.conf

@@ -286,7 +286,7 @@ holdconnectionopen = no
 # filtered out by folderfilter below.  Failure to follow this rule
 # will result in undefined behavior
 #
-# nametrans = lambda foldername: re.sub('^INBOX.', '', foldername)
+# nametrans = lambda foldername: re.sub('^INBOX\.', '', foldername)
 
 # You can specify which folders to sync.  You can do it several ways.
 # I'll provide some examples.  The folderfilter operates on the

offlineimap/head/offlineimap.sgml

@@ -10,7 +10,7 @@
     <refentryinfo>
       <address><email>jgoerzen@complete.org</email></address>
       <author><firstname>John</firstname><surname>Goerzen</surname></author>
-      <date> $Date: 2003-07-25 15:41:35 -0500 (Fri, 25 Jul 2003) $ </date>
+      <date> $Date: 2004-06-04 10:26:30 -0500 (Fri, 04 Jun 2004) $ </date>
     </refentryinfo>
 
     <refmeta>
@@ -124,7 +124,7 @@
     <refsect1>
       <title>Quick Start</title>
       <para>If you have already installed &OfflineIMAP; system-wide,
-        or your system adminstrator has done that for you, your task
+        or your system administrator has done that for you, your task
         for setting up &OfflineIMAP; for the first time is quite
         simple.  You just need to set up your configuration file, make
         your folder directory, and run it!
@@ -395,7 +395,7 @@ cd offlineimap-x.y.z</ProgramListing>
 	  </varlistentry>
 	  <varlistentry><term>-u <replaceable>interface</replaceable></term>
 	    <listitem><para>Specifies an alternative user interface module
-	      to use.  This overrides the defailt specified in the
+	      to use.  This overrides the default specified in the
 	      configuration file.  The pre-defined options are listed in
 	      the User Interfaces section.</para>
 	    </listitem>
@@ -485,7 +485,7 @@ cd offlineimap-x.y.z</ProgramListing>
 	  <varlistentry>
 	    <term>Orange</term>
 	    <listitem><para>indicates that an actual message is being copied.
-	      (We use fuschia for fake messages.)
+	      (We use fuchsia for fake messages.)
 	    </para></listitem>
 	  </varlistentry>
 	  <varlistentry>
@@ -709,9 +709,13 @@ foldersort=mycmp</programlisting>
 
 def mycmp(x, y):
    for prefix in prioritized:
-       if x.startswith(prefix):
+       xsw = x.startswith(prefix)
+       ysw = y.startswith(prefix)
+       if xsw and ysw:
+          return cmp(x, y)
+       elif xsw:
           return -1
-       elif y.startswith(prefix):
+       elif ysw:
           return +1
    return cmp(x, y)
 
@@ -863,7 +867,7 @@ rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
 	  <listitem><para>Some mail readers, such as Mutt, are not capable
 	    of automatically determining the names of your mailboxes.
 	    &OfflineIMAP; can help these programs by writing the names
-	    of the folders ni a format you specify.  See the example
+	    of the folders in a format you specify.  See the example
 	    <filename>offlineimap.conf</filename> for details.
 	  </para></listitem>
 	</varlistentry>
@@ -962,7 +966,7 @@ rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
       <refsect2>
 	<title>Deleting Local Folders</title>
 	<para>&OfflineIMAP; does a two-way synchronization.  That is, if you
-	  make a change to the mail on the server, it will be propogated to your
+	  make a change to the mail on the server, it will be propagated to your
 	  local copy, and vise-versa.  Some people might think that it would be
 	  wise to just delete all their local mail folders periodically.  If you
 	  do this with &OfflineIMAP;, remember to also remove your local status
@@ -1065,7 +1069,7 @@ rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
 	&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,
+	had to change to accommodate new features in 4.0.  Fortunately,
 	it's not difficult to adjust it to suit.
       </para>
       <para>