Skip to content

Commit b685cd9

Browse files
committed
Improvements on man page
1 parent 8fba193 commit b685cd9

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

scalp.1

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,10 @@ That's why scalp came in to being.
2828
.PP
2929
Beware that scalp is still in development.
3030
.SH SUBCOMMANDS
31-
.TP
32-
Running scalp without any subcommands will start the notification daemon. The default filename is \fIfoo\fP.
31+
.PP
32+
Running scalp without any subcommands will start the notification daemon.
33+
The program will notify the user with a message specified in the file once the specified
34+
time arrives. The default filename is \fIfoo\fP.
3335
.TP
3436
.B add
3537
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).
@@ -42,3 +44,14 @@ will list all entries in a given file.
4244
.TP
4345
.B update
4446
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.
47+
.SH FILE FORMAT
48+
Each line contains a number, representing the number of seconds since Unix Epoch
49+
(1st Jan 1970 12am UTC), a separating character (usually a tab, never a digit or a newline)
50+
and a string of maximally 512 characters, representing the message to be displayed.
51+
.TP
52+
For example, the following line is a valid entry for scalp:
53+
1660035600\ Something happens!!
54+
.PP
55+
The file must end on a newline.
56+
.SH FURTHER READING
57+
More information can be found on \fIhttps://github.com/nmke-de/scalp\fP.

0 commit comments

Comments
 (0)