Docs: Emphasize variables and paths consistently in README
authorBen Shum <bshum@biblio.org>
Mon, 4 May 2015 21:01:23 +0000 (17:01 -0400)
committerBen Shum <bshum@biblio.org>
Mon, 4 May 2015 21:03:14 +0000 (17:03 -0400)
Some variables and paths were not emphasized when the instructions for
websockets was added. Maintain consistency in the document and emphasize
them.

Signed-off-by: Ben Shum <bshum@biblio.org>
README

diff --git a/README b/README
index 9da4cfd..4e1675f 100644 (file)
--- a/README
+++ b/README
@@ -365,7 +365,7 @@ apxs2 -i -a -c mod_websocket.c
 ---------------------------------------------------------------------------
 +
 3. Create the websocket Apache instance (more information about this in 
 ---------------------------------------------------------------------------
 +
 3. Create the websocket Apache instance (more information about this in 
-   /usr/share/doc/apache2/README.multiple-instances)
+   `/usr/share/doc/apache2/README.multiple-instances`)
 +
 .(Debian / Ubuntu Precise)
 [source, bash]
 +
 .(Debian / Ubuntu Precise)
 [source, bash]
@@ -400,7 +400,7 @@ cp examples/apache2/websockets/apache2.conf /etc/apache2-websockets/
 cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/
 ---------------------------------------------------------------------------
 +
 cp examples/apache_24/websockets/apache2.conf /etc/apache2-websockets/
 ---------------------------------------------------------------------------
 +
-6. OPTIONAL: add these configuration variables to /etc/apache2-websockets/envvars
+6. OPTIONAL: add these configuration variables to `/etc/apache2-websockets/envvars`
    and adjust as needed.
 +
 [source, bash]
    and adjust as needed.
 +
 [source, bash]
@@ -412,18 +412,18 @@ export OSRF_WEBSOCKET_CONFIG_CTXT=gateway
 export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600
 ---------------------------------------------------------------------------
 +
 export OSRF_WEBSOCKET_MAX_REQUEST_WAIT_TIME=600
 ---------------------------------------------------------------------------
 +
-  * IDLE_TIMEOUT specifies how long we will allow a client to stay connected
+  * `IDLE_TIMEOUT` specifies how long we will allow a client to stay connected
     while idle.  A longer timeout means less network traffic (from fewer
     websocket CONNECT calls), but it also means more Apache processes are
     tied up doing nothing.
     while idle.  A longer timeout means less network traffic (from fewer
     websocket CONNECT calls), but it also means more Apache processes are
     tied up doing nothing.
-  * IDLE_CHECK_INTERVAL specifies how often we wake to check the idle status
+  * `IDLE_CHECK_INTERVAL` specifies how often we wake to check the idle status
     of the connected client.
     of the connected client.
-  * MAX_REQUEST_WAIT_TIME is the maximum amount of time the gateway will
+  * `MAX_REQUEST_WAIT_TIME` is the maximum amount of time the gateway will
     wait before declaring a client as idle when there is a long-running
     outstanding request, yet no other activity is occurring.  This is
     primarily a fail-safe to allow idle timeouts when one or more requests
     died on the server, and thus no response was ever delivered to the gateway.
     wait before declaring a client as idle when there is a long-running
     outstanding request, yet no other activity is occurring.  This is
     primarily a fail-safe to allow idle timeouts when one or more requests
     died on the server, and thus no response was ever delivered to the gateway.
-  * CONFIG_FILE / CTXT are the standard opensrf core config options.
+  * `CONFIG_FILE / CTXT` are the standard opensrf core config options.
 
 7. Before you can start websockets, you must install a valid SSL certificate 
    in `/etc/apache2/ssl/`.  It is possible, but not recommended, to generate a 
 
 7. Before you can start websockets, you must install a valid SSL certificate 
    in `/etc/apache2/ssl/`.  It is possible, but not recommended, to generate a