summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAriadna Vigo <arivigodr@gmail.com>2020-12-18 00:47:59 +0100
committerAriadna Vigo <arivigodr@gmail.com>2020-12-18 00:47:59 +0100
commitb20516d26fadb08b8ca53dedc991d8a774182b76 (patch)
tree0d96b871f6f7889f8405dbb3c22c6739b124719a
parent82f271b348d6a7b647d75f7d8a06c10e3d1392c4 (diff)
Documented edit function
-rw-r--r--README.md3
-rw-r--r--cras.122
2 files changed, 16 insertions, 9 deletions
diff --git a/README.md b/README.md
index 4609ea2..749ad8f 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,8 @@ The -t and -T, followed by the task number, mark the task as done or pending,
respectively.
Adding new tasks to an already existing file is possible by using the -a
-option. Deleting tasks is performed by using the -d option.
+option. Tasks can be delated by using the -d option, specifying the number of
+the desired task. Editing the description of a task can be done by using -e.
For further usage information, please refer to the cras(1) manual page.
diff --git a/cras.1 b/cras.1
index 8c2d830..89ff48c 100644
--- a/cras.1
+++ b/cras.1
@@ -6,7 +6,7 @@ cras - The Anti-Procrastination Tool
.PP
.B cras
.RB [ \-ainov ]
-.RB [ \-dtT
+.RB [ \-detT
.IR num ]
.I file
.SH DESCRIPTION
@@ -21,6 +21,16 @@ Append new tasks to
.I file.
(Be aware that this doesn't update the expiration date.)
.TP
+.BI \-d " num"
+Delete task
+.I
+num.
+.TP
+.BI \-e " num"
+Edit task
+.I
+num.
+.TP
.B \-i
Force expiration of
.I file.
@@ -33,11 +43,6 @@ overwriting previous contents if it already exists.
.B \-o
Switch to short-form output.
.TP
-.BI \-d " num"
-Delete task
-.I
-num.
-.TP
.BI \-t " num"
Mark task
.I num
@@ -61,8 +66,9 @@ date, which under the default configuration is 24 hours after originally saving
it. Use -t to mark a task as done and -T to mark it back as pending.
.PP
You may delete tasks by using the -d option followed by its identifying number.
-If you want to set the whole file as already expired, you may do so by using
-the -i option.
+You may similarly edit the description of a task by using the -e option. If you
+want to set the whole file as already expired, you may do so by using the -i
+option.
.PP
Running cras with no options outputs the task list. For a summary, use the -o
flag; this short-form output is suitable for printing to WM status bars.