diff options
Diffstat (limited to 'doc/vmod-binlog.3')
-rw-r--r-- | doc/vmod-binlog.3 | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/vmod-binlog.3 b/doc/vmod-binlog.3 index 7578615..f5f978d 100644 --- a/doc/vmod-binlog.3 +++ b/doc/vmod-binlog.3 @@ -13,7 +13,7 @@ .\" .\" You should have received a copy of the GNU General Public License .\" along with vmod-binlog. If not, see <http://www.gnu.org/licenses/>. -.TH VMOD-BINLOG 1 "October 18, 2013" "VMOD-BINLOG" "User Reference" +.TH VMOD-BINLOG 1 "October 19, 2013" "VMOD-BINLOG" "User Reference" .SH NAME vmod\-binlog \- binary log file support for Varnish Cache. .SH SYNOPSIS @@ -78,7 +78,7 @@ Binary logs can be viewed using the and .BR binlogsel (3) utilities. -.PP +.SH FUNCTIONS Binary log support is initialized by a call to .B binlog.init function (normally it is done in @@ -87,7 +87,8 @@ function (normally it is done in The .B dir argument specifies the top-level storage directory. The -.B format argument defines the format of logfile entries. It is +.B format +argument defines the format of logfile entries. It is a simplified form of Perl .B pack() template. See the @@ -104,7 +105,7 @@ Set debugging level. .TP \fBpattern\fR=\fISTRING\fR Sets pattern to use for log file names, instead of the default. -Argument can contain +The argument can contain .BR strftime (3) conversion specifiers. The default is @@ -119,13 +120,12 @@ Sets directory indexing scheme to use. Allowed values are \fB0\fR, \fBsize\fR=\fISIZE\fR Sets maximum size of a single binary log. Any records not fitting into \fISIZE\fR will be discarded. \fISIZE\fR can be followed by -one of the usual size suffixes: \fBK\R, \fBM\fR, \fBG\fR (or their +one of the usual size suffixes: \fBK\fR, \fBM\fR, \fBG\fR (or their lower-case equivalents), standing for kilobytes, megabytes and gigabytes, correspondingly. Logs are mapped into memory, so -the \fISIZE\fR is limited by the amount of memory that can be mapped. -See +the \fISIZE\fR is limited. See .BR mmap (2), for the details. @@ -135,7 +135,7 @@ The default value is 1G. Sets log rotation interval, in seconds. The default is 86400. .TP \fBumask\fR=\fIONUM\fR -Sets umask for creating new log files. Argument is an octal value. +Sets umask for creating new log files (a three-digit octal value). The default is \fB077\fR. .TP \fBroundts\fR=\fIBOOL\fR @@ -180,9 +180,11 @@ binlog.pack(http.req.url); binlog.commit(); .EE .SH FORMAT -Data format specification consists of a series of template letters +Data format specification consists of a series of conversion +specifiers, optionally separated by any amount of whitespace. +A conversion specifier consists of a template letter optionally followed by numeric repeat count (which may be enclosed in -square brackets). +square brackets). .PP The valid template letters are: .TP |