1. s3cmd
  2. Commit c3bc0a8c4f2997905ffaf5f0237a65baa321b427
Browse code

Added more documentation.

git-svn-id: https://s3tools.svn.sourceforge.net/svnroot/s3tools/s3cmd/trunk@82 830e0280-6d2a-0410-9c65-932aecc39d9d

Michal Ludvig authored on 2007/02/19 12:20:20
Showing 3 changed files
INSTALL
History View file @ c3bc0a8
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,84 @@
0 
+Installation of s3cmd package
1 
+=============================
2 
+
3 
+Author:
4 
+    Michal Ludvig <michal@logix.cz>
5 
+
6 
+S3tools / S3cmd project homepage:
7 
+    http://s3tools.sourceforge.net
8 
+
9 
+Amazon S3 homepage:
10 
+    http://aws.amazon.com/s3
11 
+
12 
+!!!
13 
+!!! Please consult README file for setup, usage and examples!
14 
+!!!
15 
+
16 
+Package formats
17 
+---------------
18 
+S3cmd is distributed in two formats:
19 
+1) Prebuilt RPM file - should work on most RPM-based
20 
+   distributions
21 
+2) Source .tar.gz package
22 
+
23 
+
24 
+
25 
+Installation of RPM package
26 
+---------------------------
27 
+As user "root" run:
28 
+
29 
+	rpm -ivh s3cmd-X.Y.Z.noarch.rpm
30 
+
31 
+where X.Y.Z is the most recent s3cmd release version.
32 
+
33 
+You may be informed about missing dependencies
34 
+on Python or some libraries. Please consult your
35 
+distribution documentation on ways to solve the problem.
36 
+
37 
+
38 
+Installation of source .tar.gz package
39 
+--------------------------------------
40 
+There are three options to run s3cmd from source tarball:
41 
+
42 
+1) S3cmd program as distributed in s3cmd-X.Y.Z.tar.gz
43 
+   can be run directly from where you untar'ed the package.
44 
+
45 
+2) Or you may want to move "s3cmd" file and "S3" subdirectory
46 
+   to some other path. Make sure that "S3" subdirectory ends up
47 
+   in the same place where you move the "s3cmd" file.
48 
+
49 
+   For instance if you decide to move s3cmd to you $HOME/bin
50 
+   you will have $HOME/bin/s3cmd file and $HOME/bin/S3 directory
51 
+   with a number of support files.
52 
+
53 
+3) The cleanest and most recommended approach is to run
54 
+
55 
+	python setup.py install
56 
+
57 
+   You will however need Python "distutils" module for this to
58 
+   work. It is often part of the core python package (e.g. in
59 
+   OpenSuse Python 2.5 package) or it can be installed using your
60 
+   package manager, e.g. in Debian use
61 
+
62 
+	apt-get install python2.4-setuptools
63 
+
64 
+   Again, consult your distribution documentation on how to
65 
+   find out the actual package name and how to install it then.
66 
+
67 
+
68 
+Where to get help
69 
+-----------------
70 
+If in doubt, or if something doesn't work as expected,
71 
+get back to us via mailing list:
72 
+
73 
+	s3tools-general@lists.sourceforge.net
74 
+
75 
+For more information refer to:
76 
+* S3cmd / S3tools homepage at http://s3tools.sourceforge.net
77 
+
78 
+Enjoy!
79 
+
80 
+Michal Ludvig
81 
+* michal@logix.cz
82 
+* http://www.logix.cz/michal
83 
+
README
History View file @ c3bc0a8
... ... 
@@ -7,9 +7,16 @@ Author:
7 7 
 S3tools / S3cmd project homepage:
8 8 
     http://s3tools.sourceforge.net
9 9
10 
+S3tools / S3cmd mailing list:
11 
+    s3tools-general@lists.sourceforge.net
12 
+
10 13 
 Amazon S3 homepage:
11 14 
     http://aws.amazon.com/s3
12 15
16 
+!!!
17 
+!!! Please consult INSTALL file for installation instructions!
18 
+!!!
19 
+
13 20 
 What is Amazon S3
14 21 
 -----------------
15 22 
 Amazon S3 provides a managed internet-accessible storage
setup.py
History View file @ c3bc0a8
... ... 
@@ -11,7 +11,7 @@ setup(name = "s3cmd",
11 11 
 	version = "0.9.1",
12 12 
 	packages = [ 'S3' ],
13 13 
 	scripts = ['s3cmd'],
14 
-	data_files = [ ("share/s3cmd", [ "README" ]), ],
14 
+	data_files = [ ("share/s3cmd", [ "README", "INSTALL", "NEWS" ]), ],
15 15
16 16 
 	## Packaging details
17 17 
 	author = "Michal Ludvig",