From e945268eeec434872487783703fbff6ccd3c86dd Mon Sep 17 00:00:00 2001 From: Tom Scavo <trscavo@internet2.edu> Date: Sat, 10 Jun 2017 22:02:33 -0400 Subject: [PATCH] Add Environment section --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4117de8..cfef3c4 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,18 @@ md_tools.sh saml_tools.sh ``` +## Environment + +Besides `BIN_DIR` and `LIB_DIR` above, the following environment variables are required: + +| Variable | | +| --- | --- | +| `CACHE_DIR` | A persistent HTTP cache | +| `TMPDIR` | A temporary directory | +| `LOG_FILE` | A persistent log file | + +Some OSes define `TMPDIR` and some do not. In any case, a temporary directory is required to use these scripts. + ## Overview ### `cget.sh`