.\" Automatically generated by Pandoc 2.9.2.1 .\" .TH "topydo" "8" "November 2020" "" "" .hy .SH NAME .PP topydo \- An advanced todo.txt terminal utility for managing tasks .SS SYNOPSIS .PP \f[C]topydo [-ahv] [-c ] [-C ] [-d ]\f[R] \f[C][-t ] subcommand [help|args]\f[R] .SS DESCRIPTION .PP This is a command line tool for managing and displaying tasking information. .PP Tasks are stored in a plain text file using the todo.txt format. There are a number of tools, across operating systems, that support collaboratively managing a common tasking file. .SS OPTIONS .TP \f[I]\-info\[en]\f[R] Print out current configuration information for topydo, including the path the executable and the tasking file. .TP \f[I]-a\f[R] Do not archive todo items on completion. .TP \f[I]-c\f[R] Specify an alternative configuration file. .TP \f[I]-C\f[R] Specify color mode (0 = disable, 1 = enable 16 colors, 16 = enable 16 colors, 256 = enable 256 colors, auto (default)) .TP \f[I]-d\f[R] Specify an alternative archive file (done.txt) .TP \f[I]-h\f[R] This help text .TP \f[I]-t\f[R] Specify and alternative todo file .TP \f[I]-v\f[R] Print the version and exit .SS BUILT-IN ACTIONS .PP Run \[dq]topydo help for additional help. .IP \[bu] 2 \f[I]add\f[R]|\f[I]a\f[R] \[lq]THING I NEED TO DO +project \[at]context\[rq] .RS 2 .PP Adds THING I NEED TO DO to your todo.txt file on its own line. .PP Project and context notation optional. .PP Quotes optional. .RE .IP \[bu] 2 \f[I]append\f[R]|\f[I]app\f[R] ITEM# \[lq]TEXT TO APPEND\[rq] .RS 2 .PP \f[C]app ITEM# \[dq]TEXT TO APPEND\[dq]\f[R] .PP Adds TEXT TO APPEND to the end of the task on line ITEM#. .PP Quotes optional. .RE .IP \[bu] 2 \f[I]del\f[R]|\f[I]rm\f[R] ITEM# [TERM] .RS 2 .PP Deletes the task on line ITEM# in todo.txt. .PP If TERM specified, deletes only TERM from the task. .RE .IP \[bu] 2 \f[I]depri\f[R]|\f[I]dp\f[R] ITEM#[, ITEM#, ITEM#, \&...] .RS 2 .PP Deprioritizes (removes the priority) from the task(s) .PP on line ITEM# in todo.txt. .RE .IP \[bu] 2 \f[I]do\f[R] ITEM#[, ITEM#, ITEM#, \&...] .RS 2 .PP Marks task(s) on line ITEM# as done in todo.txt. .RE .IP \[bu] 2 \f[I]ls\f[R] [TERM\&...] .RS 2 .PP Displays all tasks that contain TERM(s) sorted by priority with line numbers. Each task must match all TERM(s) (logical AND); to display tasks that contain any TERM (logical OR), use \[lq]TERM1|TERM2|\&...\[rq] (with quotes), or TERM1\[rs]|TERM2 (unquoted). Hides all tasks that contain TERM(s) preceded by a minus sign (i.e.\ -TERM). If no TERM specified, lists entire todo.txt. .RE .IP \[bu] 2 \f[I]listcon\f[R]|\f[I]lscon\f[R] [TERM\&...] .RS 2 .PP Lists all the task contexts that start with the \[at] sign in todo.txt. If TERM specified, considers only tasks that contain TERM(s). .RE .IP \[bu] 2 \f[I]listprojexts\f[R]|\f[I]lsprj\f[R] [TERM\&...] .RS 2 .PP Lists all the projects (terms that start with a + sign) in todo.txt. If TERM specified, considers only tasks that contain TERM(s). .RE .IP \[bu] 2 \f[I]postpone\f[R] ITEM# Postpone the task. .IP \[bu] 2 \f[I]pri\f[R] ITEM# PRIORITY .RS 2 .PP Adds PRIORITY to task on line ITEM#. If the task is already prioritized, replaces current priority with new PRIORITY. PRIORITY must be a letter between A and Z. .RE .IP \[bu] 2 \f[I]revert\f[R] ITEM# .RS 2 .PP Revert a previous task. .RE .SS TODO.TXT TASK FORMAT .PP A todo.txt task is a single line of text, which may contain specially notated words to define metadata for the task. These tags are all optional. .IP \[bu] 2 () .RS 2 .PP A task \f[I]priority\f[R] can be defined by prepending a single letter in parenthesis, followed by a space. By convention, capital letters are used, with `A' denoting the highest priority. .RE .IP \[bu] 2 + .RS 2 .PP A word in the task beginning with \[lq]+\[rq] defines the \f[I]project\f[R] associated with the task. This provides a means to group tasks according to the tasks assocated with a particular effort. .RE .IP \[bu] 2 \[at] .RS 2 .PP A word in the task beginning with the \[lq]\[at]\[rq] character defines the \f[I]context\f[R] associated with the task. Possible contexts are \[at]phone, \[at]email, or \[at]home. This provides a means to group tasks according to the context of when they can be completed. .RE .IP \[bu] 2 due: .RS 2 .PP Define the due date of the task. .RE .IP \[bu] 2 x .RS 2 .PP A task may be marked complete by prepending an \[lq]x\[rq] followed by a space. This is used by the utility to remove tasks from active task lists without affecting the line numbers of the remaining tasks. .RE .PP A task may also contain one or two bare dates that define the creation and completion date of the task. A completed task should have the completion date following the \[lq]x\[rq]. .PP The core todo.txt format is described in full at https://github.com/todotxt/todo.txt. .PP The format is extended by topydo with the following features: .IP \[bu] 2 rec:[+][n][d|w|m|y] .RS 2 .PP Recur a task upon completion. The \f[I]+\f[R] indicates strict recurrance, which bases the new date on the \f[I]due\f[R] date. Otherwise, the closing date is used. .RE .IP \[bu] 2 t: .RS 2 .PP The threshold, or start date. Tasks with a threshold date in the future are generally not shown. .RE .SS CONFIGURATION FILE .PP Configuration files may be stored in the following locations: .IP \[bu] 2 \f[I]/etc/topydo.conf\f[R] .IP \[bu] 2 \f[I]\[ti]/.config/topydo/config\f[R] .IP \[bu] 2 \f[I]\[ti]/.topydo\f[R] .IP \[bu] 2 \f[I].topydo\f[R] (in the current working directory) .IP \[bu] 2 \f[I]topydo.conf\f[R] (in the current working directoy) .IP \[bu] 2 \f[I]topydo.ini\f[R] (in the current working directoy) .PP The files are read in that order, with variables in later files overriding earlier ones. .PP See the \f[I]Configuration\f[R] topic in \f[I]/usr/share/doc/topydo/docs/index.html\f[R] for detail on the configuration file format and variables. .SS SEE ALSO .PP todo(8), todo.txt(8), topydo.conf(5), vitodo(8), edittodo(8), listtodo(8), todo.txt-base(8) .PP The file \f[I]/usr/share/doc/topydo/docs/index.html\f[R] contains extensive information about \f[I]topydo\f[R], including the configuration file format.