-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathetime.1
119 lines (119 loc) · 2.97 KB
/
etime.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
.TH ETIME "1" "2024-09-08" "etime 1.1.1" "etime Manual"
.
.SH NAME
etime \- The \fBtime\fP command, with energy awareness.
.
.
.SH SYNOPSIS
.B
etime [\fIflags\fP] <\fIcommand\fP> [\fIargs\fP]
.
.
.SH DESCRIPTION
The \fBetime\fP program invokes the provided \fIcommand\fP while gathering details about timing and energy usage.
.sp 2
Options for this program are provided as \fIflags\fP before the \fIcommand\fP.
.sp 2
Arguments for the provided \fIcommand\fP should follow the \fIcommand\fP as separate \fIargs\fP. These values can represent flags or positional arguments and are provided to \fIcommand\fP when it is executed.
.sp 2
The resulting measurements from \fIcommand\fP follow outputs from execution and include:
.
.IP "real"
Actual execution time from start to finish.
.
.IP "user"
CPU time executing in user mode for the process.
.
.IP "sys"
CPU time making system calls in kernel mode.
.
.IP "joules"
Total energy used during the command duration.
.
.IP "watts"
Average power output over the command duration.
.
.IP "sure"
Ratio of observed-to-expected usage results.
.
.
.SH OPTIONS
.
.IP "-h, --help"
Print a helpful but brief message.
.
.IP "-p, --portable"
Output measurements on separate lines for quick parsing.
.
.IP "--device <string>"
Configure the name or ID of the smart plug to measure.
.
.IP "--username <string>"
Account username for Emporia.
.
.IP "--password <string>"
Account password for Emporia.
.
.IP "--version"
Respond with the current version of the build.
.
.
.SH EXIT STATUS
An exit code of \fB0\fP is returned when both \fBetime\fP and the \fIcommand\fP exit with success.
.sp 2
Failure to reach the smart plug servers or execute the built-in \fBtime\fP command will cause the \fBetime\fP program to exit with a non-zero status code.
.sp 2
The \fIcommand\fP might exit with an error code that will be returned after gathering usage measurements.
.
.
.SH ENVIRONMENT
.
.IP "EMPORIA_DEVICE"
The name or ID of the smart plug to measure.
.
.IP "EMPORIA_USERNAME"
The account username for Emporia.
.
.IP "EMPORIA_PASSWORD"
The account password for Emporia.
.
.IP "XDG_CONFIG_HOME"
The path to a directory for storing configurations.
.
.
.SH FILES
.
.IP "$HOME/.config/etime/settings.json"
Details about the active device and service tokens.
.
.
.SH STANDARDS
The built-in \fBtime\fP command must have the \fB-p\fP option to ouput timing measurements on separate lines.
.sp 2
That \fBtime\fP command also must print to \fBstderr\fP. Per \fBPOSIX.1\fP.
.
.
.SH HISTORY
\fIhttps://github.com/zimeg/emporia-time/releases/\fP
.
.SH EXAMPLES
.
.IP "$ etime sleep 12"
Gather baseline information for a resting machine.
.
.IP "$ etime -p sort --reverse numbers.in > numbers.out"
Order input and output details about active usage.
.
.
.SH REPORTING BUGS
\fIhttps://github.com/zimeg/emporia-time/issues/\fP
.
.
.SH COPYRIGHT
\fBetime\fP is licensed under the MIT license and is not affiliated with or endorsed by Emporia Energy.
.
.
.SH SEE ALSO
\fItime\fP(1)
.nf
\fIhttps://www.emporiaenergy.com/emporia-smart-plug/\fP