felixfoertsch/remind
1
0
Fork 0
mirror of https://salsa.debian.org/dskoll/remind.git synced 2026-04-16 06:18:47 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document DEL server command and qid value.

Browse Source
This commit is contained in:
Dianne Skoll
2024-03-16 15:50:58 -04:00
parent e5ff132c5e
commit 5b1bad2650
1 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
man/tkremind.1.in
View File

@@ -403,6 +403,10 @@ like this:
The value of the \fBqueue\fR key is an array of JSON objects, each
representing a queued reminder.
.TP
DEL \fIqid\fR
Delete the reminder with queue-id \fIqid\fR from the queue.
.TP
REREAD
Re-read the reminder file. Returns the following status line:
@@ -419,15 +423,19 @@ Additional status lines written are as follows:
.TP
.nf
{"response":"reminder","ttime":tt,"now":now,"tags":tags,"body":body}
{"response":"reminder","ttime":tt,"now":now,"tags":tags,"qid":qid,"body":body}
.fi
In this line, \fItt\fR is the trigger time of the reminder (expressed
as a string), \fInow\fR is the current time, \fItags\fR (if present)
is the tag or tags associated with the reminder, and \fIbody\fR is
the body of the reminder. This response causes \fBTkRemind\fR to
pop up a reminder notification.
is the tag or tags associated with the reminder, and \fIbody\fR is the
body of the reminder. This response causes \fBTkRemind\fR to pop up a
reminder notification. \fIqid\fR is a unique identifier for this
reminder. You may delete it from the queue by sending a \fBDEL\fR
\fIqid\fR command to the server. Note that \fIqid\fRs are not stable
across re-reads; if \fBRemind\fR restarts itself to re-read the reminder
file, then the \fIqid\fR values are likely to change, and any reminder
deleted with a \fBDEL\fR \fIqid\fR command is likely to be re-queued.
.TP
.nf