code.delx.au - offlineimap/blob - offlineimap/version.py

   1 productname = 'OfflineIMAP'
   2 versionstr = "4.0.16"
   3
   4 versionlist = versionstr.split(".")
   5 major = versionlist[0]
   6 minor = versionlist[1]
   7 patch = versionlist[2]
   8 copyright = "Copyright (C) 2002 - 2006 John Goerzen"
   9 author = "John Goerzen"
  10 author_email = "jgoerzen@complete.org"
  11 description = "Disconnected Universal IMAP Mail Synchronization/Reader Support"
  12 bigcopyright = """%(productname)s %(versionstr)s (%(revstr)s)
  13 %(copyright)s <%(author_email)s>""" % locals()
  14
  15 banner = bigcopyright + """
  16 This software comes with ABSOLUTELY NO WARRANTY; see the file
  17 COPYING for details.  This is free software, and you are welcome
  18 to distribute it under the conditions laid out in COPYING."""
  19
  20 homepage = "http://www.quux.org/devel/offlineimap"
  21 homegopher = "gopher://quux.org/1/devel/offlineimap"
  22 license = """Copyright (C) 2002 - 2006 John Goerzen <jgoerzen@complete.org>
  23
  24 This program is free software; you can redistribute it and/or modify
  25 it under the terms of the GNU General Public License as published by
  26 the Free Software Foundation; either version 2 of the License, or
  27 (at your option) any later version.
  28
  29 This program is distributed in the hope that it will be useful,
  30 but WITHOUT ANY WARRANTY; without even the implied warranty of
  31 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32 GNU General Public License for more details.
  33
  34 You should have received a copy of the GNU General Public License
  35 along with this program; if not, write to the Free Software
  36 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA"""
  37
  38 cmdhelp = """
  39        offlineimap [ -1 ] [ -P profiledir ] [ -a accountlist ]  [
  40        -c configfile  ] [ -d debugtype[,debugtype...]  ] [ -o ] [
  41        -u interface ]
  42
  43        offlineimap -h | --help
  44
  45        -1     Disable   all  multithreading  operations  and  use
  46               solely a single-thread sync.  This effectively sets
  47               the maxsyncaccounts and all maxconnections configu-
  48               ration file variables to 1.
  49
  50        -P profiledir
  51               Sets OfflineIMAP into profile  mode.   The  program
  52               will create profiledir (it must not already exist).
  53               As it runs, Python profiling information about each
  54               thread  is  logged  into  profiledir.  Please note:
  55               This option is present for debugging and  optimiza-
  56               tion only, and should NOT be used unless you have a
  57               specific reason to do so.   It  will  significantly
  58               slow  program  performance, may reduce reliability,
  59               and can generate huge amounts of  data.   You  must
  60               use the -1 option when you use -P.
  61
  62
  63        -a accountlist
  64               Overrides  the accounts section in the config file.
  65               Lets you specify a particular  account  or  set  of
  66               accounts  to sync without having to edit the config
  67               file.   You  might  use  this  to  exclude  certain
  68               accounts,  or  to  sync some accounts that you nor-
  69               mally prefer not to.
  70
  71        -c configfile
  72               Specifies a configuration file to use  in  lieu  of
  73               the default, ~/.offlineimaprc.
  74
  75        -d debugtype[,debugtype...]
  76               Enables  debugging for OfflineIMAP.  This is useful
  77               if you are trying to track down  a  malfunction  or
  78               figure out what is going on under the hood.  I sug-
  79               gest that you use this with -1 in order to make the
  80               results more sensible.
  81
  82               -d  now  requires one or more debugtypes, separated
  83               by commas.   These  define  what  exactly  will  be
  84               debugged,  and so far include two options: imap and
  85               maildir.  The imap option will enable IMAP protocol
  86               stream and parsing debugging.  Note that the output
  87               may contain passwords, so take care to remove  that
  88               from the debugging output before sending it to any-
  89               one else.  The maildir option will enable debugging
  90               for certain Maildir operations.
  91
  92        -o     Run  only once, ignoring any autorefresh setting in
  93               the config file.
  94
  95        -h, --help
  96               Show summary of options.
  97
  98        -u interface
  99               Specifies an alternative user interface  module  to
 100               use.   This  overrides the default specified in the
 101               configuration file.  The UI specified with -u  will
 102               be  forced to be used, even if its isuable() method
 103               states that it cannot be.   Use  this  option  with
 104               care.   The  pre-defined  options are listed in the
 105               USER INTERFACES section.
 106
 107 """