r1193 - in branches/1.0: . man

[des at projects.linpro.no]

Author: des
Date: 2006-10-18 16:27:26 +0200 (Wed, 18 Oct 2006)
New Revision: 1193

Modified:
   branches/1.0/
   branches/1.0/man/vcl.7
Log:
 r32907 at cat (orig r1155):  des | 2006-10-17 14:44:48 +0200
 Additional details about global variables.



Property changes on: branches/1.0
___________________________________________________________________
Name: svk:merge
   - d4fa192b-c00b-0410-8231-f00ffab90ce4:/trunk/varnish-cache:1154
   + d4fa192b-c00b-0410-8231-f00ffab90ce4:/trunk/varnish-cache:1155

Modified: branches/1.0/man/vcl.7
===================================================================
--- branches/1.0/man/vcl.7	2006-10-18 14:27:25 UTC (rev 1192)
+++ branches/1.0/man/vcl.7	2006-10-18 14:27:26 UTC (rev 1193)
@@ -165,10 +165,49 @@
 See the
 .Sx EXAMPLES
 section for a listing of the default code.
-.Ss Objects
+.Ss Variables
 Although subroutines take no arguments, the necessary information is
-made available to the handler subroutines through global objects.
-.\" Document these objects...
+made available to the handler subroutines through global variables.
+.Pp
+The following variables are available in backend declarations:
+.Bl -tag -width 4n
+.It Va backend.host
+Host name or IP address of a backend.
+.It Va backend.port
+Service name or port number of a backend.
+.El
+.Pp
+The following variables are available while processing a request:
+.Bl -tag -width 4n
+.It Va client.ip
+The client's IP address.
+.It Va req.request
+The request type (e.g. "GET", "HEAD").
+.It Va req.url
+The requested URL.
+.It Va req.proto
+The HTTP protocol version used by the client.
+.It Va req.backend
+The backend to use to service the request.
+.It Va req.http. Ns Ar header
+The corresponding
+.Ar header
+from the HTTP request.
+.El
+.Pp
+The following variables are available after the requested object has
+been retrieved from cache or from the backend:
+.Bl -tag -width 4n
+.It Va obj.valid
+True if the object was successfully retrieved.
+.It Va obj.cacheable
+True if the object is cacheable.
+.\" XXX what are the criteria?
+.It Va obj.ttl
+The object's time to live.
+.\" .It Va resp.http. Ns Ar header
+.\" XXX not implemented?
+.El
 .Sh EXAMPLES
 The following code is the equivalent of the default configuration with
 the backend address set to "backend.example.com" and no backend port