"Fossies" - the Fresh Open Source Software Archive

Member "getmail-5.16/README" (31 Oct 2021, 2426 Bytes) of package /linux/misc/getmail-5.16.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 5.15_vs_5.16.

    1 getmail version 5 -- a flexible, extensible mail retrieval system with
    2 support for POP3, IMAP4, SSL variants of both, maildirs, mboxrd files,
    3 external MDAs, arbitrary message filtering, single-user and domain-mailboxes,
    4 and many other useful features.
    5 
    6 getmail is Copyright (C) 1998-2021 Charles Cazabon.
    7 getmail is licensed for use under the GNU General Public License version 2
    8 (only).  See docs/COPYING for specific terms and distribution information.
    9 
   10 getmail version 5 requires Python version 2.3.3 or later.  You can have
   11 several installed versions of Python peacefully co-existing, see
   12 python.org for details.
   13 
   14 To install:  getmail v.5 uses the standard Python distutils.  Do the following
   15   as a regular user:
   16 
   17     python setup.py build
   18 
   19   Then (probably as root), do:
   20 
   21     python setup.py install
   22 
   23   This will install the software as follows:
   24 
   25     -the four scripts will be installed in <PREFIX>/bin/
   26     -the Python files will be installed under the site-packages directory of
   27      your Python installation (typically /usr/local/lib/pythonXXX or
   28      /usr/lib/pythonXXX, but may be elsewhere -- this is detected automatically)
   29     -the documentation will be installed under <PREFIX>/doc/getmail-<version>/
   30     -the man pages will be installed under <PREFIX>/man/
   31 
   32   <PREFIX> is the directory Python was configured to install under (typically
   33   either /usr/local/ or /usr/, but may be another value).  See the file
   34   docs/documentation.html or docs/documentation.txt for details on installing
   35   files to directories other than these defaults.
   36 
   37 The four scripts included in the package (getmail, getmail_maildir,
   38 getmail_mbox, and getmail_fetch) will have their "#!"-interpreter line
   39 automatically modified to invoke the Python interpreter you run the setup
   40 script with.  If you later remove this version of Python, and the newer version
   41 does not provide a link to the interpreter with that name, you will have to
   42 modify the scripts or re-run the setup.py script.
   43 
   44 See the HTML documentation for details on setting up and using getmail.  It is
   45 included in the docs subdirectory of the distribution tarball, and will be
   46 installed in <PREFIX>/doc/getmail-<version>/ (by default).  10-second summary
   47 for personal use:
   48 
   49   1. Install getmail
   50   2. mkdir -m 700 ~/.getmail
   51   3. Create ~/.getmail/getmailrc by following the instructions.
   52   4. Run `getmail`.
   53 
   54 See docs/BUGS for instructions on reporting bugs in this software.