From 458ec1830fba3269b5d9facbdcbef78008030c12 Mon Sep 17 00:00:00 2001 From: Tom Scavo Date: Mon, 8 May 2017 12:36:03 -0400 Subject: [PATCH 1/2] Add two scripts to the list outpput --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 33ed43a..ff2b0e6 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ An installation directory will be created if one doesn't already exist. In any c ```Shell $ ls -1 $BIN_DIR http_xsltproc.sh +process_export_aggregate.sh +process_main_aggregate.sh $ ls -1 $LIB_DIR list_all_IdP_DisplayNames_csv.xsl From c8818063b79c51146a32f957692cae4d55bfc988 Mon Sep 17 00:00:00 2001 From: Tom Scavo Date: Mon, 8 May 2017 12:38:15 -0400 Subject: [PATCH 2/2] Remove redundant backquotes from examples --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ff2b0e6..d1cdb7f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ XSLT transformations of SAML metadata The scripts in this repository depend on a [Bash Library](https://github.internet2.edu/InCommon/bash-library) of basic scripts. Download and install the latter before continuing. -Download the source, change directory to the source directory, and install the source into ``/tmp`` as follows: +Download the source, change directory to the source directory, and install the source into `/tmp` as follows: ```Shell $ export BIN_DIR=/tmp/bin @@ -43,13 +43,13 @@ security_contacts_summary_local_json.xsl ## Overview -Bash script ``http_xsltproc.sh`` is a wrapper around the ``xsltproc`` command-line tool. Unlike ``xsltproc``, the ``http_xsltproc.sh`` script fetches the target XML document from an HTTP server using HTTP Conditional GET [RFC 7232]. If the server responds with 200, the script caches the resource and returns the response body. If the server responds with 304, the script returns the cached resource instead. See the inline help file for details: +Bash script `http_xsltproc.sh` is a wrapper around the `xsltproc` command-line tool. Unlike `xsltproc`, the `http_xsltproc.sh` script fetches the target XML document from an HTTP server using HTTP Conditional GET [RFC 7232]. If the server responds with 200, the script caches the resource and returns the response body. If the server responds with 304, the script returns the cached resource instead. See the inline help file for details: ```Shell $ $BIN_DIR/http_xsltproc.sh -h ``` -The ``http_xsltproc.sh`` script requires two environment variables. ``CACHE_DIR`` is the absolute path to the cache directory (which may or may not exist) whereas ``LIB_DIR`` specifies a directory containing various helper scripts. +The `http_xsltproc.sh` script requires two environment variables. `CACHE_DIR` is the absolute path to the cache directory (which may or may not exist) whereas `LIB_DIR` specifies a directory containing various helper scripts. For example, let's use the library installed in the previous section and specify the cache as follows: @@ -89,7 +89,7 @@ resource_dir=/home/htdocs/www.incommonfederation.org/federation/metadata/ /bin/mv $resource_file $resource_dir ``` -Observe that the command ``http_xsltproc.sh -F`` forces a fresh SAML metadata file. If the server responds with ``304 Not Modified``, the process terminates without updating the resource file. +Observe that the command `http_xsltproc.sh -F` forces a fresh SAML metadata file. If the server responds with `304 Not Modified`, the process terminates without updating the resource file. ### Example #2 @@ -133,7 +133,7 @@ resource_dir=/home/htdocs/www.incommonfederation.org/federation/metadata/ /bin/mv $resource1_file $resource2_file $resource_dir ``` -Observe the commands ``http_xsltproc.sh -F`` and ``http_xsltproc.sh -C``. The former forces a fresh SAML metadata file as in the previous example; the latter goes directly to cache. If file is not in the cache (which is highly unlikely), the process terminates without updating any resource files. +Observe the commands `http_xsltproc.sh -F` and `http_xsltproc.sh -C`. The former forces a fresh SAML metadata file as in the previous example; the latter goes directly to cache. If file is not in the cache (which is highly unlikely), the process terminates without updating any resource files. ### Example #3 @@ -177,7 +177,7 @@ resource_dir=/home/htdocs/www.incommonfederation.org/federation/metadata/ /bin/mv $resource1_file $resource2_file $resource_dir ``` -The commands ``http_xsltproc.sh -F`` and ``http_xsltproc.sh -C`` behave exactly as described in the previous example. +The commands `http_xsltproc.sh -F` and `http_xsltproc.sh -C` behave exactly as described in the previous example. ## Compatibility