Blob Blame History Raw
--- curr-1.0.9/doc/bltk.1	1970-01-01 01:00:00.000000000 +0100
+++ curr-1.0.9-1/doc/bltk.1	2009-07-21 14:17:29.191118317 +0200
@@ -0,0 +1,313 @@
+.TH BLTK 1 "15 July 2008" "BLTK" "Battery life tool kit"
+.SH NAME
+bltk \- tool kit is used to measure battery life and performance under
+different workloads on Linux.
+.SH SYNOPSIS
+.B bltk
+[\-hVvaNAcCBXswiIRDPGOYZyQzxul] [\-t sec] [\-r results_dir]
+[\-m {0,1}] [\-U path] [\-g setup] [\-J pid] [\-T time]
+[\-F file] [\-W app] [\-L title] [\-K comment] [\-e app]
+[\-E app] [\-p percent] [\-d percent] [\-o {0,1,2}] [\-q file]
+[\-b percent] [\-f command] [\-k num]
+.SH DESCRIPTION
+\fBThe BLTK\fR can be used with various workloads to simulate different types of laptop usage.  The following workloads are currently implemented:
+.RS
+.TP
+\fBIdle workload\fR
+collect statistics only (mostly used to measure battery life)
+.TP
+\fBDeveloper workload\fR
+simulates code development in Linux environment
+.TP
+\fBReader workload\fR
+simulates text reading on laptop (mostly used to measure battery life)
+.TP
+\fBPlayback workload\fR
+simulates laptop entertaining usage (produces constant average load on the system)
+.TP
+\fB3d game workload\fR
+simulates 3D-gaming on laptop (Unreal Tournament demo is used to create this workload)
+.TP
+\fBOffice Activity workload\fR
+simulates laptop usage for different office activities (based on OpenOffice.org office suit)
+.RE
+.PP
+When started, test collects platform/OS initial info and if it's OK prompts
+user to unplug AC adapter. After cable unplugged, workload started. During the
+workload execution test harness collects various system information (e.g.
+CPU load, battery drain, display state, CPU frequency, etc...). After battery
+completely discharged user should plug the AC cable back and boot the system.
+When it is done the results are available.
+.PP
+There are several tools for result evaluation. They allow creating report file
+for test run, to gather results into a table for system comparison, and
+to draw graphs for different purposes.
+.PP
+\fBResults\fR \- after the battery dies and the system booted back, the results are
+available. They are stored in 'bltk/<wokload_name>.results' directory (or in the directory, specified in \-r option). If target directory already exist the tool
+will add numeric extension to its name (.001, .002 e.t.c.) The results consist of the
+following files (see below for detailed description):
+.TP
+.B cmd
+In this file 'bltk' command with arguments are stored
+.TP
+.B infoi<N>.log (info1.log, info2.log, ...)
+Here initial system info is stored. Another two files (info1.log,
+info2.log) contains system info after AC adapter was unplugged, and on 5%
+battery capacity remained. They are used to check whether any changes occurred
+during test execution.
+.TP
+.B stat.log
+Statistics generated by bltk harness are stored here. One statistic line generated per 1 minute (or per number of seconds, specified in -t option).
+.TP
+.B system<N>
+When -k 1 is used, the system information is stored under this directory. The numbers at the end of directory name have the following meanings:
+.RS
+.TP
+.B 0
+initial system info 
+.TP
+.B 1
+system info after AC adapter was unplugged
+.TP
+.B 2
+system info on 5% battery capacity remained
+.RE
+.TP
+.B version
+this file contains version information
+.TP
+.B workload
+the file contains info about workload
+.TP
+.B work_out.log
+.TP
+.B err.log
+There are stored any error messages
+.TP
+.B warning.log
+Contains warnings
+.TP
+.B work.log
+Strings generated by USR1, USR2 signals from workload. String format is the same as in the 'stat.log' file.
+.TP
+.B fail
+when test fails
+.TP
+.B score
+.TP
+.B Report
+.TP
+.B Report.table
+.SH OPTIONS
+.TP
+.BR "\-h" , " \--help"
+Help; display a help message and then exits.
+.TP
+.BR "\-V", " \--version"
+Version; display version number and then exits.
+.TP
+.BR "\-v", " \--verbose"
+Verbose
+.TP
+.BR "\-a", " \--ac-ignore"
+ignore ac adapter state check (on/off)
+.TP
+.BR "\-N", " \--time-stat-ignore"
+disable time statistics
+.TP
+.BR "\-A", " \--ac-stat-ignore"
+disable ac adapter statistics
+.TP
+.BR "\-c", " \--cpu-stat-ignore"
+disable cpu load statistics
+.TP
+.BR "\-C", " \--cpu-add-stat-ignore"
+disable cpu additional statistics
+.TP
+.BR "\-B", " \--bat-stat-ignore"
+disable battery statistics
+.TP
+.BR "\-X", " \--disp-stat-ignore"
+Disable display state statistics
+.TP
+.BR "\-H", " \--hd-stat-ignore"
+disable hard drive state statistics
+.TP
+.BR "\-t " seconds, " \--report-time " seconds
+frequency of report line generation in seconds
+.TP
+.BR "\-r " results_dir, " \--results " results_dir
+name of results directory
+.TP
+.BR "\-s", " \--stat-ignore"
+disable all statistics
+.TP
+.BR "\-w", " \--work-stat-ignore"
+disable workload statistics
+.TP
+.BR "\-m " {0,1}, " \--stat-memory " {0,1}
+dump statistics directly on disk or keep in memory, if statistics are kept in memory, it will be dumped	on disk at low battery capacity, or at the test end
+.RS
+.TP
+.B 0
+disk
+.TP
+.B 1
+memory (by default)
+.RE
+.TP
+.BR "\-i", " \--idle-test"
+idle test
+.TP
+.BR "\-I", " \--idle"
+idle workload
+.TP
+.BR "\-R", " \--reader"
+reader workload
+.TP
+.BR "\-D", " \--developer"
+developer workload
+.TP
+.BR "\-P", ' \--player"
+playback workload
+.TP
+.BR "\-G", " \--game"
+3D-gaming workload
+.TP
+.BR "\-O", " \--office"
+office productivity workload
+.TP
+.BR "\-U " path, " \--user " path
+user-specified workload (path to executable)
+.TP
+.BR "\-g " routine, " \--user-init " routine"
+setup routines for user-specified workload
+.TP
+.BR "\-Y", " \--discharging"
+battery discharge mode
+.TP
+.BR "\-Z", " \--charging"
+battery charge mode
+.TP
+.BR "\-J " pid, " \--jobs " pid
+make jobs number
+.TP
+.BR "\-T " seconds, " \--time " seconds
+workload time
+.TP
+.BR "\-F", " \--file"
+workload file
+.TP
+.BR "\-W", " \--prog"
+workload program
+	name of player (player workload, default 'mplayer')
+	name of web-browser (reader workload, default 'firefox')
+.TP
+.BR "\-L", " \--title"
+title of web-browser document
+.TP
+.BR "\-M", " \--manufacturer"
+enable time and cpu load statistics only
+.TP
+.BR "\-S", " \--show"
+demo/debug mode, one iteration only
+.TP
+.BR "\-n", " \--show-num"
+demo/debug mode, 'show-num' iteration
+.TP
+.BR "\-j", " \--show-cnt"
+demo/debug mode, 'show-cnt' sub iteration
+.TP
+.BR "\-T " seconds, " \--show-time " seconds
+demo/debug mode, debug time
+.TP
+.BR "\-K " comment, " \--comment " comment
+user comment for report
+.TP
+.BR "\-e " application, " \--init-prog " application
+run program before test starting
+.TP
+.BR "\-E " application, " \--init-prog-su " application
+run program as root before test starting
+.TP
+.BR "\-y", " \--yes"
+auto 'yes' answer to all questions
+.TP
+.BR "\-Q", " \--debug"
+debug workload (see cpu-load and disp-load below)
+.TP
+.BR "\-p " percent, " \--cpu-load " percent
+debug workload, the time cpu loaded in percent
+.TP
+.BR "\-d " percent, " \--disp-load " percent
+Debug workload, the time display on in percent
+.TP
+.BR "\-o " {0,1,2}, " \--output " {0,1,2}
+direct workload output:
+.RS
+.TP
+.B 0
+file
+.TP
+.B 1
+file and console
+.TP
+.B 2
+/dev/null, other - console
+.RE
+.TP
+.BR "\-z", " \--debug-vars"
+debug option
+.TP
+.BR "\-q " file, " \--debug-vars-file " file
+debug option - debug variables file
+.TP
+.BR "\-x", " \--dpms"
+debug option - try to use display power management
+.TP
+.BR "\-u", " \--spy"
+debug option - try to find out unexpected system activity
+.TP
+.BR "\-l", " \--simul-laptop"
+debug option, laptop simulation
+.TP
+.BR "\-b " percent, " \--bat-sync " percent
+debug option, battery critical capacity, default 5%
+.TP
+.BR "\-f " command, " \--user-field " command
+the output of user-specified command being added to statistics
+Example:
+	-f "cat /proc/acpi/thermal_zone/TZ01/temperature | awk '{print \$2}'"
+.TP
+.BR "\-k " num, " \--stat-system " num
+debug option, save system files, default 0
+.SH EXAMPLES
+.TP
+bltk -I or --idle
+idle workload running
+.TP
+bltk -R or --reader
+reader workload running
+.TP
+bltk -D or --developer
+developer workload running
+.TP
+bltk -O or --office
+office workload running
+.TP
+bltk -P or --player
+player workload running
+.TP
+bltk -G or --game
+game workload running
+.TP
+bltk -i or --idle-test -T 60 -t 1
+idle test running for 60 seconds, stats interval 1 second
+.SH SEE ALSO
+\fBbltk.conf\fR(5), \fBbltk_report\fR(1)
+.SH AUTHOR
+.nf
+Konstantin Karasyov   <konstantin.a.karasyov@intel.com>
+Vladimir Lebedev      <vladimir.p.lebedev@intel.com>
+.fi
--- curr-1.0.9/doc/bltk_report.1	1970-01-01 01:00:00.000000000 +0100
+++ curr-1.0.9-1/doc/bltk_report.1	2009-07-21 15:31:40.943332988 +0200
@@ -0,0 +1,167 @@
+.TH BLTK_REPORT 1 "15 July 2008" "BLTK_REPORT" 
+.SH NAME
+bltk_report \- automated report creation
+bltk_report_table \- summary table creation from several results folders
+bltk_plot \- graph drawing
+.SH SYNOPSIS
+.B bltk_report
+[\-hdofI013EiS] [\-r ] [\-s ] [\-b ] [\-c ]
+[\-U ] [\-B ] [\-D ] [\-C ] [\-P ] [\-K ] [\-R ]
+[\-2 ] [\-4 ] directory...
+.PP
+.B
+bltk_report_table
+[\-hdstfuEe13SR] [\-2 ] [\-4 ] [\-F ] directory ...
+.PP
+.B bltk_plot
+[\-hDswy1vnr] [\-d ] [\-f ] [\-x ] [\-X ] [\-Y ]
+[\-t ] [\-o ] [\-2 ] [\-p ] results_dir ...
+.SH DESCRIPTION
+The following tools are implemented for results analysis:
+.TP
+.B bltk_report
+automated report creation
+.TP
+.B bltk_report_table
+summary table creation from several results folders
+.TP
+.B bltk_plot
+graph drawing
+.SH GENERAL OPTIONS
+.TP
+.B \-h
+theis help
+.TP
+.B \-1
+first statistic item of score file is ignored
+.TP
+.BR "\-2 " item:num
+statistic from item 'item', 'num' number of score file
+.TP
+.B -f
+statistics file name
+.SH SPECIFIC OPTIONS
+.B bltk_report
+.RS
+.TP
+.B \-o
+print report to output
+.TP
+.BR "\-K " string
+comment string
+.TP
+.BR "\-R " filename
+argument will be used as report file name
+.TP
+.B \-3 
+first statistic item of stat.log file is ignored
+.TP
+.BR "\-4 " item:num
+statistic from item 'item', 'num' number of stat.log file
+.TP
+.B \-E
+errors being ignored (allows to create report file anyway)
+.TP
+.B \-i
+idle mode
+.RE
+.PP
+.B bltk_report_table
+.RS
+.TP
+.B \-d
+debugging mode
+.TP
+.B \-s
+sort result lines
+.TP
+.B \-t
+Excel-compatible file format
+.TP
+.B \-3
+first statistic item of stat.log file is ignored
+.TP
+.BR "\-4 " item:num
+statistic from item 'item', 'num' number of stat.log file
+.TP
+.B \-u
+only columns which contain different values will be included into table
+.TP
+.B \-E
+errors being ignored (allows to create result table anyway)
+.TP
+.B \-e
+skip error results
+.TP
+.BR "\-F " filter
+only fields from filter file will be included into table (see doc/filter as an example)
+.TP
+.B \-S
+split mode - split multiple values to columns
+.TP
+.B \-R
+analyze all results dirs under passed directories
+.RE
+.PP
+.B bltk_plot
+.RS
+.TP
+.B \-D
+debugging mode
+.TP
+.BR "\-d " results_dir
+results directory name. This option could be passed several times default is current directory.
+.TP
+.B \-s
+use stat.log file
+.TP
+.B \-w
+use work.log file
+.TP
+.BR "\-x " name
+argument is used to be an X parameter default is 'time' field
+.TP
+.BR "\-y " name ...
+argument is used to be an Y parameter this option could be passed several times default is 'cap' field
+.TP
+.BR "\-X " x1:x2
+x range from x1 to x2
+.TP
+.BR "\-Y " y1:y2
+y range from y1 to y2
+.TP
+.B \-t title
+graph title
+.TP
+.BR "\-o " options
+options passed to 'plot' command
+.TP
+.B \-v
+print current variables
+.TP
+.BR "\-p " file
+save graph to specified file
+.TP
+.B \-n
+print available field's names
+.TP
+.B \-R
+analyze all results dirs under passed directories
+.RE
+.SH EXAMPLE
+.TP
+bltk_report_table <results1> ... <resultsn> >sum
+Common results table will be generated in 'sum' file for <results1> ... <resultsn> directories.
+.TP
+bltk_report result
+\'Report\' file will be generated in results directory
+.TP
+bltk_plot -y bat -x N <results_dir1> ... <results_dir>
+Common graph will be generated for <results_dir1> ... <results_dirn>
+.SH SEE ALSO
+\fBbltk\fR(1), \fBbltk.conf\fR(5)
+.SH AUTHOR
+.nf
+Konstantin Karasyov   <konstantin.a.karasyov@intel.com>
+Vladimir Lebedev      <vladimir.p.lebedev@intel.com>
+.fi
--- curr-1.0.9/doc/bltk.conf.5	1970-01-01 01:00:00.000000000 +0100
+++ curr-1.0.9-1/doc/bltk.conf.5	2009-07-17 11:03:54.891127310 +0200
@@ -0,0 +1,73 @@
+.TH BLTK.CONF 5 "15 July 2009" "BLTK.CONF" "Battery life tool kit configuration"
+.SH NAME
+bltk.conf - config file for bltk
+.SH DESCRIPTION
+bltk.conf may be used to control particular features of bltk. By default, bltk looks for the file in /etc direcotry.
+.SH FORMAT
+The format of bltk.conf is very simple. Each line is either a comment or a directive. Comment lines start with a # and are ignored. A directive line has the format:
+.PP
+option=value
+.PP
+It is important to note that it is an error to put any space between the option, = and value.
+.PP
+Each setting has a compiled in default which may be modified in the configuration file.
+.SH .BOOLEAN OPTIONS
+Below is a list of boolean options. The value for a boolean option may be set to YES or NO.
+.TP
+.B CHK_INSTALLED
+If set to YES, existance of .installed files is checked for.
+.TP
+.B WL_DEVELOPER_ENABLED
+Controls whether developer workload is enabled.
+.TP
+.B WL_DEVELOPER_EXTERN
+Controls whether external sources are used to build workload application.
+.TP
+.B WL_GAME_ENABLED
+Controls whether game workload is enabled.
+.TP
+.B WL_GAME_EXTERN
+Controls whether external sources are used to build workload application.
+.TP
+.B WL_OFFICE_ENABLED
+Controls whether office workload is enabled.
+.TP
+.B WL_OFFICE_EXTERN
+Controls whether external sources are used to build workload application.
+.TP
+.B WL_PLAYER_ENABLED
+Controls whether player workload is enabled
+.TP
+.B WL_PLAYER_EXTERN
+Controls whether external sources are used to build workload application.
+.TP
+.B WL_READER_ENABLED
+Controls whether reader workload is enabled.
+.TP
+.B WL_READER_EXTERN
+Controls whether external sources are used to build workload application.
+.SH .STRING OPTIONS
+.B BLTK_HOME
+This option specifies the location of BLTK's home directory. This directory is used as starting directory for saving results and temporary files.
+.TP
+.B SOFFICE_PROG
+This option specifies an application to be started when office workload is used.
+.TP
+.B WL_OFFICE_WORKING_DIR
+The option specifies working directory for office workload.
+.TP
+.B BLTK_PLAYER_PROG
+The option replaces default aplication to be used for playing audio/video
+.TP
+.B BLTK_PLAYER_FILE
+The option replaces default source to be played.
+.TP
+.B BLTK_READER_PROG
+The option replaces default aplication to be used for reading a document.
+.TP
+.B BLTK_READER_FILE
+The option replaces default document to be read.
+.SH SEE ALSO
+\fBbltk\fR(1)
+.SH AUTHOR
+jskala@redhat.com