docs: update taskwarrior-tui.1.md 📚

This commit is contained in:
Dheepak Krishnamurthy 2021-10-29 12:36:53 -06:00
parent 22ed807cbf
commit 7e8f818788

View file

@ -4,17 +4,23 @@
<!-- To generate the roff version, run `just man`, --> <!-- To generate the roff version, run `just man`, -->
<!-- and the man page will appear in the target directory. --> <!-- and the man page will appear in the target directory. -->
# NAME
NAME
====
taskwarrior-tui — A terminal user interface for taskwarrior (https://github.com/kdheepak/taskwarrior-tui) taskwarrior-tui — A terminal user interface for taskwarrior (https://github.com/kdheepak/taskwarrior-tui)
# SYNOPSIS
SYNOPSIS
========
`taskwarrior-tui` `taskwarrior-tui`
**`taskwarrior-tui`** is a terminal user interface for `taskwarrior`. **`taskwarrior-tui`** is a terminal user interface for `taskwarrior`.
# EXAMPLES
EXAMPLES
========
`taskwarrior-tui` `taskwarrior-tui`
: Starts a terminal user interface for `taskwarrior`. : Starts a terminal user interface for `taskwarrior`.
@ -22,7 +28,9 @@ taskwarrior-tui — A terminal user interface for taskwarrior (https://github.co
`alias tt=taskwarrior-tui` `alias tt=taskwarrior-tui`
: Add the above to your dotfiles to use `tt` to start `taskwarrior-tui`. : Add the above to your dotfiles to use `tt` to start `taskwarrior-tui`.
# KEYBINDINGS KEYBINDINGS
===========
Keybindings: Keybindings:
@ -30,178 +38,186 @@ Keybindings:
: Exit current action : Exit current action
`]` `]`
: Next view - Go to next view : Next view - Go to next view
`[` `[`
: Previous view - Go to previous view : Previous view - Go to previous view
Keybindings for task report: Keybindings for task report:
`/` `/`
: task {string} - Filter task report : task {string} - Filter task report
`a` `a`
: task add {string} - Add new task : task add {string} - Add new task
`d` `d`
: task {selected} done - Mark task as done : task {selected} done - Mark task as done
`e` `e`
: task {selected} edit - Open selected task in editor : task {selected} edit - Open selected task in editor
`j` `j`
: {selected+=1} - Move down in task report : {selected+=1} - Move down in task report
`k` `k`
: {selected-=1} - Move up in task report : {selected-=1} - Move up in task report
`J` `J`
: {selected+=pageheight} - Move page down in task report : {selected+=pageheight} - Move page down in task report
`K` `K`
: {selected-=pageheight} - Move page up in task report : {selected-=pageheight} - Move page up in task report
`g` `g`
: {selected=first} - Go to top : {selected=first} - Go to top
`G` `G`
: {selected=last} - Go to bottom : {selected=last} - Go to bottom
`l` `l`
: task log {string} - Log new task : task log {string} - Log new task
`m` `m`
: task {selected} modify {string} - Modify selected task : task {selected} modify {string} - Modify selected task
`q` `q`
: exit - Quit : exit - Quit
`s` `s`
: task {selected} start/stop - Toggle start and stop : task {selected} start/stop - Toggle start and stop
`n` `n`
: task {selected} +{tag}/-{tag} - Toggle {uda.taskwarrior-tui.quick-tag.name} (Default: `next`) : task {selected} +{tag}/-{tag} - Toggle {uda.taskwarrior-tui.quick-tag.name} (default: `next`)
`u` `u`
: task undo - Undo : task undo - Undo
`v` `v`
: {toggle mark on selected} - Toggle mark on selected : {toggle mark on selected} - Toggle mark on selected
`V` `V`
: {toggle marks on all tasks} - Toggle marks on all tasks in current filter report : {toggle marks on all tasks} - Toggle marks on all tasks in current filter report
`x` `x`
: task delete {selected} - Delete : task delete {selected} - Delete
`z` `z`
: toggle task info - Toggle task info view : toggle task info - Toggle task info view
`A` `A`
: task {selected} annotate {string} - Annotate current task : task {selected} annotate {string} - Annotate current task
Ctrl-e Ctrl-e
: scroll down task details - Scroll task details view down one line : scroll down task details - Scroll task details view down one line
Ctrl-y Ctrl-y
: scroll up task details - Scroll task details view up one line : scroll up task details - Scroll task details view up one line
`!` `!`
: {string} - Custom shell command : {string} - Custom shell command
`1-9` `1-9`
: {string} - Run user defined shortcuts : {string} - Run user defined shortcuts
`:` `:`
: {task id} - Jump to task id : {task id} - Jump to task id
`c` `c`
: context switcher menu - Open context switcher menu : context switcher menu - Open context switcher menu
`?` `?`
: help - Help menu : help - Help menu
Keybindings for filter / command prompt: Keybindings for filter / command prompt:
`Ctrl + f | Right` `Ctrl + f | Right`
: move forward - Move forward one character : move forward - Move forward one character
`Ctrl + b | Left` `Ctrl + b | Left`
: move backward - Move backward one character : move backward - Move backward one character
`Ctrl + h | Backspace` `Ctrl + h | Backspace`
: backspace - Delete one character back : backspace - Delete one character back
`Ctrl + d | Delete` `Ctrl + d | Delete`
: delete - Delete one character forward : delete - Delete one character forward
`Ctrl + a | Home` `Ctrl + a | Home`
: home - Go to the beginning of line : home - Go to the beginning of line
`Ctrl + e | End` `Ctrl + e | End`
: end - Go to the end of line : end - Go to the end of line
`Ctrl + k` `Ctrl + k`
: delete to end - Delete to the end of line : delete to end - Delete to the end of line
`Ctrl + u` `Ctrl + u`
: delete to beginning - Delete to the beginning of line : delete to beginning - Delete to the beginning of line
`Ctrl + w` `Ctrl + w`
: delete previous word - Delete previous word : delete previous word - Delete previous word
`Alt + d` `Alt + d`
: delete next word - Delete next word : delete next word - Delete next word
`Alt + b` `Alt + b`
: move to previous word - Move to previous word : move to previous word - Move to previous word
`Alt + f` `Alt + f`
: move to next word - Move to next word : move to next word - Move to next word
`Alt + t` `Alt + t`
: transpose words - Transpose words : transpose words - Transpose words
`Up` `Up`
: scroll history - Go backward in history matching from beginning of line to cursor : scroll history - Go backward in history matching from beginning of line to cursor
`Down` `Down`
: scroll history - Go forward in history matching from beginning of line to cursor : scroll history - Go forward in history matching from beginning of line to cursor
`TAB | Ctrl + n` `TAB | Ctrl + n`
: tab complete - Open tab completion and selection first element OR cycle to next element : tab complete - Open tab completion and selection first element OR cycle to next element
`BACKTAB | Ctrl + p` `BACKTAB | Ctrl + p`
: tab complete - Cycle to previous element : tab complete - Cycle to previous element
Keybindings for context switcher: Keybindings for context switcher:
`j` `j`
: {selected+=1} - Move forward a context : {selected+=1} - Move forward a context
`k` `k`
: {selected-=1} - Move back a context : {selected-=1} - Move back a context
Keybindings for calendar: Keybindings for calendar:
`j` `j`
: {selected+=1} - Move forward a year in calendar : {selected+=1} - Move forward a year in calendar
`k` `k`
: {selected-=1} - Move back a year in calendar : {selected-=1} - Move back a year in calendar
`J` `J`
: {selected+=10} - Move forward a decade in calendar : {selected+=10} - Move forward a decade in calendar
`K` `K`
: {selected-=10} - Move back a decade in calendar : {selected-=10} - Move back a decade in calendar
# EXIT STATUSES EXIT STATUSES
=============
0 0
: If everything goes OK. : If everything goes OK.
# AUTHOR
AUTHOR
======
`taskwarrior-tui` is maintained by Dheepak kdheepak Krishnamurthy and other contributors. `taskwarrior-tui` is maintained by Dheepak kdheepak Krishnamurthy and other contributors.