Merge branches 'master' and 'master' of ssh://jpgarch@complete.org/~jpgarch/git/offli...

[offlineimap] / offlineimap.sgml

diff --git a/offlineimap.sgml b/offlineimap.sgml
index 6fc8d52c425a9944d072f0165b1556e84af3cfe7..e1647351ce3105b7ea9731ddcae39fbce6d05c6d 100644 (file)
--- a/offlineimap.sgml
+++ b/offlineimap.sgml
@@ -32,6 +32,8 @@
        <arg>-a <replaceable>accountlist</replaceable></arg>
        <arg>-c <replaceable>configfile</replaceable></arg>
        <arg>-d <replaceable>debugtype[,...]</replaceable></arg>
+        <arg>-f <replaceable>foldername[,...]</replaceable></arg>
+        <arg>-k <replaceable>[section:]option=value</replaceable></arg>
        <arg>-l <replaceable>filename</replaceable></arg>
        <arg>-o</arg>
        <arg>-u <replaceable>interface</replaceable></arg>
@@ -204,6 +206,8 @@ remoteuser = jgoerzen
              and corporate networks do, and most operating systems
              have an IMAP
              implementation readily available.
+              A special <property>Gmail</property> mailbox type is
+              available to interface with Gmail's IMAP front-end.
            </para>
          </listitem>
          <listitem>
@@ -373,6 +377,26 @@ cd offlineimap-x.y.z</ProgramListing>
              will debug the threading model.
            </para></listitem>
          </varlistentry>
+        <varlistentry><term>-f <replaceable>foldername</replaceable>[,<replaceable>foldername</replaceable>]</term>
+          <listitem><para> Only sync the specified folders.  The
+              <replaceable>foldername</replaceable>s are the
+              untranslated foldernames.  This command-line option
+              overrides any <property>folderfilter</property>
+              and <property>folderincludes</property> options in the
+              configuration file.
+          </para></listitem>
+        </varlistentry>
+        <varlistentry><term>-k [<replaceable>section</replaceable>:]<replaceable>option</replaceable>=<replaceable>value</replaceable>
+          </term>
+          <listitem><para> Override configuration file option.  If
+              "section" is omitted, it defaults
+              to <property>general</property>.  Any underscores "_" in
+              the section name are replaced with spaces: for instance,
+              to override option <property>autorefresh</property> in
+              the "[Account Personal]" section in the config file one
+              would use "-k Account_Personal:autorefresh=30".
+          </para></listitem>
+        </varlistentry>
          <varlistentry><term>-l
          <replaceable>filename</replaceable></term>
            <listitem><para>
@@ -389,6 +413,11 @@ cd offlineimap-x.y.z</ProgramListing>
              file.</para>
            </listitem>
          </varlistentry>
+         <varlistentry><term>-q</term>
+           <listitem><para>Run only quick synchronizations.   Ignore any flag
+              updates on IMAP servers.</para>
+           </listitem>
+         </varlistentry>
          <varlistentry><term>-h</term> <term>--help</term>
            <listitem><para>Show summary of options.</para></listitem>
          </varlistentry>
@@ -672,7 +701,7 @@ holdconnectionopen = no</programlisting>
          is based on one supplied by Tommi Virtanen for this feature.
        </para>
        <para>
-         In <filename>~/.offlineimap.rc</filename>, he adds these options:
+         In <filename>~/.offlineimaprc</filename>, he adds these options:
        </para>
        <programlisting>[general]
 pythonfile=~/.offlineimap.py
@@ -762,11 +791,11 @@ def test_mycmp():
        </para>
 
        <programlisting>rm -r ~/Folders/INBOX
-rm -r ~/.offlineimap/Account-<replaceable>AccountName</>
-rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
+rm -r ~/.offlineimap/Account-<replaceable>AccountName</>/LocalStatus/INBOX
+rm -r ~/.offlineimap/Repository-<replaceable>RemoteRepositoryName</>/FolderValidity/INBOX</programlisting>
 
        <para>
-         (Of course, replace AccountName and RepositoryName 
+         (Of course, replace AccountName and RemoteRepositoryName 
          with the names as specified
          in <filename>~/.offlineimaprc</filename>).
        </para>
@@ -823,7 +852,7 @@ rm -r ~/.offlineimap/Repository-<replaceable>RepositoryName</></programlisting>
          this as an intentional deletion of many messages and will interpret
          your action as requesting them to be deleted from the server as well.
          (If you don't understand this, don't worry; you probably won't
-         encounter this situation)
+         encounter this situation.)
        </para>
       </refsect2>