93 lines · plain
1.TH THERMOMETER 82# SPDX-License-Identifier: GPL-2.03.SH NAME4\fBthermometer\fP - A thermal profiling tool5 6.SH SYNOPSIS7.ft B8.B thermometer9.RB [ options ]10.RB [ command ]11.br12.SH DESCRIPTION13\fBthermometer \fP captures the thermal zones temperature at a14specified sampling period. It is optimized to reduce as much as15possible the overhead while doing the temperature acquisition in order16to prevent disrupting the running application we may want to profile.17 18This low overhead also allows a high rate sampling for the temperature19which could be necessary to spot overshots and undershots.20 21If no configuration file is specified, then all the thermal zones will22be monitored at 4Hz, so every 250ms. A configuration file specifies23the thermal zone names and the desired sampling period. A thermal zone24name can be a regular expression to specify a group of thermal zone.25 26The sampling of the different thermal zones will be written into27separate files with the thermal zone name. It is possible to specify a28postfix to identify them for example for a specific scenario. The29output directory can be specified in addition.30 31Without any parameters, \fBthermometer \fP captures all the thermal32zone temperatures every 250ms and write to the current directory the33captured files postfixed with the current date.34 35If a running \fBduration\fP is specified or a \fBcommand\fP, the36capture ends at the end of the duration if the command did not37finished before. The \fBduration\fP can be specified alone as well as38the \fBcommand\fP. If none is specified, the capture will continue39indefinitively until interrupted by \fBSIGINT\fP or \fBSIGQUIT\fP.40.PP41 42.SS Options43.PP44The \fB-h, --help\fP option shows a short usage help45.PP46The \fB-o <dir>, --output <dir>\fP option defines the output directory to put the47sampling files48.PP49The \fB-c <config>, --config <config>\fP option specifies the configuration file to use50.PP51The \fB-d <seconds>, --duration <seconds>\fP option specifies the duration of the capture52.PP53The \fB-l <loglevel>, --loglevel <loglevel>\fP option sets the loglevel [DEBUG,INFO,NOTICE,WARN,ERROR]54.PP55The \fB-p <string>, --postfix <string>\fP option appends \fBstring\fP at the end of the capture filenames56.PP57The \fB-s, --syslog\fP option sets the output to syslog, default is \fBstdout\fP58.PP59The \fB-w, --overwrite\fP overwrites the output files if they exist60.PP61 62.PP63 64.SS "Exit status:"65.TP66067if OK,68.TP69170Error with the options specified as parameters71.TP72273Error when configuring the logging facility74.TP75376Error when configuring the time77.TP78479Error in the initialization routine80.TP81582Error during the runtime83 84.SH Capture file format85 86Every file contains two columns. The first one is the uptime timestamp87in order to find a point in time since the system started up if there88is any thermal event. The second one is the temperature in milli89degree. The first line contains the label of each column.90 91.SH AUTHOR92Daniel Lezcano <daniel.lezcano@kernel.org>93