arbtt-stats

arbtt-stats
Prev	Program references	Next

Name

arbtt-stats — generate statistics from the arbtt data samples

Synopsis

arbtt-stats [OPTION...]

Description

arbtt-stats reads the samples that were recorded so far by arbtt-capture from the log file, filters them according to the users specifications and generates one or more reports from the data.

When run without any options, --total-time is assumed.

The order in which filters (--exclude, --only, --also-inactive and --filter) and reports are passed to the program is irrelevant: All filters given on the command line are active for all reports.

Options

-h, -?, --help: shows a short summary of the available options, and exists.
-V, --version: shows the version number, and exists.

Filtering options

-x TAG, --exclude TAG: Ignore any data samples that have been assigned this tag. Can be given more than once.
-o TAG, --only TAB: Ignore any data samples that have not been assigned this tag. Can be given more than once.
--also-inactive: by default, arbtt-stats ignores any samples which have been assigned the tag inactive. This flag disables this behaviour.
-f CONDITION, --filter CONDITION: Only consider samples matching the given condition, which follows the same syntax as in categorize.cfg (Nonterminal Cond in Figure 1, “The formal grammar of categorize.cfg”).

Report options

-m PERCENTAGE, --min-percentage PERCENTAGE: In the reports, any tag which occurs rarer than the given percentage is ignored. The default value is 1.

Reports

-i, --information: Various bits of information about the recorded data, such as total time recorded, number of records etc. In this report, “time recorded” is the sum of all samples, including inactive and those that are disabled by the filter, while “time selected” is the sum of the samples that are matched by the given filters.
-t, --total-time: For all tag, print the part of the selected time with this tag applied to, both as an absolute value and a percentage of the selected time.
-c CATEGORY, --category CATEGORY: For the given category, give the textual equivalent of a pie chart: For each possible value of the category, including one for “no tag of this category present”, give the absolute time and fraction. Entries which are not displayed because of the option --min-percentage are aggregated.
--each-category: This is just a shortcut for a series of --category options, one for each category found in the data.

Examples

Some useful examples of what you can do with arbtt-stats are provided here:

# 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 '$sampleage < 1:00'

Files

~/.arbtt/capture.log: binary file, storing the arbtt data samples
~/.arbtt/categorize.cfg: specification of the arbtt categorizer syntax. A detailed description is given in the section called “Configuring the arbtt categorizer”