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