TODOTXT-NOTIFICATION(1)

NAME ¶

todotxt-notification - desktop notifications for todo.txt tasks

SYNOPSIS ¶

todotxt-notification [-cdpV] [-P [priority=]days] [todo file...]

DESCRIPTION ¶

todotxt-notification sends a desktop notification for all due tasks in the given todo.txt files (more than one can be specified). The notifications can also be triggered earlier or later. This limit can be adjusted per task priority (see option -P). To detect a due date for a task, the due tag is used. It has to be specified as 'due:YYYY-MM-DD'. If no due tag is present or a task is marked completed, it won't be considered for sending a notification.

The options are as follows:

-B

Run in background mode. This automatically resends notifications again each day at 9:00. This includes new notifications that were not due before. If a task disappeared from the todo.txt file, it will no longer be sent.

-c

Keep the contexts in the descriptions of the tasks.

-d

Keep the due tag in the descriptions of the tasks.

-e

Let notifications expire/disappear automatically after one day. This is especially useful in combination with the background mode to prevent flooding the user's notification list in case a user did not remove the notifications from the previous day.

-p

Keep the projects in the descriptions of the tasks.

-P [priority=]days

If the priority is omitted, the default threshold is set for a due date to trigger a notification. If a priority is given, the value will be used for this priority. Higher priorities will use this threshold as well if there has not been specified a threshold for a higher priority. The unit of the threshold are days. The default value is 0 days. Negative values are allowed and would only cause a notification to be triggered if a task is overdue by the given amount of days. Generally, a notification will be triggered if the number of remaining days for a task (including the current day) is greater than or equal to the specified threshold.

-V

Print the version information and exit.

EXIT STATUS ¶

todotxt-notification exits with 0 on success, and with 1 if an error occured.

AUTHORS ¶

Created and maintained by Hannes Braun <hannes@hannesbraun.net>. Up-to-date sources can be found at https://git.sr.ht/~hannes/todotxt-notification. Bugs and patches can be submitted by email to ~hannes/public-inbox@lists.sr.ht.