man page added

slightly expanded TODO to give me something else to do as well

2 files changed, 67 insertions, 0 deletions

diff --git a/TODO b/TODO
index f8adbc4..48e3272 100644
--- a/TODO
+++ b/TODO
@@ -1,3 +1,4 @@
 implement mktemp(1) within the script file
 	mktemp is not POSIX, though it's common
 	alternatively, figure out inplace editing that's POSIX compliant
+retool -a to a non-option arg
diff --git a/todo.1 b/todo.1
new file mode 100644
index 0000000..99abf38
--- /dev/null
+++ b/todo.1
@@ -0,0 +1,66 @@
+.Dd $Mdocdate: November 17 2022 $
+.Dt TODO 1
+.Os
+.Sh NAME
+.Nm todo
+.Nd todo list manager
+.Sh SYNOPSIS
+.Nm todo
+.Oo
+.Fl e |
+.Fl x
+.Oc
+.Nm
+.Op Fl n Ar num
+.Oo
+.Fl a Ar string |
+.Fl d Op Ar num
+.Oc
+.Sh DESCRIPTION
+The
+.Nm
+utility modifies a
+.Nm
+file, which typically contains atomic tasks to be completed.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl a Ar string
+Appends string to the todo file.
+.It Fl d Op Ar num
+Removes line num from the todo file, and adds it to the archive.
+num may be omitted if
+.Fl n
+is specified.
+.It Fl e
+Opens the todo file in an editor.
+.It Fl n Ar num
+Chooses the line to remove or insert a line at, with
+.Fl a
+or
+.Fl d .
+.It Fl x
+Prints the contents of the archive.
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width Ds
+.It Ev EDITOR
+The editor to be used with
+.Fl e .
+.It Ev TODO
+The path of the todo file.
+.El
+.Sh FILES
+.Bl -tag -width Ds
+.It Pa ~/todo
+The default todo file.
+.El
+.Sh EXAMPLES
+To insert the line
+.Dq wash the dog
+at line 10, pushing the previous line 10 and all lower lines down by one:
+.Pp
+.Dl $ todo -n 10 -a "wash the dog"
+.Sh AUTHORS
+.An ensa
+.Lk https://mommyissues.club