diff --git a/README.md b/README.md index 559859c..e1a6fc1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # Lumberjack In its simplest form, lumberjack is a pipe logger for Apache HTTPd (and other daemons). -Lumberjack can be used as the logger for piped logfiles using the HTTPd `CustomLog` directive - processing each log line and writing it out to the correct - per `VirtualHost` - log file. It may also be used by other daemons capable of writing log files to a pipe, or via a FIFO. +Lumberjack can be used as the logger for piped log files using the HTTPd `CustomLog` directive - processing each log line and writing it out to the correct - per `VirtualHost` - log file. It may also be used by other daemons capable of writing log files to a pipe, or via a FIFO. In contrast to having one logger process per `VirtualHost` (or a hard coded log file for each `VirtualHost`, as is the norm), lumberjack can be set as the pipe logger in the global section of the *httpd.conf* file, and - with an appropriate `LogFormat` specifier - will split off each log line for a different `VirtualHost` and write it to a per `VirtualHost` log file based upon a user defined template. Lumberjack may also be used in 'raw' mode in combination with the HTTPd `ErrorLog` directive to log errors, either on a per server or per `VirtualHost` basis to a log file based upon a user supplied template. -### Main features +### Additional features * Automatic log file compression (using a user specifiable compressor) after log files are rotated. * Request flushing/syncing of log files after each write (though this is not recommended). * Reading of log lines from a FIFO rather than stdin - allowing use with other daemons such as ftpd and rsyncd. @@ -19,7 +19,10 @@ Lumberjack may also be used in 'raw' mode in combination with the HTTPd `ErrorLo ----- ## Command line and templates -There are two mandatory arguments when using lumberjack; the base directory of the log file path (``) and the template of the log file name (`