felixfoertsch/remind
1
0
Fork 0
mirror of https://salsa.debian.org/dskoll/remind.git synced 2026-04-17 14:59:20 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs on JSON trigger dump and SCANFROM changes.

Browse Source
This commit is contained in:
Dianne Skoll
2025-08-13 12:39:35 -04:00
parent da573929ee
commit a6c5c3cb90
2 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
man/rem2ps.1.in
View File

@@ -622,14 +622,23 @@ will be present. Its value will be a string of the form YYYY-MM-DD.
If the reminder contains a ONCE keyword, this key will be present
with a value of 1.
.TP
.B scanfrom \fIYYYY-MM-DD\fR
.B scanfrom \fIYYYY-MM-DD\fR or \fBscanfrom\fR \fI-n\fR
If the reminder contains a SCANFROM keyword, this key will be present
and its value will be a string of the form YYYY-MM-DD.
and its value will be a string of the form YYYY-MM-DD for an absolute
SCANFROM, or a negative integer of the form -n for a relative scanfrom
.TP
.B from \fIYYYY-MM-DD\fR
If the reminder contains a FROM keyword, this key will be present
and its value will be a string of the form YYYY-MM-DD.
.TP
.B is_todo \fIflag\fR
If the reminder is a TODO reminder, then \fIflag\fR will be the integer
1. Otherwise, it will be the integer zero.
.TP
.B complete_through \fIYYYY-MM-DD\fR
If the reminder has a COMPLETE-THROUGH date, then this key will be present
and its value will be a string of the form YYYY-MM-DD.
.TP
.B priority \fIn\fR
The priority of the reminder. Always present; if no PRIORITY keyword
is specified, then a reminder has a default priority of 5000.

6
man/remind.1.in
View File

@@ -1919,6 +1919,8 @@ COMPLETE-THROUGH date to 2026-04-30 and then \fBRemind\fR will start
reminding you of your 2027 taxes (starting 15 days before the due
date.)
.PP
It is an error to specify COMPLETE-THROUGH without also specifying TODO.
.PP
.SH MORE DETAILS ABOUT TODOS
.PP
TODOs are treated specially only in Agenda Mode. In Calendar Mode,
@@ -6955,6 +6957,10 @@ the previous example could also be written like this:
REM Mon AFTER MSG Hello
.fi
.PP
A SCANFROM that specifies a full date is called an \fIabsolute SCANFROM\fR
and a SCANFROM that specifies a negative number is called a
\fIrelative SCANFROM\fR.
.PP
In general, use \fBSCANFROM\fR as shown for safe movable \fBOMITs\fR. The
amount you should scan back by (7 days in the example above) depends on
the number of possible consecutive \fBOMITted\fR days that may occur, and