INSTALL
c3bc0a8c
 Installation of s3cmd package
 =============================
 
60582c26
 Copyright:
     TGRMN Software and contributors
c3bc0a8c
 
 S3tools / S3cmd project homepage:
60582c26
     http://s3tools.org
c3bc0a8c
 
 !!!
 !!! Please consult README file for setup, usage and examples!
 !!!
 
 Package formats
 ---------------
 S3cmd is distributed in two formats:
60582c26
 
c3bc0a8c
 1) Prebuilt RPM file - should work on most RPM-based
    distributions
 
60582c26
 2) Source .tar.gz package
c3bc0a8c
 
 
 Installation of RPM package
 ---------------------------
 As user "root" run:
    
 	rpm -ivh s3cmd-X.Y.Z.noarch.rpm
 
 where X.Y.Z is the most recent s3cmd release version.
 
 You may be informed about missing dependencies
 on Python or some libraries. Please consult your 
 distribution documentation on ways to solve the problem.
 
63424cae
 Installation from PyPA (Python Package Authority)
 ---------------------
f256440e
 S3cmd can be installed from the PyPA using PIP (the recommended tool for PyPA).
63424cae
 
 1) Confirm you have PIP installed. PIP home page is here: https://pypi.python.org/pypi/pip 
    Example install on a RHEL yum based machine
 	sudo yum install python-pip
 2) Install with pip
 	sudo pip install s3cmd
c3bc0a8c
 
6260cc16
 Installation from zip file 
 --------------------------
c3bc0a8c
 There are three options to run s3cmd from source tarball:
 
6260cc16
 1) The S3cmd program, as distributed in s3cmd-X.Y.Z.tar.gz
    on SourceForge or in master.zip on GitHub, can be run directly 
    from where you unzipped the package.
c3bc0a8c
 
 2) Or you may want to move "s3cmd" file and "S3" subdirectory
    to some other path. Make sure that "S3" subdirectory ends up
    in the same place where you move the "s3cmd" file. 
 
    For instance if you decide to move s3cmd to you $HOME/bin
    you will have $HOME/bin/s3cmd file and $HOME/bin/S3 directory 
    with a number of support files.
 
6260cc16
 3) The cleanest and most recommended approach is to unzip the 
    package and then just run:
c3bc0a8c
 
 	python setup.py install
 
    You will however need Python "distutils" module for this to 
    work. It is often part of the core python package (e.g. in 
    OpenSuse Python 2.5 package) or it can be installed using your
    package manager, e.g. in Debian use 
 
e5edb9cc
 	apt-get install python-setuptools
c3bc0a8c
 
    Again, consult your distribution documentation on how to 
    find out the actual package name and how to install it then.
 
9c4316d8
    Note that on Linux, if you are not "root" already, you may 
    need to run:
6260cc16
        
         sudo python setup.py install
 
    instead.
 
c3bc0a8c
 
60582c26
 Note to distributions package maintainers
c9930864
 ----------------------------------------
 Define shell environment variable S3CMD_PACKAGING=yes if you
 don't want setup.py to install manpages and doc files. You'll
 have to install them manually in your .spec or similar package
 build scripts.
 
 On the other hand if you want setup.py to install manpages 
 and docs, but to other than default path, define env 
 variables $S3CMD_INSTPATH_MAN and $S3CMD_INSTPATH_DOC. Check 
 out setup.py for details and default values.
 
 
c3bc0a8c
 Where to get help
 -----------------
 If in doubt, or if something doesn't work as expected, 
 get back to us via mailing list:
 
 	s3tools-general@lists.sourceforge.net
 
6260cc16
 or visit the S3cmd / S3tools homepage at: 
 
         http://s3tools.org