~tardypad/dotfiles

ref: f37f64d54c959fb7ec9796c00b8a3f7d4bbbd08c dotfiles/files/docs/shell/pomodoro.scd -rw-r--r-- 1009 bytes
f37f64d5 — Damien Tardy-Panis Only show task name if -n option is set 7 months ago
                                                                                
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
pomodoro(1perso)

# NAME

pomodoro - Manage a Pomodoro session

# SYNOPSIS

pomodoro [ *cancel* | *status* ]

pomodoro [ *start* | *toggle* ] [_duration_]

# DESCRIPTION

Manage a Pomodoro session.

A notification with a sound is triggered at the end of a session.

# OPTIONS

None

# OPERANDS

*cancel*
	Cancel session

*start*
	Start session

*status*
	Display time remaining if session active++
This is the default action if none is specified

*toggle*
	Start session if not active, cancel it otherwise

_duration_
	Duration in minutes++
Default is 25 min

# ENVIRONMENT VARIABLES

_XDG_DATA_HOME_
	Path to user-specific base directory to store data files++
If unset, defaults to $HOME/.local/share

_XDG_RUNTIME_DIR_
	Path to user-specific base directory to store runtime files++
If unset, defaults to /tmp

# FILES

_$XDG_DATA_HOME/sounds/end_pomodoro.wav_
	Notification sound to play

_$XDG_RUNTIME_DIR/pomodoro_
	Contains information about the current session

# DEPENDENCIES

- aplay
- notify
- pkill