trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mlib...@apache.org
Subject svn commit: r835104 [3/3] - /incubator/trafficserver/site/trunk/docs/sdk/
Date Wed, 11 Nov 2009 22:27:39 GMT
Modified: incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html?rev=835104&r1=835103&r2=835104&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/GenerateLicenseKey.html Wed Nov 11 22:27:38
2009
@@ -1,43 +1,43 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Generating a License Key</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="prev" href="SetUpLicensing.html" title="Setting Up Licensing">
-<link rel="next" href="LoggingAPI.html" title="Guide to the Logging API">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="PluginManagement.html" title="Chapter 16. Plugin Management"
/>
+<link rel="prev" href="SetUpLicensing.html" title="Setting Up Licensing" />
+<link rel="next" href="LoggingAPI.html" title="Guide to the Logging API" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started"
/>
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations"
/>
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations"
/>
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management"
/>
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics"
/>
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference"
/>
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index"
/>
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script
type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript"
src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -45,7 +45,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software
Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software
Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -66,24 +66,25 @@
 <h3>
 <a name="id390849"></a>Running the gen_key tool</h3>
 <div class="orderedlist"><ol type="1">
-<li><p>On Unix, <code class="code">cd</code> to the <code class="filename">sdk/tools</code>
-          directory in your SDK package. On NT, open a DOS command window and
-          <code class="code">cd</code> to the <code class="filename">sdk/tools</code>
-          directory.</p></li>
 <li>
-<p>Enter the following:</p>
-<p><code class="code">gen_key plugin_name ID expiration</code></p>
+  <p>First, <code class="code">cd</code> to the <code class="filename">sdk/tools</code>
+      directory in your SDK package. </p></li>
+<li>
+<p>Then, enter the following:</p>
+<p><code class="code">gen_key <i>plugin_name</i> <i> ID</i>
<i> expiration</i></code></p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><code class="filename">* plugin_name</code> is the name of
the
-              plugin and it needs to match the name specified in
-              <code class="filename">plugin.db</code></p></li>
-<li><p><code class="code">ID</code> is a string of 5 alphanumeric
characters,
-              used to identify different customers</p></li>
 <li>
-<p><code class="code">expiration</code> is the expiration date of the
-              plugin in the following format:</p>
-<p><code class="code">mmddyyyy</code></p>
-<p>For example, <code class="code">03312001</code> for March 31, 2001.
Use
+  <p><code class="filename"><i>plugin_name </i></code> is the
name of the
+              plugin; it needs to match the name specified in
+            <code class="filename">plugin.db</code></p></li>
+<li>
+  <p><code class="code"><i>ID </i></code> is a string of 5
alphanumeric characters,
+            used to identify different customers</p></li>
+<li>
+<p><code class="code"><i>expiration </i></code> is the expiration
date of the
+              plugin in the following format:  
+<code class="code">mmddyyyy</code></p>
+<p>For example:  Enter <code class="code">03312001</code> for March 31,
2001. Use
               <code class="code">0</code> for no expiration.</p>
 </li>
 </ul></div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html?rev=835104&r1=835103&r2=835104&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/GetingStarted.html Wed Nov 11 22:27:38 2009
@@ -1,47 +1,47 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Chapter 1. Getting Started</title>
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css">
-<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css">
-<link rel="stylesheet" href="css/ydoc.css" type="text/css">
-<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
-<link rel="start" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="up" href="index.html" title="Traffic Server Software Developers Kit">
-<link rel="prev" href="Conventions.html" title="Typographical Conventions">
-<link rel="next" href="ASimplePlugin.html" title="A Simple Plugin">
-<link rel="preface" href="Preface.html" title="Preface">
-<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started">
-<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins">
-<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index">
-<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin">
-<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples">
-<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins">
-<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins">
-<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin">
-<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions">
-<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide">
-<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers">
-<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide">
-<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations">
-<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations">
-<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide">
-<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide">
-<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management">
-<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics">
-<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference">
-<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code">
-<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions">
-<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips">
-<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index">
-<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index">
-<link rel="index" href="ConceptIndex.html" title="Index">
-<link rel="section" href="GetingStarted.html#UnderstandingTSPlugins" title="Understanding
Traffic Server Plugins">
-<link rel="section" href="ASimplePlugin.html" title="A Simple Plugin">
-<link rel="section" href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and
Version Checking">
-<link rel="section" href="NamingConventions.html" title="Naming Conventions">
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/reset/reset-min.css"
type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/fonts/fonts-min.css"
type="text/css" />
+<link rel="stylesheet" href="http://yui.yahooapis.com/2.2.2/build/treeview/assets/tree.css"
type="text/css" />
+<link rel="stylesheet" href="css/ydoc.css" type="text/css" />
+<link rel="stylesheet" href="css/ydoc-chunk.css" type="text/css" />
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1" />
+<link rel="start" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="up" href="index.html" title="Traffic Server Software Developers Kit" />
+<link rel="prev" href="Conventions.html" title="Typographical Conventions" />
+<link rel="next" href="ASimplePlugin.html" title="A Simple Plugin" />
+<link rel="preface" href="Preface.html" title="Preface" />
+<link rel="chapter" href="GetingStarted.html" title="Chapter 1. Getting Started"
/>
+<link rel="chapter" href="CreatingTSPlugins.html" title="Chapter 2. How to Create
Traffic Server Plugins" />
+<link rel="index" href="CreatingTSPlugins.html#id372630" title="Index" />
+<link rel="chapter" href="ch03.html" title="Chapter 3. Remap Plugin" />
+<link rel="chapter" href="HeaderBasedPluginEx.html" title="Chapter 4. Header-Based
Plugin Examples" />
+<link rel="chapter" href="HTTPTransformationPlugins.html" title="Chapter 5. HTTP
Transformation Plugins" />
+<link rel="chapter" href="NewProtocolPlugins.html" title="Chapter 6. New Protocol
Plugins" />
+<link rel="chapter" href="ch07.html" title="Chapter 7. Cache Plugin" />
+<link rel="chapter" href="HTTPHooksAndTransactions.html" title="Chapter 8. HTTP
Hooks and Transactions" />
+<link rel="chapter" href="MiscellaneousInterfaceGuide.html" title="Chapter 9. Miscellaneous
Interface Guide" />
+<link rel="chapter" href="HTTPHeaders.html" title="Chapter 10. HTTP Headers" />
+<link rel="chapter" href="MutexGuide.html" title="Chapter 11. Mutex Guide" />
+<link rel="chapter" href="Continuations.html" title="Chapter 12. Continuations"
/>
+<link rel="chapter" href="PluginConfigurations.html" title="Chapter 13. Plugin Configurations"
/>
+<link rel="chapter" href="ActionsGuide.html" title="Chapter 14. Actions Guide" />
+<link rel="chapter" href="IOGuide.html" title="Chapter 15. IO Guide" />
+<link rel="chapter" href="PluginManagement.html" title="Chapter 16. Plugin Management"
/>
+<link rel="chapter" href="AddingStatistics.html" title="Chapter 17. Adding Statistics"
/>
+<link rel="chapter" href="FunctionReference.html" title="Chapter 18. Function Reference"
/>
+<link rel="appendix" href="App_SampleSourceCode.html" title="Appendix A. Sample
Source Code" />
+<link rel="appendix" href="App_DeprecatedFunctions.html" title="Appendix B. Deprecated
Functions" />
+<link rel="appendix" href="App_Troubleshooting.html" title="Appendix C. Troubleshooting
Tips" />
+<link rel="appendix" href="FunctionIndex.html" title="Appendix D. Function Index"
/>
+<link rel="appendix" href="TypeIndex.html" title="Appendix E. Type Index" />
+<link rel="index" href="ConceptIndex.html" title="Index" />
+<link rel="section" href="GetingStarted.html#UnderstandingTSPlugins" title="Understanding
Traffic Server Plugins" />
+<link rel="section" href="ASimplePlugin.html" title="A Simple Plugin" />
+<link rel="section" href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and
Version Checking" />
+<link rel="section" href="NamingConventions.html" title="Naming Conventions" />
 <script type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/yahoo/yahoo-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/event/event-min.js"></script><script
type="text/javascript" src="http://yui.yahooapis.com/2.2.2/build/treeview/treeview-min.js"></script><script
type="text/javascript" src="js/tocnodes.js"></script><script type="text/javascript"
src="js/toc.js"></script><script type="text/javascript">
     document.write("<style> div.toc {display: none} </style>"); 
   </script>
@@ -49,7 +49,7 @@
 <body>
 <div class="doctitle">
 <a href="index.html">Home</a>
-<img src="images/docbook/ts75.png"><h1 class="doctitle">Traffic Server Software
Developers Kit</h1>
+<img src="images/docbook/ts75.png" /><h1 class="doctitle">Traffic Server Software
Developers Kit</h1>
 </div>
 <div class="navheader">
 <div class="navprev">
@@ -79,7 +79,6 @@
 <dd><dl>
 <dt><span class="section"><a href="ASimplePlugin.html#Compiling_Unix">Unix
Example</a></span></dt>
 <dt><span class="section"><a href="ASimplePlugin.html#Compiling_HPUX">HPUX
Example</a></span></dt>
-<dt><span class="section"><a href="ASimplePlugin.html#Compiling_Windows">Compiling
for Windows NT</a></span></dt>
 </dl></dd>
 <dt><span class="section"><a href="Updatingplugin.configFile.html">Update
the <code class="filename">plugin.config</code> File</a></span></dt>
 <dt><span class="section"><a href="SpecifyingPluginLocation.html">Specify
the Plugin’s Location</a></span></dt>
@@ -93,16 +92,20 @@
     programming language, that customize the behavior of your Traffic Server
     installation. This chapter contains the following sections:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><a href="GetingStarted.html#UnderstandingTSPlugins" title="Understanding
Traffic Server Plugins">“Understanding Traffic Server Plugins”</a>—
a brief introduction
-        to plugins. For more details, see <a href="CreatingTSPlugins.html" title="Chapter 2. How
to Create Traffic Server Plugins">Chapter 2, <i>How to Create Traffic Server Plugins</i></a></p></li>
-<li><p><a href="ASimplePlugin.html" title="A Simple Plugin">“A Simple
Plugin”</a>— walks through compiling and
-        loading an example "hello world" plugin.</p></li>
-<li><p><a href="PlusingRegisAndVersionCkg.html" title="Plugin Registration
and Version Checking">“Plugin Registration and Version Checking”</a>—shows
you how to
+<li>
+  <p><a href="GetingStarted.html#UnderstandingTSPlugins" title="Understanding Traffic
Server Plugins">Understanding Traffic Server Plugins</a> — a brief introduction
+      to plugins. For more details, see <a href="CreatingTSPlugins.html" title="Chapter 2. How
to Create Traffic Server Plugins">How to Create Traffic Server Plugins</a></p></li>
+<li>
+  <p><a href="ASimplePlugin.html" title="A Simple Plugin">A Simple Plugin</a>
— walks through compiling and
+      loading an example <code>hello world</code> plugin.</p></li>
+<li>
+  <p><a href="PlusingRegisAndVersionCkg.html" title="Plugin Registration and Version
Checking">Plugin Registration and Version Checking</a> —shows you how to
         register your plugin and check that it's compatible with the version
         of Traffic Server you're using.</p></li>
-<li><p><a href="NamingConventions.html" title="Naming Conventions">“Naming
Conventions”</a>—outlines Traffic Server API
+<li>
+  <p><a href="NamingConventions.html" title="Naming Conventions">Naming Conventions</a>
—outlines Traffic Server API
         naming conventions. For guidelines on creating plugin source code, see
-        <a href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic
Server Plugins">Chapter 2, <i>How to Create Traffic Server Plugins</i></a>.</p></li>
+      <a href="CreatingTSPlugins.html" title="Chapter 2. How to Create Traffic Server
Plugins">How to Create Traffic Server Plugins</a>.</p></li>
 </ul></div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -122,11 +125,11 @@
         that Traffic Server loads when it is started. Your plugin contains
         callback functions that are registered for specific Traffic Server
         events. When Traffic Server needs to process an event, it invokes any
-        and all call-back functions you have registered for that event
+        and all call-back functions you've registered for that event
         type.</p>
 <div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0"
summary="Caution">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/docbook/caution.png"
/></td>
 <th align="left">Caution</th>
 </tr>
 <tr><td align="left" valign="top"><p>Since plugins add object code to Traffic
Server, programming
@@ -137,7 +140,7 @@
 </table></div>
 <div class="figure">
 <a name="Fig_PluginProcess"></a><p class="title"><b>Figure 1.1. Plugin
Process</b></p>
-<div class="mediaobject"><img src="images/plugin_process.jpg" alt="Plugin Process"></div>
+<div class="mediaobject"><img src="images/plugin_process.jpg" alt="Plugin Process"
/></div>
 </div>
 </div>
 <div class="section" lang="en">
@@ -152,54 +155,53 @@
 </ul></div>
 <p>Some examples of plugins include:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p>Blacklisting plugin: denies attempts to access web sites
-            that are off-limits.</p></li>
-<li><p>Append transform plugin: adds text to HTTP response
-            content.</p></li>
-<li><p>Image conversion plugin: transforms JPEG images to GIF
-            images.</p></li>
-<li><p>Compression plugin: sends response content to a compression
+<li><p><b>Blacklisting plugin</b>: denies attempts to access web
sites
+          that are off-limits.</p></li>
+<li><p><b>Append transform plugin</b>: adds text to HTTP response
+          content.</p></li>
+<li><p><b>Image conversion plugin</b>: transforms JPEG images to
GIF
+          images.</p></li>
+<li><p><b>Compression plugin</b>: sends response content to a compression
             server that compresses the data (alternatively, a compression
             library local to the Traffic Server host machine could do the
-            compression).</p></li>
-<li><p>Authorization plugin: checks user’s permissions to access
+          compression).</p></li>
+<li><p><b>Authorization plugin</b>: checks user’s permissions
to access
             particular web sites. The plugin could consult a local
             authorization program or send queries to an authorization
-            server.</p></li>
-<li><p>A plugin that gathers client information from request
-            headers and enters this information in a database.</p></li>
-<li><p>Protocol plugin: listens for specific protocol requests on a
+          server.</p></li>
+<li><p>A <b>plugin that gathers client information</b> from request
+          headers and enters this information in a database.</p></li>
+<li><p><b>Protocol plugin</b>: listens for specific protocol requests
on a
             designated port, and then uses Traffic Server’s proxy server &amp;
-            cache to serve client requests.</p></li>
+          cache to serve client requests.</p></li>
 </ul></div>
-<p><a href="GetingStarted.html#Fig_PossibleTSPlugins" title="Figure 1.2. Possible
Traffic Server Plugins">Figure 1.2, “Possible Traffic Server Plugins”</a>
illustrates several
-        types of plugins:</p>
+<p>The figure below, <a href="GetingStarted.html#Fig_PossibleTSPlugins" title="Figure 1.2. Possible
Traffic Server Plugins">“Possible Traffic Server Plugins”</a>, illustrates
several
+        types of plugins.</p>
 <div class="figure">
 <a name="Fig_PossibleTSPlugins"></a><p class="title"><b>Figure 1.2. Possible
Traffic Server Plugins</b></p>
-<div class="mediaobject"><img src="images/Uses.jpg" alt="Possible Traffic Server
Plugins"></div>
+<div class="mediaobject"><img src="images/Uses.jpg" alt="Possible Traffic Server
Plugins" /></div>
 </div>
-<p>You can find basic examples of several plugins in the sample
-        code provided with the SDK:</p>
+<p>You can find basic examples for many plugins in the SDK sample
+        code:</p>
 <div class="itemizedlist"><ul type="disc">
-<li><p><code class="filename">append-transform.c</code> adds text
from a
-            specified file to HTTP/text responses. This plugin is explained in
-            detail in <a href="AppendTransformPlugin.html" title="The Append-Transform
Plugin">“The Append-Transform Plugin”</a>.</p></li>
-<li><p>The compression plugin in the figure communicates with a
+<li>
+  <p><code class="filename">append-transform.c</code> adds text from a
+            specified file to HTTP/text responses. This plugin is explained in <a href="AppendTransformPlugin.html"
title="The Append-Transform Plugin">“ The Append-Transform Plugin”</a>.</p></li>
+<li>
+  <p>The compression plugin in the figure communicates with the
             server that actually does the compression. The
             <code class="filename">server-transform.c</code> plugin shows how
to open a
             connection to a transformation server, have the server do the
-            transformation, and send transformed data back to the client. In
-            <code class="filename">server-transform.c</code>, the transformation
is
-            null, but a compression or image translation plugin could be
-            implemented in a similar way.</p></li>
+            transformation, and send transformed data back to the client. Although the transformation
is null in 
+            <code class="filename">server-transform.c</code>,  a compression
or image translation plugin could be
+          implemented in a similar way.</p></li>
 <li><p><code class="filename">basic-auth.c</code> performs basic
HTTP proxy
             authorization.</p></li>
-<li><p><code class="filename">blacklist-1.c</code> reads blacklisted
servers
+<li>
+  <p><code class="filename">blacklist-1.c</code> reads blacklisted servers
             from a configuration file and denies client access to these
-            servers. The plugin has a configuration interface where the
-            Traffic Server administrator can modify the list of blacklisted
-            servers through the Traffic Manager GUI. This plugin is explained
-            in detail in <a href="BlacklistPlugin.html" title="The Blacklist Plugin">“The
Blacklist Plugin”</a> .</p></li>
+            servers. This plugin is explained
+             in <a href="BlacklistPlugin.html" title="The Blacklist Plugin">“The
Blacklist Plugin”</a> .</p></li>
 </ul></div>
 </div>
 <div class="section" lang="en">
@@ -207,19 +209,19 @@
 <a name="PluginLoading"></a>Plugin Loading</h3></div></div></div>
 <p>When Traffic Server is first started, it consults the
         <code class="filename">plugin.config</code> file to determine the names
of all
-        the shared plugin libraries that need to be loaded. The
+         shared plugin libraries that need to be loaded. The
         <code class="filename">plugin.config</code> file also defines arguments
that
         are to be passed to each plugin’s initialization function,
         <code class="function">INKPluginInit</code>. The
         <code class="filename">records.config</code> file defines the path to
each
-        plugin shared library, described in <a href="SpecifyingPluginLocation.html" title="Specify
the Plugin’s Location">“Specify the Plugin’s Location”</a>.</p>
+        plugin shared library, as described in <a href="SpecifyingPluginLocation.html"
title="Specify the Plugin’s Location">“Specify the Plugin’s Location”</a>.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0"
summary="Note">
 <tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/docbook/note.png"
/></td>
 <th align="left">Note</th>
 </tr>
 <tr><td align="left" valign="top"><p>The path for each of these files is
-          <code class="filename"><code class="varname">&lt;root_dir&gt;</code>/config/</code>,
+          <code class="filename"><code class="varname">&lt;<i>root_dir</i>&gt;</code>/config/</code>,
           where <code class="varname">&lt;root_dir&gt;</code> is where
you installed
           Traffic Server.</p></td></tr>
 </table></div>
@@ -239,28 +241,24 @@
         command; each line in <code class="filename">plugin.config</code> cannot
exceed
         1023 characters.</p>
 <p>The first plugin configuration is for a plugin named
-        <code class="filename">my-plugin.so</code>; it contains three arguments
that
+        <code class="filename">my-plugin.so</code>. It contains three arguments
that
         are to be passed to that plugin’s initialization routine. The second
         configuration is for a plugin named
-        <code class="filename">some-plugin.so</code> which contains three arguments.
+        <code class="filename">some-plugin.so</code>; it contains three arguments.
         The last argument, <em class="parameter"><code>$proxy.config.http.cache.on</code></em>,
         is actually a configuration variable. Traffic Server will look up the
         specified configuration variable and substitute its value.</p>
-<p>On the Windows version of Traffic Server, the plugin shared
-        library file is a <code class="filename">.dll</code> file. An example
line in
-        <code class="filename">plugin.config</code> would be the following:</p>
-<pre class="programlisting">nt_plugin.dll</pre>
 <p><a name="MultipleEntries_SamePlugin"></a>Plugins with global
         variables should not appear more than once in
         <code class="filename">plugin.config</code>. For example, if you enter:</p>
 <pre class="programlisting">add-header.so header1
 add-header.so header2</pre>
-<p>then the second global variable, header2, would be used for both
+<p>then the second global variable, <code>header2</code>, will be used
for both
         instances. A simple workaround is to give different names to different
         instances of the same plugin. For example:</p>
 <pre class="programlisting">cp add-header.so add-header1.so
 cp add-header.so add-header2.so</pre>
-<p>The following entries would have the desired result
+<p>These entries will produce the desired result
         below:</p>
 <pre class="programlisting">add-header1.so header1
 add-header2.so header2</pre>
@@ -281,8 +279,7 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="PluginInitialization"></a>Plugin Initialization</h3></div></div></div>
 <p>Each plugin must define an initialization function named
-        <code class="function">INKPluginInit</code> that Traffic Server invokes
at the
-        time the plugin is loaded. The <code class="function">INKPluginInit</code>
+        <code class="function">INKPluginInit</code> that Traffic Server invokes
when the plugin is loaded. The <code class="function">INKPluginInit</code>
         function is commonly used to read configuration information and
         register hooks for event notification.</p>
 <p>The <code class="function">INKPluginInit</code> function has two



Mime
View raw message