TODO: A note on IPv6

[netgrind.git] / README

diff --git a/README b/README
index 4f4f45bf2f4ad60d10c264c7731b2a10c1253bba..5de268351a062ff70c1dc46817a5f90af9b7f64d 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-                                   This is NetGrind 1.0
+                                   This is NetGrind 1.1
 
                              (c) 2003 Martin Mares <mj@ucw.cz>
 
@@ -25,6 +25,10 @@ newly established TCP connection when no command-line switches are given. The ex
 in our source just connects HTTP analyser to all TCP connections to ports 80, 8080, 8081
 and 3128 and ignores the rest.
 
+You will also find a couple of postprocessing tools in the "post" directory.
+
+Thanks to Sun Microsystems Czech Republic for sponsoring the development of this project.
+
 
 TCP report syntax:
 ~~~~~~~~~~~~~~~~~~
@@ -47,32 +51,45 @@ HTTP report syntax:
 ~~~~~~~~~~~~~~~~~~~
 
 
-                                        data transmitted in both directions (excluding headers) ----+
-                                                                                                    |   response delay ---+
-                                                         transaction # on this connection ---+      |       [sec]         |
-                                                                                             |      |                     |   method and
-                                                                         cache status --+    |      |   duration [sec]    |   request URI
-                       source address:port   destination addr:port                      |    |      |         |           |    |
-                         |                     |                                        |    |      |         |           |    |
-2003-06-06 22:53:38.642 81.27.194.19:1175     205.217.153.53:80     123.123.123.123 200 ...   0    14030      0.957      0.444 GET http://...
-  |                                                                       |         |
-date and time of request start                                  X-Forwarded-For    HTTP response code or
-(if it's the first request on a connection,                                                ERR = HTTP violation
-it's the time where the connection was initiated,                                  CUT = connection closed before transaction finish
-even if the request has been transmitted later)                                            FIN = CONNECT request finished by connection close
-                                                                                   Txx = TCP error xx (see above)
+                                                 data transmitted in both directions (excluding headers) ----+
+                                                                                                             |   response delay ---+
+                                                                  transaction # on this connection ---+      |       [sec]         |
+global                                                                                                |      |                     |   method and
+transaction ID                                                                    cache status --+    |      |   duration [sec]    |   request URI
+  |                     source address:port   destination addr:port                              |    |      |         |           |    |
+  |                               |                     |                                        |    |      |         |           |    |
+000001 2003-06-06 22:53:38.642 81.27.194.19:1175     205.217.153.53:80     123.123.123.123 200 ....   0    14030      0.957      0.444 GET http://...
+         |                                                                         |         |
+       date and time of request start                                    X-Forwarded-For    HTTP response code or
+       (if it's the first request on a connection,                                          ERR = HTTP violation
+       it's the time where the connection was initiated,                                    CUT = connection closed before transaction finish
+       even if the request has been transmitted later)                                      FIN = CONNECT request finished by connection close
+                                                                                            Txx = TCP error xx (see above)
 
 Cache status codes:
 
        1st char: request cacheing control      . = none
-                                               N = don't cache
+       (first matching letter used)            N = don't cache
                                                R = revalidate
+                                               c = conditional request (If-Modified-Since, If-Match)
+
        2nd char: response cacheability         . = not restricted
        (first matching letter used)            N = don't cache
                                                P = private
                                                S = don't store to non-volatile storage
+                                               X = already expired
+                                               V = "Vary:" header present
                                                R = must be revalidated
-       3rd char: cache response                . = X-Cache not found
+                                               E = short expiration time (less than 5min)
+                                               L = long expiration time (5min or more)
+                                               lowercase version = but cached by a HTTP/1.0 cache
+
+       3rd char: response validator            . = none
+                                               E = ETag
+                                               W = weak ETag
+                                               L = Last-Modified
+
+       4th char: cache response                . = X-Cache not found
        (X-Cache header, optional)              - = MISS
                                                + = HIT
                                                ? = other