1. s3cmd
  2. Commit 93746fb90086ebec683f66ec7491d9ad346586ae
Browse code

README: brew install and renamed to INSTALL.md

nitro authored on 2020/02/15 07:15:55
Showing 2 changed files
INSTALL
History View file @ 93746fb
1 1 
deleted file mode 100644
... ... 
@@ -1,107 +0,0 @@
1 
-Installation of s3cmd package
2 
-=============================
3 
-
4 
-Copyright:
5 
-    TGRMN Software and contributors
6 
-
7 
-S3tools / S3cmd project homepage:
8 
-    http://s3tools.org
9 
-
10 
-!!!
11 
-!!! Please consult README file for setup, usage and examples!
12 
-!!!
13 
-
14 
-Package formats
15 
-S3cmd is distributed in two formats:
16 
-
17 
-1) Prebuilt RPM file - should work on most RPM-based
18 
-   distributions
19 
-
20 
-2) Source .tar.gz package
21 
-
22 
-
23 
-Installation of RPM package
24 
-As user "root" run:
25 
-
26 
-	rpm -ivh s3cmd-X.Y.Z.noarch.rpm
27 
-
28 
-where X.Y.Z is the most recent s3cmd release version.
29 
-
30 
-You may be informed about missing dependencies
31 
-on Python or some libraries. Please consult your
32 
-distribution documentation on ways to solve the problem.
33 
-
34 
-Installation from PyPA (Python Package Authority)
35 
-S3cmd can be installed from the PyPA using PIP (the recommended tool for PyPA).
36 
-
37 
-1) Confirm you have PIP installed. PIP home page is here: https://pypi.python.org/pypi/pip
38 
-   Example install on a RHEL yum based machine
39 
-	sudo yum install python-pip
40 
-2) Install with pip
41 
-	sudo pip install s3cmd
42 
-
43 
-Installation from zip file
44 
-There are three options to run s3cmd from source tarball:
45 
-
46 
-1) The S3cmd program, as distributed in s3cmd-X.Y.Z.tar.gz
47 
-   on SourceForge or in master.zip on GitHub, can be run directly
48 
-   from where you unzipped the package.
49 
-
50 
-2) Or you may want to move "s3cmd" file and "S3" subdirectory
51 
-   to some other path. Make sure that "S3" subdirectory ends up
52 
-   in the same place where you move the "s3cmd" file.
53 
-
54 
-   For instance if you decide to move s3cmd to you $HOME/bin
55 
-   you will have $HOME/bin/s3cmd file and $HOME/bin/S3 directory
56 
-   with a number of support files.
57 
-
58 
-3) The cleanest and most recommended approach is to unzip the
59 
-   package and then just run:
60 
-
61 
-	python setup.py install
62 
-
63 
-   You will however need Python "distutils" module for this to
64 
-   work. It is often part of the core python package (e.g. in
65 
-   OpenSuse Python 2.5 package) or it can be installed using your
66 
-   package manager, e.g. in Debian use
67 
-
68 
-	apt-get install python-setuptools
69 
-
70 
-   Again, consult your distribution documentation on how to
71 
-   find out the actual package name and how to install it then.
72 
-
73 
-   Note that on Linux, if you are not "root" already, you may
74 
-   need to run:
75 
-
76 
-        sudo python setup.py install
77 
-
78 
-   instead.
79 
-
80 
-
81 
-Note to distributions package maintainers
82 
-Define shell environment variable S3CMD_PACKAGING=yes if you
83 
-don't want setup.py to install manpages and doc files. You'll
84 
-have to install them manually in your .spec or similar package
85 
-build scripts.
86 
-
87 
-On the other hand if you want setup.py to install manpages
88 
-and docs, but to other than default path, define env
89 
-variables $S3CMD_INSTPATH_MAN and $S3CMD_INSTPATH_DOC. Check
90 
-out setup.py for details and default values.
91 
-
92 
-
93 
-Where to get help
94 
-If in doubt, or if something doesn't work as expected,
95 
-get back to us via mailing list:
96 
-
97 
-	s3tools-general@lists.sourceforge.net
98 
-
99 
-or visit the S3cmd / S3tools homepage at:
100 
-
101 
-        http://s3tools.org
INSTALL.md
History View file @ 93746fb
102 1 
new file mode 100644
... ... 
@@ -0,0 +1,111 @@
0 
+Installation of s3cmd package
1 
+=============================
2 
+
3 
+Copyright:
4 
+    TGRMN Software and contributors
5 
+
6 
+S3tools / S3cmd project homepage:
7 
+    http://s3tools.org
8 
+
9 
+!!!
10 
+!!! Please consult README file for setup, usage and examples!
11 
+!!!
12 
+
13 
+Package formats
14 
+---------------
15 
+S3cmd is distributed in two formats:
16 
+
17 
+1) Prebuilt RPM file - should work on most RPM-based
18 
+   distributions
19 
+
20 
+2) Source .tar.gz package
21 
+
22 
+Installation of Brew package
23 
+---------------------------
24 
+
25 
+	brew install s3cmd
26 
+
27 
+Installation of RPM package
28 
+---------------------------
29 
+As user "root" run:
30 
+
31 
+	rpm -ivh s3cmd-X.Y.Z.noarch.rpm
32 
+
33 
+where X.Y.Z is the most recent s3cmd release version.
34 
+
35 
+You may be informed about missing dependencies
36 
+on Python or some libraries. Please consult your
37 
+distribution documentation on ways to solve the problem.
38 
+
39 
+Installation from PyPA (Python Package Authority)
40 
+---------------------
41 
+S3cmd can be installed from the PyPA using PIP (the recommended tool for PyPA).
42 
+
43 
+1) Confirm you have PIP installed. PIP home page is here: https://pypi.python.org/pypi/pip
44 
+   Example install on a RHEL yum based machine
45 
+	sudo yum install python-pip
46 
+2) Install with pip
47 
+	sudo pip install s3cmd
48 
+
49 
+Installation from zip file
50 
+--------------------------
51 
+There are three options to run s3cmd from source tarball:
52 
+
53 
+1) The S3cmd program, as distributed in s3cmd-X.Y.Z.tar.gz
54 
+   on SourceForge or in master.zip on GitHub, can be run directly
55 
+   from where you unzipped the package.
56 
+
57 
+2) Or you may want to move "s3cmd" file and "S3" subdirectory
58 
+   to some other path. Make sure that "S3" subdirectory ends up
59 
+   in the same place where you move the "s3cmd" file.
60 
+
61 
+   For instance if you decide to move s3cmd to you $HOME/bin
62 
+   you will have $HOME/bin/s3cmd file and $HOME/bin/S3 directory
63 
+   with a number of support files.
64 
+
65 
+3) The cleanest and most recommended approach is to unzip the
66 
+   package and then just run:
67 
+
68 
+	python setup.py install
69 
+
70 
+   You will however need Python "distutils" module for this to
71 
+   work. It is often part of the core python package (e.g. in
72 
+   OpenSuse Python 2.5 package) or it can be installed using your
73 
+   package manager, e.g. in Debian use
74 
+
75 
+	apt-get install python-setuptools
76 
+
77 
+   Again, consult your distribution documentation on how to
78 
+   find out the actual package name and how to install it then.
79 
+
80 
+   Note that on Linux, if you are not "root" already, you may
81 
+   need to run:
82 
+
83 
+        sudo python setup.py install
84 
+
85 
+   instead.
86 
+
87 
+
88 
+Note to distributions package maintainers
89 
+----------------------------------------
90 
+Define shell environment variable S3CMD_PACKAGING=yes if you
91 
+don't want setup.py to install manpages and doc files. You'll
92 
+have to install them manually in your .spec or similar package
93 
+build scripts.
94 
+
95 
+On the other hand if you want setup.py to install manpages
96 
+and docs, but to other than default path, define env
97 
+variables $S3CMD_INSTPATH_MAN and $S3CMD_INSTPATH_DOC. Check
98 
+out setup.py for details and default values.
99 
+
100 
+
101 
+Where to get help
102 
+-----------------
103 
+If in doubt, or if something doesn't work as expected,
104 
+get back to us via mailing list:
105 
+
106 
+	s3tools-general@lists.sourceforge.net
107 
+
108 
+or visit the S3cmd / S3tools homepage at:
109 
+
110 
+        http://s3tools.org