'\" t .\" Title: arbtt-stats .\" Author: Joachim Breitner .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 06/19/2020 .\" Manual: Program references .\" Source: arbtt manual .\" Language: English .\" .TH "ARBTT\-STATS" "1" "06/19/2020" "arbtt manual" "Program references" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" arbtt-stats \- generate statistics from the arbtt data samples .SH "SYNOPSIS" .HP \w'\fBarbtt\-stats\fR\ 'u \fBarbtt\-stats\fR [OPTION...] .SH "DESCRIPTION" .PP \fBarbtt\-stats\fR reads the samples that were recorded so far by \fBarbtt\-capture\fR from the log file, filters them according to the users specifications and generates one or more reports from the data\&. .PP When run without any options, \fB\-\-total\-time\fR is assumed\&. .PP The order in which filters (\fB\-\-exclude\fR, \fB\-\-only\fR, \fB\-\-also\-inactive\fR and \fB\-\-filter\fR) and reports are passed to the program is irrelevant: All filters given on the command line are active for all reports\&. .SH "OPTIONS" .PP \fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR .RS 4 shows a short summary of the available options, and exists\&. .RE .PP \fB\-V\fR, \fB\-\-version\fR .RS 4 shows the version number, and exists\&. .RE .PP \fB\-\-logfile\fR \fIFILE\fR .RS 4 logfile to use instead of ~/\&.arbtt/capture\&.log .RE .PP \fB\-\-categorizefile\fR .RS 4 categorize file to use instead of ~/\&.arbtt/categorize\&.cfg .RE .SS "Filtering options" .PP \fB\-x\fR \fITAG\fR, \fB\-\-exclude\fR \fITAG\fR .RS 4 Ignore any data samples that have been assigned this tag or category\&. To distinguish tags and categories, the latter have to be entered followed by a colon\&. Can be given more than once\&. .RE .PP \fB\-o\fR \fITAG\fR, \fB\-\-only\fR \fITAG\fR .RS 4 Ignore any data samples that have not been assigned this tag\&. To distinguish tags and categories, the latter have to be entered followed by a colon\&. Can be given more than once\&. .RE .PP \fB\-\-also\-inactive\fR .RS 4 by default, \fBarbtt\-stats\fR ignores any samples which have been assigned the tag inactive\&. This flag disables this behaviour\&. .RE .PP \fB\-f\fR \fICONDITION\fR, \fB\-\-filter\fR \fICONDITION\fR .RS 4 Only consider samples matching the given condition, which follows the same syntax as in categorize\&.cfg (Nonterminal Cond in the formal grammar specification found in the user guide)\&. .RE .SS "Report options" .PP \fB\-m\fR \fIPERCENTAGE\fR, \fB\-\-min\-percentage\fR \fIPERCENTAGE\fR .RS 4 Ignore tags whose percentage is less than the value specified here\&. Default percentage: 1%\&. .RE .PP \fB\-\-output\-exclude\fR \fITAG\fR .RS 4 Skip this tag or category when printing statistics\&. Only affects the reports \fB\-\-total\-time\fR and \fB\-\-category\fR\&. To distinguish tags and categories, the latter have to be entered followed by a colon\&. Can be given more than once\&. .RE .PP \fB\-\-output\-only\fR \fITAG\fR .RS 4 Prints statistics only for the specified tag or category\&. Only affects the reports \fB\-\-total\-time\fR and \fB\-\-category\fR\&. To distinguish tags and categories, the latter have to be entered followed by a colon\&. Can be given more than once\&. .RE .PP \fB\-\-output\-format\fR \fIFORMAT\fR .RS 4 Specify the report output format, may be one of: text, csv (comma\-separated values), tsv (TAB\-separated values)\&. Default format: text\&. .RE .SS "Reports" .PP \fB\-i\fR, \fB\-\-information\fR .RS 4 Various bits of information about the recorded data, such as total time recorded, number of records etc\&. In this report, \(lqtime recorded\(rq is the sum of \fIall\fR samples, including inactive and those that are disabled by the filter, while \(lqtime selected\(rq is the sum of the samples that are matched by the given filters\&. .RE .PP \fB\-t\fR, \fB\-\-total\-time\fR .RS 4 For all tags, print the part of the selected time with this tag applied to, both as an absolute value and a percentage of the selected time\&. .RE .PP \fB\-c\fR \fICATEGORY\fR, \fB\-\-category\fR \fICATEGORY\fR .RS 4 For the given category, give the textual equivalent of a pie chart: For each possible value of the category, including one for \(lqno tag of this category present\(rq, give the absolute time and fraction\&. Entries which are not displayed because of the option \fB\-\-min\-percentage\fR are aggregated\&. .RE .PP \fB\-\-each\-category\fR .RS 4 This is just a shortcut for a series of \fB\-\-category\fR options, one for each category found in the data\&. .RE .PP \fB\-\-intervals\fR [\fITAG\fR|\fICATEGORY\fR:] .RS 4 This report lists all periods of consecutive time intervals where the given tag has been applied to, or where the given category has the same value\&. .sp To distinguish tags and categories, the latter have to be entered followed by a colon\&. .sp This report will give wrong results if an activity has been carried out at the end of a session and right at the beginning, as the intermediate time is thought to be part of the interval\&. Inactive times while \fBarbtt\-capture\fR is running will separate the results as expected\&. .RE .PP \fB\-\-for\-each\fR \fIPERIOD\fR .RS 4 This is not a report of its own, but causes the selected report to be executed for each of the given PERIOD (which can be minute, hour,day, month or year) where there exist selected samples\&. All the reports will then be printed one after another or, in the case of CSV output, with an additional column\&. .sp Note that if this option is enabled, samples that are filtered out are completely ignored (to avoid empty reports for periods with only filtered samples)\&. Therefore, the \fB\-\-information\fR report will print the numbers for the samples selected also for the totals\&. .RE .SH "EXAMPLES" .PP Some useful examples of what you can do with \fBarbtt\-stats\fR are provided here: .sp .if n \{\ .RS 4 .\} .nf # Only consider the time when I was programming in Haskell arbtt\-stats \-o Editing\-Haskell # Tell me what evolution folders I spend my time in when I actually do # work with e\-Mail arbtt\-stats \-o Program:evolution \-c Evo\-Folder # Generate statistics about the last hour arbtt\-stats \-f \*(Aq$sampleage < 1:00\*(Aq .fi .if n \{\ .RE .\} .SH "FILES" .PP ~/\&.arbtt/capture\&.log .RS 4 binary file, storing the arbtt data samples .RE .PP ~/\&.arbtt/categorize\&.cfg .RS 4 specification of the arbtt categorizer syntax\&. A detailed description is given in the section called \(lqConfiguring the arbtt categorizer (arbtt-stats)\(rq .RE .SH "SEE ALSO" .PP See the arbtt manual for more information and the \m[blue]\fBarbtt hackage page\fR\m[]\&\s-2\u[1]\d\s+2 for newer versions of arbtt\&. .SH "AUTHORS" .PP \fBJoachim Breitner\fR <\&mail@joachim-breitner.de\&> .RS 4 Main author of arbtt .RE .PP \fBSergey Astanin\fR <\&s.astanin@gmail.com\&> .RS 4 Contributor .RE .PP \fBMartin Kiefel\fR <\&mk@nopw.de\&> .RS 4 Contributor .RE .PP \fBMuharem Hrnjadovic\fR <\&muharem@linux.com\&> .RS 4 Contributor .RE .PP \fBMarkus Hauck\fR <\&markus1189@gmail.com\&> .RS 4 Contributor .RE .PP \fBThomasz Miąsko\fR <\&tomasz.miasko@gmail.com\&> .RS 4 Contributor .RE .PP \fBWaldir Pimenta\fR <\&waldyrious@gmail.com\&> .RS 4 Documentation writer .RE .PP \fBGwern Branwen\fR <\&gwern@gwern.net\&> .RS 4 Documentation writer .RE .PP \fBPaolo G. Giarrusso\fR <\&p.giarrusso@gmail.com\&> .RS 4 Contributor .RE .PP \fBMichal J. Gajda\fR <\&migamake@migamake.com\&> .RS 4 Contributor .RE .SH "NOTES" .IP " 1." 4 arbtt hackage page .RS 4 \%http://hackage.haskell.org/package/arbtt .RE