summaryrefslogtreecommitdiff
path: root/standalone/linux/README
diff options
context:
space:
mode:
Diffstat (limited to 'standalone/linux/README')
-rw-r--r--standalone/linux/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/standalone/linux/README b/standalone/linux/README
new file mode 100644
index 000000000..18983fd7a
--- /dev/null
+++ b/standalone/linux/README
@@ -0,0 +1,25 @@
+You can put this directory into your PATH, and use git-annex the same
+as if you'd installed it using a package manager.
+
+Or, you can use the runshell script in this directory to start a shell
+that is configured to use git-annex and the other utilities included in
+this bundle, including git, gpg, rsync, ssh, etc.
+
+This should work on any Linux system of the appropriate architecture.
+More or less. There are no external dependencies, except for glibc.
+Any recent-ish version of glibc should work (2.13 is ok; so is 2.11).
+
+
+How it works: This directory tree contains a lot of libraries and programs
+that git-annex needs. But it's not a chroot. Instead, runshell sets PATH
+and LD_LIBRARY_PATH to point to the stuff in here.
+
+The glibc libs are not included. Instead, it runs with the host system's
+glibc. We trust that glibc's excellent backwards and forward compatability
+is good enough to run binaries that were linked for a newer or older
+version. Of course, this could fail. Particularly if the binaries try to
+use some new glibc feature. But hopefully not.
+
+Why not bundle glibc too? I've not gotten it to work! The host system's
+ld-linux.so will be used for sure, as that's hardcoded into the binaries.
+When I tried including libraries from glibc in here, everything segfaulted.