diff options
Diffstat (limited to 'doc/binlogsel.1')
-rw-r--r-- | doc/binlogsel.1 | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/doc/binlogsel.1 b/doc/binlogsel.1 index eb7bc3a..8c6dfd2 100644 --- a/doc/binlogsel.1 +++ b/doc/binlogsel.1 @@ -13,11 +13,11 @@ .\" .\" 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 BINLOGSEL 1 "October 18, 2013" "BINLOGSEL" "User Reference" +.TH BINLOGSEL 1 "October 19, 2013" "BINLOGSEL" "User Reference" .SH NAME binlogsel \- select records from binary logs .SH SYNOPSIS -\fBbinlogsel\fR [\fB\-dnv\fR] [\fB\-D\fR \fIDIR\fR]\ +\fBbinlogsel\fR [\fB\-dnv\fR] [\fB\-D\fR \fIDIR\fR] [\fB\-i \fIN\fR]\ [\fB\-p\fR \fIPATTERN\fR]\ [\fB\-t\fR \fIFORMAT\fR] [\fB\-I\fR \fITAG\fR] [\fB\-F\fR \fITIME\fR] [\fB\-T\fR \fITIME\fR]\ @@ -28,8 +28,10 @@ binlogsel \- select records from binary logs \fBbinlogsel\fR [\fB\-hV\fR] .SH DESCRIPTION .B Binlosel -selects from the binary logs the records that fall within the given -time interval. The interval is specified using the +scans binary logs created by +.BR vmod\-binlog (3) +module and selects from them the records that were created within the given +time intervals. A time interval is specified using the .BI \-F " FROMTIME" and .BI \-T " TOTIME" @@ -46,7 +48,7 @@ is omitted, the starting time is set to the time of the earliest available log file. Finally, if neither of options is used, all records will be output. In this case, the operation is equivalent to that of the -.B binlogcat +.BR binlogcat (1) command. .PP The argument to either option is a mostly free format human readable @@ -62,15 +64,15 @@ in If the .B info program and coreutils documentation are properly installed at your site, use -the following command: +the following command to view it: .PP .EX .B info coreutils 'Date input formats' .EE .PP Several time intervals can be specified, provided that each of them is -preceded by the \fB\-I\fR option, which introduces the tag to mark -records falling within the time interval that follows it. This tag is +preceded by the \fB\-I\fR option, which introduces the tag to identify +the records pertaining to that interval. This tag is output before each record. For example: .PP .EX @@ -84,7 +86,9 @@ records added within the last 2 days, which are prefixed by the string .PP The log files are searched in the directory specified with the \fB\-D\fR command line option. The \fB\-i\fR option can be used to -define directory indexing level. +define directory indexing level. See +.BR vmod\-binlog (3), +for a description of the underlying directory structure. .PP If files are listed in the command line, the .BR \-D , @@ -97,26 +101,25 @@ The default action of .B binlogsel is to print matching records on the standard output. This can be changed by the use of loadable modules. A module is a dynamic library -that is loaded at program startup and provides functions for handling +which is loaded at program startup and provides functions for handling records in a specific way. .PP The module to be loaded is supplied with the \fB\-m\fR option. For example, the option \fB-m modname\fR instructs .B binlogsel to load library \fBmodname.so\fR. Additional arguments for the module -initialization function can be supplied in the same option: +initialization function can be supplied in the same option (note quoting): +.PP .EX .B binlogsel -m 'modname -n arg' .EE .PP -(note quoting). -.PP The module to be loaded is searched in the library path, which consists initially of the single directory \fI$prefix\fR\fB/lib/vmod\-binlog\fR. This path can be modified using the .BI \-L " DIR" -option, which adds \fIDIR\fR to its and, or by the +option, which adds \fIDIR\fR to its end, or by the .BI \-P " DIR" option, which inserts its argument immediately before the default library directory. @@ -186,6 +189,9 @@ below, the symbols looks for are listed without this prefix. Thus, for example, if the module name is \fBstats.so\fR, the name of the module initialization function must be \fBstats_LTX_init\fR. +.PP +.B Binlogsel +expects modules to export the following functions: .TP .BI "void init(char *" param ", void (*" addfn ")(const char *, const char *, const char *));" .B [OPTIONAL] |