tomasino
/
todo
1
1
Fork 0
Code Issues Pull Requests Releases 2 Activity

fixed width readme

This commit is contained in:
James Tomasino 2020-10-27 02:13:07 +00:00
parent 94ad8ab3e2
commit f862450559
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.txt
View File

@ -1,4 +1,4 @@
TODO(1) General Commands Manual TODO(1)
TODO(1) General Commands Manual TODO(1)
NAME
todo - a minimalist todo list manager
@ -7,32 +7,34 @@ SYNOPSIS
todo [-vhex] [-a "todo item"] [-d todo-number] [-d "todo phrase"]
DESRIPTION
todo is a simple, minimalist todo list manager. Users can add items to a todo list or
delete them. Deleted items are archived and can be reviewed.
todo is a simple, minimalist todo list manager. Users can add items to
a todo list or delete them. Deleted items are archived and can be re‐
viewed.
The default location of the todo list can be set with the TODO environment variable.
If unset, a the default file is ~/todo.txt.
The default location of the todo list can be set with the TODO environ‐
ment variable. If unset, a the default file is ~/todo.txt.
If todo is used within a tmux session, the filename of the todo list inherits the name
of the current session. This allows for unique todo lists based on tmux context.
If todo is used within a tmux session, the filename of the todo list
inherits the name of the current session. This allows for unique todo
lists based on tmux context.
The options are as follows:
no parameters
If no parameters are passed to todo, then the current todo list will be dis‐
played to standard out.
If no parameters are passed to todo, then the current todo list
will be displayed to standard out.
-a quoted_todo_item
Add a new todo list item
-d item_number_or_phrase
Delete a todo list item by its number or by a string. If a string is provided,
any todo list item that matches that string will be removed. Deleted items are
moved to the archive.
Delete a todo list item by its number or by a string. If a
string is provided, any todo list item that matches that string
will be removed. Deleted items are moved to the archive.
The archive file is named identically to the todo file with the exception of a .ar‐
chive added before the extension. For example, todo.txt would have an archive named
todo.archive.txt in the same folder.
The archive file is named identically to the todo file with the excep‐
tion of a .archive added before the extension. For example, todo.txt
would have an archive named todo.archive.txt in the same folder.
-e Open the todo file in your editor.
@ -63,9 +65,10 @@ LICENSE
https://www.gnu.org/licenses/gpl-3.0-standalone.html
BUGS
Report issues at the git repository at https://github.com/jamestomasino/todo
Report issues at the git repository at https://github.com/jamestom‐
asino/todo
AUTHOR
James Tomasino <james (at) tomasino (dot) org>
2020.09.05 05 September 2020 TODO(1)
2020.09.05 05 September 2020 TODO(1)