tomasino
/
todo
1
1
Fork 0
Code Issues Pull Requests Releases 2 Activity
CLI todo list manager with tmux session support
41 Commits 1 Branch 4 Tags 69 KiB
Shell 53.8%
Roff 31.6%
Makefile 14.6%
Go to file
James Tomasino 3ba8ea3b1a adds drone shellcheck 2021-04-07 20:04:46 +00:00
.drone.yml adds drone shellcheck 2021-04-07 20:04:46 +00:00
.travis.yml corrected travis test 2019-03-18 23:53:40 -04:00
LICENSE License, copyright, Make, man created 2018-01-04 03:45:22 -05:00
Makefile readme generation fixed at 80col 2020-10-27 02:12:27 +00:00
README.txt fixed width readme 2020-10-27 02:13:07 +00:00
todo revised readme to mimic man page 2020-07-10 20:54:11 +00:00
todo.1 updates makefile help target to be bsd friendly 2020-09-05 18:14:31 +00:00
todo.spec Add RPM spec file 2020-07-10 22:34:03 +01:00

README.txt

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

TODO(1)                     General Commands Manual                    TODO(1)

NAME
       todo - a minimalist todo list manager

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  re‐
       viewed.

       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.

       The options are as follows:

       no parameters
              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.

       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.

       -x     Display the archive file.

       -v     Display current version information.

       -h     Show the help.

EXIT STATUS
       The todo utility exits 0 on success, and >0 if an error occurs.

EXAMPLES
       todo   Displays the current todo list

       todo -a `this is a new todo list item'
              Adds a new item to the current todo list

       todo -d 3
              Deletes item #3 from the current todo list

       todo -x
              Shows the archive for the current todo list

LICENSE
       GNU General Public License v3.0 or later at

       https://www.gnu.org/licenses/gpl-3.0-standalone.html

BUGS
       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)