-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathscalp.1
162 lines (162 loc) · 4.31 KB
/
scalp.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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
.TH SCALP 1
.SH NAME
scalp \- a Simple CALendar Program that actually only notifies you on certain events.
(a.k.a. todolist)
.SH SYNOPSIS
.SY scalp
.OP FILENAME
.YS
.SY scalp
add
.OP FILENAME
.YS
.SY scalp
change
.OP FILENAME
.YS
.SY scalp
copy
.OP FILENAME
.YS
.SY scalp
del
.OP FILENAME
.YS
.SY scalp
help
.YS
.SY scalp
list
.OP FILENAME
.YS
.SY scalp
move
.OP FILENAME
.YS
.SY scalp
prune
.OP FILENAME
.YS
.SY scalp
repeat
.OP FILENAME
.YS
.SY scalp
update
.YS
.SH DESCRIPTION
.B scalp
is a simple calendar program that actually only notifies you on certain events.
Some people will not call this a calendar program, but a reminder / agenda /
todo-list program.
.PP
All the other calendar programs are too complicated, both in source code and in usage.
That's why scalp came in to being.
.PP
Beware that scalp is still in development.
.SH SUBCOMMANDS
.PP
Running scalp without any subcommands will start the daemon.
The program will notify the user with a message specified in the file once the specified
time arrives. The default filename is \fIfoo\fP.
.TP
.B add
will prompt the user to enter a time and a message. The message must not be longer than 512 characters long, and the time format is described in \fIdate\fP(1).
.TP
.B change
will prompt the user to give a number, which corresponds to the entry that the user wants to change. After that, the user is prompted to enter a new message. Same rules apply as with
.B scalp add.
.TP
.B copy
will prompt the user to give a number, which corresponds to the entry that the user wants to copy. After that, the user is prompted to enter a new time for the copied event. Same rules apply as with
.B scalp add.
.TP
.B del
will prompt the user to give a number, which corresponds to the entry that the user wants to delete.
.TP
.B help
will show a help message.
.TP
.B list
will list all entries in a given file.
.TP
.B move
will prompt the user to give a number, which corresponds to the entry that the user wants to move. After that, the user is prompted to enter a new time for the given event. Same rules apply as with
.B scalp add.
.TP
.B prune
will remove all entries older than now.
.TP
.B repeat
will prompt the user to give a number, which corresponds to the that the user wants to copy repeatedly. After that, the user is prompted with the interval (yearly, monthly, weekly, daily) and a time when the program is supposed to stop repeat the entry.
.TP
.B update
will update all running instances of scalp. This means that all instances of scalp running in daemon mode will reload their source file and then continue.
.SH USAGE EXAMPLES
.TP
It is recommended to start the scalp daemon on startup. For example, put this line in your \fI.bashrc\fP:
.EX
nohup scalp ~/.cache/calendar.scalp &
.EE
.TP
Here is an example of adding a new entry:
.EX
scalp add ~/.cache/calendar.scalp
Time: next Friday 6pm
Message: Homegroup at home!
.EE
.TP
Here is another one, for another file:
.EX
$ scalp add foo
Time: 2023-07-03
Message: Marc's birthday!
.EE
.TP
This shows the deletion of the entry of the homegroup entry (date may vary):
.EX
$ scalp del ~/.cache/calendar.scalp
1 Sat Sep 17 11:00:00 2022 Dad's birthday
2 Tue Sep 20 14:00:00 2022 Somebody's gonna roll me.
3 Wed Sep 21 07:21:21 2022 Country Road, take me home!
4 Fri Sep 23 18:00:00 2022 Homegroup at home!
Which event do you want to delete? 4
.EE
.TP
Here is an example of scalp list:
.EX
$ scalp list ~/.cache/calendar.scalp
Sat Sep 17 11:00:00 2022 Dad's birthday
Tue Sep 20 14:00:00 2022 Somebody's gonna roll me.
Wed Sep 21 07:21:21 2022 Country Road, take me home!
.EE
.TP
To remove old outdated entries, type this:
.EX
$ scalp prune foo
.EE
.TP
To update all instances of scalp (which is only necessary if you edit any files manually), do this:
.EX
$ scalp update
.EE
.SH ENVIRONMENT
A default foofile can be set by setting the CALF environment variable.
.EX
export CALF=$HOME/foo
.EE
.SH FILE FORMAT
Each line contains a number, representing the number of seconds since Unix Epoch
(1st Jan 1970 12am UTC), a separating character (usually a tab, never a digit or a newline)
and a string of maximally 512 characters, representing the message to be displayed.
.PP
For example, the following line is a valid entry for scalp:
.EX
1660035600 Something happens!!
.EE
.PP
The file must end on a newline.
.SH FURTHER READING
More information can be found on
.UR https://github.com/nmke-de/scalp
.UE .