summary refs log tree commit homepage
diff options
authorEric Wong <>2009-09-02 18:40:02 -0700
committerEric Wong <>2009-09-02 18:40:02 -0700
commit5fd5bb6aa884ec8f2c62a5edaae6b93ec8275f2e (patch)
parent3bc7000a34c8e1788a5951381c7007f617233da2 (diff)
* link to Clogger::Format when talking about predefined formats
* use upper-case for escape chars since that's what we use
* clarify $request_time{PRECISION} range
1 files changed, 4 insertions, 3 deletions
diff --git a/README.txt b/README.txt
index 7f042ee..707b851 100644
--- a/README.txt
+++ b/README.txt
@@ -14,13 +14,14 @@ is customizable so you can specify exactly which fields to log.
 * pre-defines Apache Common Log Format, Apache Combined Log Format and
   Rack::CommonLogger (as distributed by Rack 1.0) formats.
+  See Clogger::Format for the predefined formats.
 * Untrusted values are escaped (all HTTP headers, request URI components)
   to make life easier for HTTP log parsers. The following bytes are escaped:
     ' (single quote)
     " (double quote)
-    all bytes in the range of \x00-\x1f
+    all bytes in the range of \x00-\x1F
@@ -58,8 +59,8 @@ somewhere inside the " do |config|" block:
   ($request_method $request_uri $http_version)
 * $request_time, $request_time{PRECISION} - time taken for request
   (including response body iteration).  PRECISION defaults to 3
-  (milliseconds) if not specified but may be specified 0(seconds) to
-  6(microseconds).
+  (milliseconds) if not specified but may be specified anywhere from
+  0(seconds) to 6(microseconds).
 * $time_local, $time_local{FORMAT} - current local time, FORMAT defaults to
   "%d/%b/%Y:%H:%M:%S %z" but accepts any strftime(3)-compatible format
 * $time_utc, $time_utc{FORMAT} - like $time_local, except with UTC