From 5b1bad2650eb45cee0dfdb14a3fc5a6f0d2c668f Mon Sep 17 00:00:00 2001
From: Dianne Skoll <dianne@skoll.ca>
Date: Sat, 16 Mar 2024 15:50:58 -0400
Subject: [PATCH] Document DEL server command and qid value.

---
 man/tkremind.1.in | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/man/tkremind.1.in b/man/tkremind.1.in
index c2d3f3d7..8b663b62 100644
--- a/man/tkremind.1.in
+++ b/man/tkremind.1.in
@@ -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