changeset 14:1bf3aae7803e

Updated gelfload's README.
author Gregor Richards <Richards@codu.org>
date Mon, 14 Dec 2009 16:08:12 -0500
parents a5825771cac3
children d30b0a07f3e1
files gelfload/README
diffstat 1 files changed, 19 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/gelfload/README	Mon Dec 14 16:01:46 2009 -0500
+++ b/gelfload/README	Mon Dec 14 16:08:12 2009 -0500
@@ -1,2 +1,20 @@
-This is elfload, a portable runtime ELF loader. It lets you use ELF on
+This is gelfload, a portable runtime ELF loader. It lets you use ELF on
 platforms that don't natively support ELF!
+
+Some special properties of gelfload:
+
+ * To integrate gelfload well into platforms that /do/ support ELF, gelfload
+   ELF files should have their interpreter set to /usr/bin/gelfload-ld
+
+ * gelfload ELF files may refer to gelfload .so files by their standard name,
+   or they may use symbolic names to refer to host libraries:
+   * libhost_<name> refers to the library <name> on the host, e.g.
+     libhost_libc.so.6 or libhost_msvcrt.dll
+   * libhost_.so refers to libc or its nearest equivalent
+   * libloader_dl.0 refers to the loader's builtin library providing dlopen()
+     and dlsym()
+
+gelfload is still in development, and doesn't yet support all ELF relocations.
+Some tests are in test/. They're tested primarily on GNU/Linux, however the
+test named testdl uses only standard libc functions and should work on any host
+system (including e.g. Mac OS X).