Add Nginx default log format to FORMATS.

[apachelog.git] / apachelog / __init__.py

diff --git a/apachelog/__init__.py b/apachelog/__init__.py
index c4c1ef7f7e780e03e020661aff9bcba31c4d5213..e1772da0d6e518b4a47d55cf1970d4e520d57655 100644 (file)
--- a/apachelog/__init__.py
+++ b/apachelog/__init__.py
@@ -55,8 +55,8 @@ directive in the format string.
 You can also re-map the field names by subclassing (or clobbering) the
 alias method.
 
-This module provides three of the most common log formats in the
-formats dictionary;
+This module provides some common log formats in the ``FORMATS``
+dictionary;
 
 >>> # Common Log Format (CLF)
 >>> p = apachelog.parser.Parser(apachelog.parser.FORMATS['common'])
@@ -64,6 +64,8 @@ formats dictionary;
 >>> p = apachelog.parser.Parser(apachelog.parser.FORMATS['vhcommon'])
 >>> # NCSA extended/combined log format
 >>> p = apachelog.parser.Parser(apachelog.parser.FORMATS['extended'])
+>>> # Nginx log format (extended + "$gzip_ratio")
+>>> p = apachelog.parser.Parser(apachelog.parser.FORMATS['nginx'])
 
 For some older notes regarding performance while reading lines from a
 file in Python, see `this post`__ by Fredrik Lundh.  Further