[2/2] git commit: update docs for background fetch exclude config file

[su...@apache.org]

update docs for background fetch exclude config file


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/5483d382
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/5483d382
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/5483d382

Branch: refs/heads/master
Commit: 5483d382cf6785e44e2a7a5011aace1cdcec3657
Parents: a15ddb4
Author: Sudheer Vinukonda <su...@yahoo-inc.com>
Authored: Fri Oct 31 02:39:13 2014 +0000
Committer: Sudheer Vinukonda <su...@yahoo-inc.com>
Committed: Fri Oct 31 02:39:13 2014 +0000

----------------------------------------------------------------------
 doc/reference/plugins/background_fetch.en.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/5483d382/doc/reference/plugins/background_fetch.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/background_fetch.en.rst b/doc/reference/plugins/background_fetch.en.rst
index e078d17..40ffaa5 100644
--- a/doc/reference/plugins/background_fetch.en.rst
+++ b/doc/reference/plugins/background_fetch.en.rst
@@ -32,16 +32,17 @@ Using the plugin
 
 This plugin functions as either a global or per remap plugin, and 
 it takes an optional argument for specifying a config file with exclusion 
-criteria.
+criteria. The config file can be specified both via an absolute path or
+via a relative path to the install dir
 
 To activate the plugin in global mode, in :file:`plugin.config`, simply add::
 
-  background_fetch.so --config <relative-path-to-install-dir/config-file>
+  background_fetch.so --config <config-file>
 
 To activate the plugin in per remap mode, in :file:`remap.config`, simply append the
 below to the specific remap line::
 
-  @plugin=background_fetch.so @pparam=<relative-path-to-install-dir/config-file>
+  @plugin=background_fetch.so @pparam=<config-file>
 
 Note that the config file argument with exclusion is optional
 
@@ -69,24 +70,24 @@ accidentally put pressure on the origin servers.
 
 The plugin now supports a config file that can specify exclusion of background
 fetch based on the below criteria:
-1. Client-Ip
+1. Client-IP
 2. Content-Type
 3. User-Agent
 
 To specify the exclusion criteria, the plugin needs to be activated as below:
 
-background_fetch.so --config <relative-path-to-install-dir/config-file>
+background_fetch.so --exclude <config-file>
 
 The contents of the config-file could be as below:
 
-Client-Ip 127.0.0.1
+Client-IP 127.0.0.1
 User-Agent ABCDEF
 Content-Type text
 
 The plugin also now supports per remap activation. To activate the plugin for
 a given remap, add the below on the remap line:
 
-@plugin=background_fetch.so @pparam=<relative-path-to-install-dir/config-file>
+@plugin=background_fetch.so @pparam=<config-file>
 
 Future additions
 ----------------