gtd
Release 0.3.12: gtd-0.3.12.tgz
Beware: This is alpha/beta quality software and under heavy construction! Do not use it with
important tasks! Expect bugs!
gtd is a small task management tool inspired by David Allen’s “Gettings Things
Done” book. For now it is only a viewer (with minor editing) for todo files
(see below).
USAGE
To use gtd, call the todo.py script:
todo.py [options] [ACTION] [PARAM...]
Possible actions are:
- add todo item
add "THING I NEED TO DO p:project @context"- mark item as done
do NUMBER- edit item
edit NUMBER- edit project
epr PROJECT- init project
init PROJECT- list items
ls [TERM] [[TERM]...]- list projects
lspr- list contexts
lsc
The followeing options were recognized:
--version show program's version number and exit
-h, --help show this help message and exit
-f TODO_FILENAME, --filename=TODO_FILENAME todo filename
-r REGISTRY_FILENAME, --registry=REGISTRY_FILENAME registry filename
-n, --no-color output without color
-o OUTPUT, --output=OUTPUToutput filename; defaults to stdout
-m FORMAT, --format=FORMAT output format; allowed: 'console' (default), 'dialog', 'html', 'latex', 'raw'
-s SORT, --sort=SORT sort items list; allowed: project (default), context,description
-e EDITOR, --editor=EDITOR editor; default: vim #f +#l
The raw format can be used by front-ends, ‘dialog’ is for (X)dialog.
FILE FORMAT
The todo.txt file format format was developed by Gina Trapani. The Python
script was initially written by Shane Koster. Go to Lifehacker
for more info.
A file named todo.txt stores all todo items. This file is a simple
text file with minimal formatting requirements. Instead of using a
database or a some binary file format you can simply use your favourite
editor to add, delete and modify items.
Every line stands for tasks, the *next pyhsical action*. A long line can
be splitted with a `\` at the end of line. Usually a task is part of a
project and can be accomplished within a certain context. Multiple projects
and contexts are possible and both can be nested.
A leading `x` at the beginning of a line marks a finished task. To add
a comment, append a `|` and the comment. Add a date right after the
`|` to set a done date. Use a format like `2008-08-12_21:12:12` or a
simpler `2008-08-12`.
Contexts were tagged with a `@`, projects with `p:`, e.g. `@office`
and `p:gtd`. Big projects should be splitted into several sub-projects:
`p:build_home:build_roof`. Both context and project names must not
contain spaces; replace them with underscores.
If a project or a task has a due date, add this at the beginning of the
line in the same format as the done date. Important tasks can be marked
with priorities, e.g. `(A)` for most important and `(Z)` for much less
important.
Sometimes you want to store additional comments on a task. Use `{` and
`}` to enclose a comment.
EXAMPLE
Here is an example of a ‘todo.txt’ file:
# todo.txt sample file; this is a comment line
this task definition goes over \
two lines
add a project to a task like p:todo_project
this task has a p:project and a certain context like @kitchen
this task has a nested project and context p:etodo:website @office:laptop
multiproject/context task p:etodo p:website @office @home
2007-07-12 send request for comment to brian @waiting
(A) this task is very important!
(C) this task is not so important...
x create a simple website p:todo @office | 2007-06-27_12:21
x write a small man page p:todo @office | 2007-06-27 written in groff
task with a comment {this is a comment} p:etodo p:website @office @home