From fe16e2953af1a826b443a44a2344304abec0c2bc Mon Sep 17 00:00:00 2001 From: Tom Scavo Date: Tue, 2 May 2017 11:42:16 -0400 Subject: [PATCH] Fix inline code formatting --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aeee1f2..defc694 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A library of re-usable bash scripts ## Installation -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 @@ -41,9 +41,9 @@ saml_tools.sh ## Overview -### ``cget.sh`` +### `cget.sh` -Bash script ``cget.sh`` retrieves and caches HTTP resources on disk. A previously cached resource is retrieved via HTTP Conditional GET [RFC 7232]. If the web server responds with HTTP 200 OK, the resource is cached and written to stdout. If the web server responds with 304 Not Modified, the cached resource is output instead. +Bash script `cget.sh` retrieves and caches HTTP resources on disk. A previously cached resource is retrieved via HTTP Conditional GET [RFC 7232]. If the web server responds with HTTP 200 OK, the resource is cached and written to stdout. If the web server responds with 304 Not Modified, the cached resource is output instead. First let's configure logging. For convenience, we will log directly to the terminal: @@ -51,7 +51,7 @@ First let's configure logging. For convenience, we will log directly to the term $ export LOG_FILE=/dev/tty ``` -The system defaults to INFO logging, which corresponds to ``LOG_LEVEL=3``. We make that explicit as follows: +The system defaults to INFO logging, which corresponds to `LOG_LEVEL=3`. We make that explicit as follows: ```Shell $ export LOG_LEVEL=3 @@ -89,7 +89,7 @@ Content-Length: 43765172 Content-Type: application/samlmetadata+xml ``` -Assuming the resource doesn't change on the server, subsequent requests will return the cached resource. To bypass the network altogether, use the ``-C`` option: +Assuming the resource doesn't change on the server, subsequent requests will return the cached resource. To bypass the network altogether, use the `-C` option: ```Shell $ $BIN_DIR/cget.sh -C $url1 | wc -c @@ -98,7 +98,7 @@ $ $BIN_DIR/cget.sh -C $url1 | wc -c 43765172 ``` -Of course the ``-C`` option will fail if the resource is not cached: +Of course the `-C` option will fail if the resource is not cached: ```Shell # illustrate "quiet failure mode" @@ -109,7 +109,7 @@ $ echo $? 1 ``` -OTOH, the ``-F`` option forces the return of a fresh resource from the server. If the resource is cached and unchanged on the server (304), such a request will fail, however: +OTOH, the `-F` option forces the return of a fresh resource from the server. If the resource is cached and unchanged on the server (304), such a request will fail, however: ```Shell # further illustrate "quiet failure mode" @@ -121,7 +121,7 @@ $ echo $? 1 ``` -The ``-F`` option will work on the other URL, however: +The `-F` option will work on the other URL, however: ```Shell $ $BIN_DIR/cget.sh -F $url2 > /dev/null