Release notes
[darcs-mirror-arbtt.git] / README.Win32
1 arbtt, the Automatic Rule-Based Time Tracker
2
3 (c) 2009-2015 Joachim Breitner <mail@joachim-breitner.de>
4
5 The Automatic Rule-Based Time Tracker is a desktop daemon that runs in the background and, every minute, records what windows are open on your desktop, what their titles are, which one is active. The accompanied statistics program lets you derive information from this log file, i.e.  what how much of your time have you been spending with e-Mail, or what projects are your largest time wasters. The mapping from the raw window titles to sensible "tags" is done by a configuration file with an powerful syntax.
6
7 At this point, arbtt does not have a graphical user interface. You will see no indication that arbtt-capture is running besides its entry in the task manager.  The statistics can be accessed using the arbtt-stats program from the command line.
8
9 If you expect unicode characters to appear in your reports, you likely want to run arbtt-stats and related tools with codepage 65001 (i.e. utf8) enabled.
10
11 Installation
12 ============
13
14 This installation will put the programs, documentation and example configuration on your computer. It makes sure that arbtt-capture is started after the installation and after the computer restarts. It also adds the arbtt program directory to the system PATH, so that you can use arbtt-stats from the windows command line.
15
16 The documentation and the file categorize.cfg can be found in the start menu.
17
18 You can uninstall arbtt using the provided uninstaller. Please terminate the arbtt-capture process before doing so, using the task manager, which you can start with Alt-Ctrl-Delete.
19
20 Third party components copyright notice
21 =======================================
22
23 arbtt ships with pcre3.dll from the PCRE library, copyright 1997-2006 University of Cambridge, governed under this license:
24
25 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
26
27     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
28
29     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
30
31     * Neither the name of the University of Cambridge nor the name of Google Inc. nor the names of their contributors may be used to endorse or promote products derived from this software without specific prior written permission.
32
33 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34
35 The arbtt installer uses the modpath.iss which is (c) 2007 Jared Breland <jbreland@legroom.net>.