-
Notifications
You must be signed in to change notification settings - Fork 0
/
HELP.txt
95 lines (71 loc) · 3.48 KB
/
HELP.txt
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
Usage:
time_manager <command> <flags> ([TIME | MESSAGE]) [(MESSAGE) | FROM (TO)]
Key: () = optional, [ | ] = one or the other
Where <command> is one of START, STOP,
UNDO, EDIT, or VIEW, the 5 available commands.
Flags:
-m, --message Allows you to pass in an optional message.
See below.
-nc, --nocolor Turns off default coloring of output.
-t, --time Used with EDIT to specify the time to set on the
most recent start or stop.
-<mins>, +<mins> Used with EDIT to specify by how many minutes to
adjust the most recent start or stop.
Display Option Flags:
-d, --daily-digest Show only total hours per day without individual
sessions.
Can't be used with any other display option.
-dd, --day-delimited Show all session times but have each day visually
separated/delimited.
Also shows total hours per day.
Can't be used with any other display option.
-w, --weekly-digest Show only total hours per week without individual
sessions or days.
Can't be used with any other display option.
-wd, --week-delimited Daily digest but have each week visually
separated/delimited.
Also shows total hours per week.
Can't be used with any other display option.
Arguments are case sensitive, except for <command>
START:
You use this command once you have started studying.
MESSAGE (with -m/--message flag):
Add a message/note. Example messages would be "refactor python
function docstrings" or "solve 5kyu codewars problems."
STOP:
You use this command once you have stopped studying.
MESSAGE (with -m/--message flag):
Add a message/note. Example messages would be "finished all but
3 TODOS" or "finally done with Dijkstra's algorithm."
UNDO:
You use this command to undo a previous START or STOP.
EDIT:
You use this command to edit a previous START or STOP.
MESSAGE (with -m/--message flag):
Replace the message/note from the previous START or STOP.
TIME (with -t/--time flag):
Replace the time from the previous START or STOP.
Must be in HH:MM:SS format without AM/PM or timezone.
MINS (with +<mins>/-<mins> flag):
Edit the time from the previous START or STOP by adding or subtracting
a specified number of minutes.
<mins> must be an integer.
-<mins> means further into the past, while +<mins> means closer to the
present or farther into the future.
For example, if the previous time was 11:30:00, +5 would edit it to
11:35:00, and -5 to 11:25:00.
VIEW:
You use this command to view the times and stats of
your logged time.
FROM (POSITIVE INTEGER || UNDERSCORE -> DAYS):
Optional integer argument that can be used in
combination with the VIEW command. It uses the past
N days in its display of times and stats if supplied,
if not provided or is an underscore it shows the times
and stats for all time.
TO (NON-NEGATIVE INTEGER -> DAYS):
Optional and can be used with FROM. If supplied, VIEW
will only show info from 'FROM days ago' to 'TO days ago'.
For example, if FROM and TO are provided and have values of
6 and 3, then data from 6 days ago to 3 days ago will be displayed.
If not provided, then TO defaults to 0.