diff options
author | Tom Ryder <tom@sanctum.geek.nz> | 2012-05-29 17:47:23 +1200 |
---|---|---|
committer | Tom Ryder <tom@sanctum.geek.nz> | 2012-05-29 17:47:23 +1200 |
commit | 0d76c0f8d8bb876938318668a0cd7d495b4cb32f (patch) | |
tree | 97bcdbfeeaec09627d08fd40dec0ebb1fd993359 | |
parent | Add README with summary of what I expect of this (diff) | |
download | clubber-0d76c0f8d8bb876938318668a0cd7d495b4cb32f.tar.gz clubber-0d76c0f8d8bb876938318668a0cd7d495b4cb32f.zip |
Update README with requirements and better paths
-rw-r--r-- | README.markdown | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/README.markdown b/README.markdown index 99cee34..0ace976 100644 --- a/README.markdown +++ b/README.markdown @@ -2,8 +2,9 @@ Clubber ======= Clubber is a Perl script to make forming `chroot` environments less of a task -that makes you want to cry and kill yourself. It requires `ldd`, and should be -run interactively as `root`, *never* as an automated or unattended task. +that makes you want to cry and kill yourself. It requires `ldd` and `md5sum`, +and should be run interactively as `root`, *never* as an automated or +unattended task. Usage ----- @@ -12,26 +13,26 @@ Run with one or more binaries as parameters and no other options, `clubber` will run `ldd` over each, converge the list of libraries used by all of them, and print them to `stdout`. - # clubber php + # clubber /usr/bin/php Run with the `--chroot=PATH` option, pointing to an existing directory intended as the root of a `chroot` jail, `clubber` will also create required library paths if they do not exist and copy the libraries into that environment if they do not yet exist, or if they differ from the host system libraries. - # clubber --chroot=/chroot/apache php + # clubber --chroot=/chroot/apache /usr/bin/php Run with both the `--chroot=PATH` and `--dry` options, `clubber` will perform a "dry run" of the `chroot` library import, writing the commands it would execute on `stdout`. - # clubber --chroot=/chroot/apache --dry php + # clubber --chroot=/chroot/apache --dry /usr/bin/php Run with both the `--chroot=PATH` and `--verify` options, Clubber will check all of the libraries expected for the program are in place within the `chroot` environment, and will report any discrepancies. - # clubber --chroot=/chroot/apache --verify php + # clubber --chroot=/chroot/apache --verify /usr/bin/php License ------- |