Updated the readme and added a manpage and bash completion.HEADmaster

Signed-off-by: David Moc <personal@cdatgoose.org>

1 files changed, 98 insertions, 0 deletions

diff --git a/tasker.1 b/tasker.1
new file mode 100644
index 0000000..7c7f90d
--- /dev/null
+++ b/tasker.1
@@ -0,0 +1,98 @@
+.TH TASKER 1
+.SH NAME
+tasker \- manage local task directories
+.SH SYNOPSIS
+.B tasker
+.RI COMMAND
+.RI [ OPTIONS ]
+
+.SH DESCRIPTION
+.B tasker
+manages tasks stored as timestamp-named directories.
+
+Task directories are searched under
+.B ./tasks
+when that directory exists, otherwise under the current directory.
+
+.SH COMMANDS
+.TP
+.B new
+Create a new task.
+.TP
+.B list
+List tasks.
+.TP
+.B set
+Update a task.
+.TP
+.B delete
+Delete a task.
+
+.SH OPTIONS
+.SS new
+.TP
+.BI \-p " PRIORITY"
+Set priority as an integer.
+.TP
+.BI \-d " DESCRIPTION"
+Set task description.
+
+.SS list
+.TP
+.BR \-s ", " \-\-status " " \fISTATUS\fR
+Filter by status. One of:
+.BR OPEN ,
+.BR IN_PROGRESS ,
+.BR CLOSED .
+.TP
+.BR \-p ", " \-\-priority " " \fIPRIORITY\fR
+Filter by exact priority.
+.TP
+.BI \-\-min-priority " PRIORITY"
+Filter by minimum priority.
+.TP
+.BR \-c ", " \-\-contains " " \fITEXT\fR
+Filter by text.
+
+.SS set
+.TP
+.BI \-n ", " \-\-name " NAME"
+Rename the task.
+.TP
+.BR \-s ", " \-\-status " " \fISTATUS\fR
+Set task status. One of:
+.BR OPEN ,
+.BR IN_PROGRESS ,
+.BR CLOSED .
+.TP
+.BR \-p ", " \-\-priority " " \fIPRIORITY\fR
+Set task priority.
+.TP
+.BR \-d ", " \-\-desc " " \fIDESCRIPTION\fR
+Set task description.
+
+.SH EXAMPLES
+.TP
+Create a task:
+.B tasker new -p 3 -d "Write docs"
+.TP
+List open tasks:
+.B tasker list --status OPEN
+.TP
+Update a task:
+.B tasker set "24-01-30 12:00:00" --status CLOSED
+.TP
+Delete a task:
+.B tasker delete "24-01-30 12:00:00"
+
+.SH FILES
+.TP
+.B ./tasks/
+Preferred task root when present.
+.TP
+.B .
+Fallback task root.
+
+.SH SEE ALSO
+.BR bash (1),
+.BR fish (1)