about summary refs log blame commit diff stats
path: root/todo.1
blob: 99abf3822b4af05df37b90e9ebaf3a1912167df8 (plain) (tree)

































































                                                                         
.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