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

   1 productname = 'OfflineIMAP'
   2 versionstr = "5.99.7"
   3
   4 versionlist = versionstr.split(".")
   5 major = versionlist[0]
   6 minor = versionlist[1]
   7 patch = versionlist[2]
   8 copyright = "Copyright (C) 2002 - 2008 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
  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 - 2007 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 def getcmdhelp():
  38     from offlineimap.ui import detector
  39     import os
  40     uilist = ""
  41     for ui in detector.DEFAULT_UI_LIST:
  42         uilist += "                " + ui + os.linesep
  43     return """
  44        offlineimap [ -1 ] [ -P profiledir ] [ -a accountlist ]  [
  45        -c configfile  ] [ -d debugtype[,debugtype...]  ] [ -o ] [
  46        -u interface ] [ -q ]
  47
  48        offlineimap -h | --help
  49
  50        -1     Disable   all  multithreading  operations  and  use
  51               solely a single-thread sync.  This effectively sets
  52               the maxsyncaccounts and all maxconnections configu-
  53               ration file variables to 1.
  54
  55        -P profiledir
  56               Sets OfflineIMAP into profile  mode.   The  program
  57               will create profiledir (it must not already exist).
  58               As it runs, Python profiling information about each
  59               thread  is  logged  into  profiledir.  Please note:
  60               This option is present for debugging and  optimiza-
  61               tion only, and should NOT be used unless you have a
  62               specific reason to do so.   It  will  significantly
  63               slow  program  performance, may reduce reliability,
  64               and can generate huge amounts of  data.   You  must
  65               use the -1 option when you use -P.
  66
  67
  68        -a accountlist
  69               Overrides  the accounts section in the config file.
  70               Lets you specify a particular  account  or  set  of
  71               accounts  to sync without having to edit the config
  72               file.   You  might  use  this  to  exclude  certain
  73               accounts,  or  to  sync some accounts that you nor-
  74               mally prefer not to.
  75
  76        -c configfile
  77               Specifies a configuration file to use  in  lieu  of
  78               the default, ~/.offlineimaprc.
  79
  80        -d debugtype[,debugtype...]
  81               Enables  debugging for OfflineIMAP.  This is useful
  82               if you are trying to track down  a  malfunction  or
  83               figure out what is going on under the hood.  I sug-
  84               gest that you use this with -1 in order to make the
  85               results more sensible.
  86
  87               -d  now  requires one or more debugtypes, separated
  88               by commas.   These  define  what  exactly  will  be
  89               debugged,  and so far include two options: imap and
  90               maildir.  The imap option will enable IMAP protocol
  91               stream and parsing debugging.  Note that the output
  92               may contain passwords, so take care to remove  that
  93               from the debugging output before sending it to any-
  94               one else.  The maildir option will enable debugging
  95               for certain Maildir operations.
  96
  97        -f foldername[,foldername...]
  98               Only sync the specified folders.  The "foldername"s
  99               are    the   *untranslated*    foldernames.    This
 100               command-line  option  overrides any  "folderfilter"
 101               and "folderincludes" options  in the  configuration
 102               file.
 103
 104        -k [section:]option=value
 105               Override configuration file option.  If"section" is
 106               omitted, it defaults to "general".  Any underscores
 107               "_" in the section name are replaced with spaces:
 108               for instance,  to override  option "autorefresh" in
 109               the "[Account Personal]" section in the config file
 110               one would use "-k Account_Personal:autorefresh=30".
 111
 112        -o     Run only once,  ignoring any autorefresh setting in
 113               the config file.
 114
 115        -q     Run  only quick synchronizations.   Ignore any flag
 116               updates on IMAP servers.
 117
 118        -h, --help
 119               Show summary of options.
 120
 121        -u interface
 122               Specifies an alternative user interface  module  to
 123               use.   This  overrides the default specified in the
 124               configuration file.  The UI specified with -u  will
 125               be  forced to be used, even if its isuable() method
 126               states that it cannot be.   Use  this  option  with
 127               care.   The  pre-defined  options, described in the
 128               USER INTERFACES section of the man page, are:
 129 """ + uilist