rev 339 - offlineimap/head

Author: jgoerzen
Date: 2003-01-07 17:02:43 -0600 (Tue, 07 Jan 2003)
New Revision: 339

Modified:
   offlineimap/head/offlineimap.sgml
Log:


Modified: offlineimap/head/offlineimap.sgml
==============================================================================
--- offlineimap/head/offlineimap.sgml	(original)
+++ offlineimap/head/offlineimap.sgml	Tue Jan  7 17:02:44 2003
@@ -11,7 +11,7 @@
     <refentryinfo>
       <address><email>[email protected]</email></address>
       <author><firstname>John</firstname><surname>Goerzen</surname></author>
-      <date>$Date$</date>
+      <date> $Date$ </date>
     </refentryinfo>
 
     <refmeta>
@@ -291,10 +291,58 @@
       </para>
 
       <variablelist><title>OfflineIMAP arguments</title>
-      <varlistentry><term>-1</term>
-      <listitem><para>This is a test</para></listitem></varlistentry>
+        <varlistentry><term>-1</term>
+          <listitem><para>Disable most multithreading operations and use
+	    solely a single-connection
+	    sync.  This effectively sets the <property>maxsyncaccounts</property>
+	    and all <property>maxconnections</property> configuration file
+	    variables to 1.
+	  </para></listitem>
+	</varlistentry>
+	<varlistentry><term>-P <replaceable>profiledir</replaceable></term>
+	  <listitem><para>Sets &OfflineIMAP; into profile mode.  The program
+	    will create <replaceable>profiledir</replaceable>
+	    (it must not already exist).  As it runs, Python profiling 
+	    information
+	    about each thread is logged into profiledir.  Please note: This option
+	    is present for debugging and optimization only, and should NOT be used
+	    unless you have a specific reason to do so.  It will significantly
+	    slow program performance, may reduce reliability, and can generate
+	    huge amounts of data.  You must use the <option>-1</option> option when
+	    you use <option>-P</option>.
+	  </para></listitem>
+	</varlistentry>
+	<varlistentry><term>-a <replaceable>accountlist</replaceable></term>
+	  <listitem><para>Overrides the <property>accounts</property> option
+	    in the <property>general</property> section of the configuration
+	    file.  You might use this to exclude certain accounts, or to sync
+	    some accounts that you normally prefer not to.  Separate the
+	    accounts by commas, and use no embedded spaces.
+	  </para></listitem>
+	</varlistentry>
+	<varlistentry><term>-c <replaceable>configfile</replaceable></term>
+	  <listitem><para>Specifies a configuration file to use in lieu of
+	    the default, <filename>~/.offlineimaprc</filename>.
+	  </para></listitem>
+	</varlistentry>
+	<varlistentry><term>-d <replaceable>debugtype[,...]</replaceable></term>
+	  <listitem><para>Enables debugging for OfflineIMAP.  This is useful if
+	    you are trying to track down a malfunction or figure out what is going
+	    on under the hood.  I suggest that you use this with
+	    <option>-1</option> to make the results more sensible.</para>
+
+	    <para><option>-d</option> requires one or more debugtypes,
+	      separated by commas.  These define what exactly will be
+	      debugged, and include two options: <property>imap</property>
+	      and <property>maildir</property>.  The <property>imap</property>
+	      option will enable IMAP protocol stream and parsing debugging.  Note
+	      that the output may contain passwords, so take care to remove that
+	      from the debugging output before sending it to anyone else.  The
+	      <property>maildir</property> option will enable debugging for
+	      certain Maildir operations.
+	    </para></listitem>
+	  </varlistentry>
       </variablelist>
-
     <refsect1>
       <title>See Also</title>
       <para>This is also a test.  Foo bar.</para>