taskwarrior-tui/docs/taskwarrior-tui.1
2024-05-11 23:56:36 -04:00

211 lines
4.5 KiB
Groff

.\" Automatically generated by Pandoc 3.1.7
.\"
.TH "taskwarrior-tui" "1" "" "" ""
.SH NAME
taskwarrior-tui \[em] A terminal user interface for taskwarrior
(https://github.com/kdheepak/taskwarrior-tui)
.SH SYNOPSIS
\f[CR]taskwarrior-tui\f[R]
.PP
\f[B]\f[CB]taskwarrior-tui\f[B]\f[R] is a terminal user interface for
\f[CR]taskwarrior\f[R].
.SH EXAMPLES
.TP
\f[CR]taskwarrior-tui\f[R]
Starts a terminal user interface for \f[CR]taskwarrior\f[R].
.TP
\f[CR]alias tt=taskwarrior-tui\f[R]
Add the above to your dotfiles to use \f[CR]tt\f[R] to start
\f[CR]taskwarrior-tui\f[R].
.SH KEYBINDINGS
Keybindings:
.TP
\f[CR]Esc\f[R]
Exit current action
.TP
\f[CR]]\f[R]
Next view - Go to next view
.TP
\f[CR][\f[R]
Previous view - Go to previous view
.PP
Keybindings for task report:
.TP
\f[CR]/\f[R]
task {string} - Filter task report
.TP
\f[CR]a\f[R]
task add {string} - Add new task
.TP
\f[CR]d\f[R]
task {selected} done - Mark task as done
.TP
\f[CR]e\f[R]
task {selected} edit - Open selected task in editor
.TP
\f[CR]j\f[R]
{selected+=1} - Move down in task report
.TP
\f[CR]k\f[R]
{selected-=1} - Move up in task report
.TP
\f[CR]J\f[R]
{selected+=pageheight} - Move page down in task report
.TP
\f[CR]K\f[R]
{selected-=pageheight} - Move page up in task report
.TP
\f[CR]g\f[R]
{selected=first} - Go to top
.TP
\f[CR]G\f[R]
{selected=last} - Go to bottom
.TP
\f[CR]l\f[R]
task log {string} - Log new task
.TP
\f[CR]m\f[R]
task {selected} modify {string} - Modify selected task
.TP
\f[CR]q\f[R]
exit - Quit
.TP
\f[CR]s\f[R]
task {selected} start/stop - Toggle start and stop
.TP
\f[CR]t\f[R]
task {selected} +{tag}/-{tag} - Toggle
{uda.taskwarrior-tui.quick-tag.name} (default: \f[CR]next\f[R])
.TP
\f[CR]u\f[R]
task undo - Undo
.TP
\f[CR]v\f[R]
{toggle mark on selected} - Toggle mark on selected
.TP
\f[CR]V\f[R]
{toggle marks on all tasks} - Toggle marks on all tasks in current
filter report
.TP
\f[CR]x\f[R]
task delete {selected} - Delete
.TP
\f[CR]z\f[R]
toggle task info - Toggle task info view
.TP
\f[CR]A\f[R]
task {selected} annotate {string} - Annotate current task
.TP
Ctrl-e
scroll down task details - Scroll task details view down one line
.TP
Ctrl-y
scroll up task details - Scroll task details view up one line
.TP
\f[CR]!\f[R]
{string} - Custom shell command
.TP
\f[CR]1-9\f[R]
{string} - Run user defined shortcuts
.TP
\f[CR]:\f[R]
{task id} - Jump to task id
.TP
\f[CR]c\f[R]
context switcher menu - Open context switcher menu
.TP
\f[CR]?\f[R]
help - Help menu
.PP
Keybindings for filter / command prompt:
.TP
\f[CR]Ctrl + f | Right\f[R]
move forward - Move forward one character
.TP
\f[CR]Ctrl + b | Left\f[R]
move backward - Move backward one character
.TP
\f[CR]Ctrl + h | Backspace\f[R]
backspace - Delete one character back
.TP
\f[CR]Ctrl + d | Delete\f[R]
delete - Delete one character forward
.TP
\f[CR]Ctrl + a | Home\f[R]
home - Go to the beginning of line
.TP
\f[CR]Ctrl + e | End\f[R]
end - Go to the end of line
.TP
\f[CR]Ctrl + k\f[R]
delete to end - Delete to the end of line
.TP
\f[CR]Ctrl + u\f[R]
delete to beginning - Delete to the beginning of line
.TP
\f[CR]Ctrl + w\f[R]
delete previous word - Delete previous word
.TP
\f[CR]Alt + d\f[R]
delete next word - Delete next word
.TP
\f[CR]Alt + b\f[R]
move to previous word - Move to previous word
.TP
\f[CR]Alt + f\f[R]
move to next word - Move to next word
.TP
\f[CR]Alt + t\f[R]
transpose words - Transpose words
.TP
\f[CR]Up\f[R]
scroll history - Go backward in history matching from beginning of line
to cursor
.TP
\f[CR]Down\f[R]
scroll history - Go forward in history matching from beginning of line
to cursor
.TP
\f[CR]TAB | Ctrl + n\f[R]
tab complete - Open tab completion and selection first element OR cycle
to next element
.TP
\f[CR]BACKTAB | Ctrl + p\f[R]
tab complete - Cycle to previous element
.PP
Keybindings for context switcher:
.TP
\f[CR]j\f[R]
{selected+=1} - Move forward a context
.TP
\f[CR]k\f[R]
{selected-=1} - Move back a context
.PP
Keybindings for calendar:
.TP
\f[CR]j\f[R]
{selected+=1} - Move forward a year in calendar
.TP
\f[CR]k\f[R]
{selected-=1} - Move back a year in calendar
.TP
\f[CR]J\f[R]
{selected+=10} - Move forward a decade in calendar
.TP
\f[CR]K\f[R]
{selected-=10} - Move back a decade in calendar
.SH EXIT STATUSES
.TP
0
If everything goes OK.
.SH AUTHOR
\f[CR]taskwarrior-tui\f[R] is maintained by Dheepak `kdheepak'
Krishnamurthy and other contributors.
.PP
\f[B]Source code:\f[R]
\f[CR]https://github.com/kdheepak/taskwarrior-tui/\f[R]
.PD 0
.P
.PD
\f[B]Contributors:\f[R]
\f[CR]https://github.com/kdheepak/taskwarrior-tui/graphs/contributors\f[R]