From b661b31c98b7ed6620eba727c25f46552aa36154 Mon Sep 17 00:00:00 2001 From: Dheepak Krishnamurthy Date: Sat, 27 Nov 2021 12:40:40 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20Add=20man=20page=20=F0=9F=93=9A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/taskwarrior-tui.1 | 216 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 216 insertions(+) create mode 100644 docs/taskwarrior-tui.1 diff --git a/docs/taskwarrior-tui.1 b/docs/taskwarrior-tui.1 new file mode 100644 index 0000000..fd752e0 --- /dev/null +++ b/docs/taskwarrior-tui.1 @@ -0,0 +1,216 @@ +.\" Automatically generated by Pandoc 2.14.2 +.\" +.TH "taskwarrior-tui" "1" "" "" "" +.hy +.SH NAME +.PP +taskwarrior-tui \[em] A terminal user interface for taskwarrior +(https://github.com/kdheepak/taskwarrior-tui) +.SH SYNOPSIS +.PP +\f[C]taskwarrior-tui\f[R] +.PP +\f[B]\f[CB]taskwarrior-tui\f[B]\f[R] is a terminal user interface for +\f[C]taskwarrior\f[R]. +.SH EXAMPLES +.TP +\f[B]\f[CB]taskwarrior-tui\f[B]\f[R] +Starts a terminal user interface for \f[C]taskwarrior\f[R]. +.TP +\f[B]\f[CB]alias tt=taskwarrior-tui\f[B]\f[R] +Add the above to your dotfiles to use \f[C]tt\f[R] to start +\f[C]taskwarrior-tui\f[R]. +.SH KEYBINDINGS +.PP +Keybindings: +.TP +\f[B]\f[CB]Esc\f[B]\f[R] +Exit current action +.TP +\f[B]\f[CB]]\f[B]\f[R] +Next view - Go to next view +.TP +\f[B]\f[CB][\f[B]\f[R] +Previous view - Go to previous view +.PP +Keybindings for task report: +.TP +\f[B]\f[CB]/\f[B]\f[R] +task {string} - Filter task report +.TP +\f[B]\f[CB]a\f[B]\f[R] +task add {string} - Add new task +.TP +\f[B]\f[CB]d\f[B]\f[R] +task {selected} done - Mark task as done +.TP +\f[B]\f[CB]e\f[B]\f[R] +task {selected} edit - Open selected task in editor +.TP +\f[B]\f[CB]j\f[B]\f[R] +{selected+=1} - Move down in task report +.TP +\f[B]\f[CB]k\f[B]\f[R] +{selected-=1} - Move up in task report +.TP +\f[B]\f[CB]J\f[B]\f[R] +{selected+=pageheight} - Move page down in task report +.TP +\f[B]\f[CB]K\f[B]\f[R] +{selected-=pageheight} - Move page up in task report +.TP +\f[B]\f[CB]g\f[B]\f[R] +{selected=first} - Go to top +.TP +\f[B]\f[CB]G\f[B]\f[R] +{selected=last} - Go to bottom +.TP +\f[B]\f[CB]l\f[B]\f[R] +task log {string} - Log new task +.TP +\f[B]\f[CB]m\f[B]\f[R] +task {selected} modify {string} - Modify selected task +.TP +\f[B]\f[CB]q\f[B]\f[R] +exit - Quit +.TP +\f[B]\f[CB]s\f[B]\f[R] +task {selected} start/stop - Toggle start and stop +.TP +\f[B]\f[CB]t\f[B]\f[R] +task {selected} +{tag}/-{tag} - Toggle +{uda.taskwarrior-tui.quick-tag.name} (default: \f[C]next\f[R]) +.TP +\f[B]\f[CB]u\f[B]\f[R] +task undo - Undo +.TP +\f[B]\f[CB]v\f[B]\f[R] +{toggle mark on selected} - Toggle mark on selected +.TP +\f[B]\f[CB]V\f[B]\f[R] +{toggle marks on all tasks} - Toggle marks on all tasks in current +filter report +.TP +\f[B]\f[CB]x\f[B]\f[R] +task delete {selected} - Delete +.TP +\f[B]\f[CB]z\f[B]\f[R] +toggle task info - Toggle task info view +.TP +\f[B]\f[CB]A\f[B]\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[B]\f[CB]!\f[B]\f[R] +{string} - Custom shell command +.TP +\f[B]\f[CB]1-9\f[B]\f[R] +{string} - Run user defined shortcuts +.TP +\f[B]\f[CB]:\f[B]\f[R] +{task id} - Jump to task id +.TP +\f[B]\f[CB]c\f[B]\f[R] +context switcher menu - Open context switcher menu +.TP +\f[B]\f[CB]?\f[B]\f[R] +help - Help menu +.PP +Keybindings for filter / command prompt: +.TP +\f[B]\f[CB]Ctrl + f | Right\f[B]\f[R] +move forward - Move forward one character +.TP +\f[B]\f[CB]Ctrl + b | Left\f[B]\f[R] +move backward - Move backward one character +.TP +\f[B]\f[CB]Ctrl + h | Backspace\f[B]\f[R] +backspace - Delete one character back +.TP +\f[B]\f[CB]Ctrl + d | Delete\f[B]\f[R] +delete - Delete one character forward +.TP +\f[B]\f[CB]Ctrl + a | Home\f[B]\f[R] +home - Go to the beginning of line +.TP +\f[B]\f[CB]Ctrl + e | End\f[B]\f[R] +end - Go to the end of line +.TP +\f[B]\f[CB]Ctrl + k\f[B]\f[R] +delete to end - Delete to the end of line +.TP +\f[B]\f[CB]Ctrl + u\f[B]\f[R] +delete to beginning - Delete to the beginning of line +.TP +\f[B]\f[CB]Ctrl + w\f[B]\f[R] +delete previous word - Delete previous word +.TP +\f[B]\f[CB]Alt + d\f[B]\f[R] +delete next word - Delete next word +.TP +\f[B]\f[CB]Alt + b\f[B]\f[R] +move to previous word - Move to previous word +.TP +\f[B]\f[CB]Alt + f\f[B]\f[R] +move to next word - Move to next word +.TP +\f[B]\f[CB]Alt + t\f[B]\f[R] +transpose words - Transpose words +.TP +\f[B]\f[CB]Up\f[B]\f[R] +scroll history - Go backward in history matching from beginning of line +to cursor +.TP +\f[B]\f[CB]Down\f[B]\f[R] +scroll history - Go forward in history matching from beginning of line +to cursor +.TP +\f[B]\f[CB]TAB | Ctrl + n\f[B]\f[R] +tab complete - Open tab completion and selection first element OR cycle +to next element +.TP +\f[B]\f[CB]BACKTAB | Ctrl + p\f[B]\f[R] +tab complete - Cycle to previous element +.PP +Keybindings for context switcher: +.TP +\f[B]\f[CB]j\f[B]\f[R] +{selected+=1} - Move forward a context +.TP +\f[B]\f[CB]k\f[B]\f[R] +{selected-=1} - Move back a context +.PP +Keybindings for calendar: +.TP +\f[B]\f[CB]j\f[B]\f[R] +{selected+=1} - Move forward a year in calendar +.TP +\f[B]\f[CB]k\f[B]\f[R] +{selected-=1} - Move back a year in calendar +.TP +\f[B]\f[CB]J\f[B]\f[R] +{selected+=10} - Move forward a decade in calendar +.TP +\f[B]\f[CB]K\f[B]\f[R] +{selected-=10} - Move back a decade in calendar +.SH EXIT STATUSES +.TP +0 +If everything goes OK. +.SH AUTHOR +.PP +\f[C]taskwarrior-tui\f[R] is maintained by Dheepak `kdheepak' +Krishnamurthy and other contributors. +.PP +\f[B]Source code:\f[R] +\f[C]https://github.com/kdheepak/taskwarrior-tui/\f[R] +.PD 0 +.P +.PD +\f[B]Contributors:\f[R] +\f[C]https://github.com/kdheepak/taskwarrior-tui/graphs/contributors\f[R]