thermometer.8 (2978B)
1.TH THERMOMETER 8 2# SPDX-License-Identifier: GPL-2.0 3.SH NAME 4\fBthermometer\fP - A thermal profiling tool 5 6.SH SYNOPSIS 7.ft B 8.B thermometer 9.RB [ options ] 10.RB [ command ] 11.br 12.SH DESCRIPTION 13\fBthermometer \fP captures the thermal zones temperature at a 14specified sampling period. It is optimized to reduce as much as 15possible the overhead while doing the temperature acquisition in order 16to prevent disrupting the running application we may want to profile. 17 18This low overhead also allows a high rate sampling for the temperature 19which could be necessary to spot overshots and undershots. 20 21If no configuration file is specified, then all the thermal zones will 22be monitored at 4Hz, so every 250ms. A configuration file specifies 23the thermal zone names and the desired sampling period. A thermal zone 24name can be a regular expression to specify a group of thermal zone. 25 26The sampling of the different thermal zones will be written into 27separate files with the thermal zone name. It is possible to specify a 28postfix to identify them for example for a specific scenario. The 29output directory can be specified in addition. 30 31Without any parameters, \fBthermometer \fP captures all the thermal 32zone temperatures every 250ms and write to the current directory the 33captured files postfixed with the current date. 34 35If a running \fBduration\fP is specified or a \fBcommand\fP, the 36capture ends at the end of the duration if the command did not 37finished before. The \fBduration\fP can be specified alone as well as 38the \fBcommand\fP. If none is specified, the capture will continue 39indefinitively until interrupted by \fBSIGINT\fP or \fBSIGQUIT\fP. 40.PP 41 42.SS Options 43.PP 44The \fB-h, --help\fP option shows a short usage help 45.PP 46The \fB-o <dir>, --output <dir>\fP option defines the output directory to put the 47sampling files 48.PP 49The \fB-c <config>, --config <config>\fP option specifies the configuration file to use 50.PP 51The \fB-d <seconds>, --duration <seconds>\fP option specifies the duration of the capture 52.PP 53The \fB-l <loglevel>, --loglevel <loglevel>\fP option sets the loglevel [DEBUG,INFO,NOTICE,WARN,ERROR] 54.PP 55The \fB-p <string>, --postfix <string>\fP option appends \fBstring\fP at the end of the capture filenames 56.PP 57The \fB-s, --syslog\fP option sets the output to syslog, default is \fBstdout\fP 58.PP 59The \fB-w, --overwrite\fP overwrites the output files if they exist 60.PP 61 62.PP 63 64.SS "Exit status:" 65.TP 660 67if OK, 68.TP 691 70Error with the options specified as parameters 71.TP 722 73Error when configuring the logging facility 74.TP 753 76Error when configuring the time 77.TP 784 79Error in the initialization routine 80.TP 815 82Error during the runtime 83 84.SH Capture file format 85 86Every file contains two columns. The first one is the uptime timestamp 87in order to find a point in time since the system started up if there 88is any thermal event. The second one is the temperature in milli 89degree. The first line contains the label of each column. 90 91.SH AUTHOR 92Daniel Lezcano <daniel.lezcano@kernel.org>