0001 .TH THERMOMETER 8
0002 # SPDX-License-Identifier: GPL-2.0
0003 .SH NAME
0004 \fBthermometer\fP - A thermal profiling tool
0005
0006 .SH SYNOPSIS
0007 .ft B
0008 .B thermometer
0009 .RB [ options ]
0010 .RB [ command ]
0011 .br
0012 .SH DESCRIPTION
0013 \fBthermometer \fP captures the thermal zones temperature at a
0014 specified sampling period. It is optimized to reduce as much as
0015 possible the overhead while doing the temperature acquisition in order
0016 to prevent disrupting the running application we may want to profile.
0017
0018 This low overhead also allows a high rate sampling for the temperature
0019 which could be necessary to spot overshots and undershots.
0020
0021 If no configuration file is specified, then all the thermal zones will
0022 be monitored at 4Hz, so every 250ms. A configuration file specifies
0023 the thermal zone names and the desired sampling period. A thermal zone
0024 name can be a regular expression to specify a group of thermal zone.
0025
0026 The sampling of the different thermal zones will be written into
0027 separate files with the thermal zone name. It is possible to specify a
0028 postfix to identify them for example for a specific scenario. The
0029 output directory can be specified in addition.
0030
0031 Without any parameters, \fBthermometer \fP captures all the thermal
0032 zone temperatures every 250ms and write to the current directory the
0033 captured files postfixed with the current date.
0034
0035 If a running \fBduration\fP is specified or a \fBcommand\fP, the
0036 capture ends at the end of the duration if the command did not
0037 finished before. The \fBduration\fP can be specified alone as well as
0038 the \fBcommand\fP. If none is specified, the capture will continue
0039 indefinitively until interrupted by \fBSIGINT\fP or \fBSIGQUIT\fP.
0040 .PP
0041
0042 .SS Options
0043 .PP
0044 The \fB-h, --help\fP option shows a short usage help
0045 .PP
0046 The \fB-o <dir>, --output <dir>\fP option defines the output directory to put the
0047 sampling files
0048 .PP
0049 The \fB-c <config>, --config <config>\fP option specifies the configuration file to use
0050 .PP
0051 The \fB-d <seconds>, --duration <seconds>\fP option specifies the duration of the capture
0052 .PP
0053 The \fB-l <loglevel>, --loglevel <loglevel>\fP option sets the loglevel [DEBUG,INFO,NOTICE,WARN,ERROR]
0054 .PP
0055 The \fB-p <string>, --postfix <string>\fP option appends \fBstring\fP at the end of the capture filenames
0056 .PP
0057 The \fB-s, --syslog\fP option sets the output to syslog, default is \fBstdout\fP
0058 .PP
0059 The \fB-w, --overwrite\fP overwrites the output files if they exist
0060 .PP
0061
0062 .PP
0063
0064 .SS "Exit status:"
0065 .TP
0066 0
0067 if OK,
0068 .TP
0069 1
0070 Error with the options specified as parameters
0071 .TP
0072 2
0073 Error when configuring the logging facility
0074 .TP
0075 3
0076 Error when configuring the time
0077 .TP
0078 4
0079 Error in the initialization routine
0080 .TP
0081 5
0082 Error during the runtime
0083
0084 .SH Capture file format
0085
0086 Every file contains two columns. The first one is the uptime timestamp
0087 in order to find a point in time since the system started up if there
0088 is any thermal event. The second one is the temperature in milli
0089 degree. The first line contains the label of each column.
0090
0091 .SH AUTHOR
0092 Daniel Lezcano <daniel.lezcano@kernel.org>
