diff options
author | David Chen <weichen2000121@gmail.com> | 2019-12-04 18:18:28 -0800 |
---|---|---|
committer | David Chen <weichen2000121@gmail.com> | 2019-12-04 18:18:28 -0800 |
commit | c50ab9872d1ef90bdbb79820f7ac391641e825cd (patch) | |
tree | aa3328dceb66ef22bffd9193b2a35663566a9546 /docs/Config.md | |
parent | fa6893fda9618fe36098f717a0a325e275c2fc74 (diff) |
update documentation for custom keybindings
Diffstat (limited to 'docs/Config.md')
-rw-r--r-- | docs/Config.md | 180 |
1 files changed, 180 insertions, 0 deletions
diff --git a/docs/Config.md b/docs/Config.md index 63a7beea8..1be7d43cd 100644 --- a/docs/Config.md +++ b/docs/Config.md @@ -30,6 +30,94 @@ days: 14 # how often an update is checked for reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined' confirmOnQuit: false + keybinding: + universal: + quit: 'q' + quit-alt1: '<c-c>' # alternative/alias of quit + return: '<esc>' # return to previous menu, will quit if there's nowhere to return + quitWithoutChangingDirectory: 'Q' + togglePanel: '<tab>' # goto the next panel + prevItem: '<up>' # go one line up + nextItem: '<down>' # go one line down + prevItem-alt: 'k' # go one line up + nextItem-alt: 'j' # go one line down + prevBlock: '<left>' # goto the previous block / panel + nextBlock: '<right>' # goto the next block / panel + prevBlock-alt: 'h' # goto the previous block / panel + nextBlock-alt: 'l' # goto the next block / panel + optionMenu: 'x' # show help menu + optionMenu-alt1: '?' # show help menu + select: '<space>' + remove: 'd' + new: 'n' + edit: 'e' + openFile: 'o' + scrollUpMain: '<pgup>' # main panel scrool up + scrollDownMain: '<pgdown>' # main panel scrool down + scrollUpMain-alt1: 'K' # main panel scrool up + scrollDownMain-alt1: 'J' # main panel scrool down + scrollUpMain-alt2: '<c-u>' # main panel scrool up + scrollDownMain-alt2: '<c-d>' # main panel scrool down + createRebaseOptionsMenu: 'm' + pushFiles: 'P' + pullFiles: 'p' + refresh: 'R' + createPatchOptionsMenu: '<c-p>' + status: + checkForUpdate: 'u' + recentRepos: 's' + files: + commitChanges: 'c' + commitChangesWithoutHook: 'w' # commit changes without pre-commit hook + amendLastCommit: 'A' + commitChangesWithEditor: 'C' + ignoreFile: 'i' + refreshFiles: 'r' + stashAllChanges: 's' + viewStashOptions: 'S' + toggleStagedAll: 'a' # stage/unstage all + viewResetOptions: 'D' + fetch: 'f' + executeCustomCommand: 'X' + branches: + createPullRequest: 'o' + checkoutBranchesByName: 'c' + forceCheckoutBranch: 'F' + rebaseBranch: 'r' + mergeIntoCurrentBranch: 'M' + FastForward: 'f' # fast-forward this branch from its upstream + pushTag: 'P' + nextBranchTab: ']' + prevBranchTab: '[' + setUpstream: 'u' # set as upstream of checked-out branch + commits: + squashDown: 's' + renameCommit: 'r' + renameCommitWithEditor: 'R' + resetToThisCommit: 'g' + fixupCommit: 'f' + createFixupCommit: 'F' # create fixup commit for this commit + squashAboveCommits: 'S' + moveDownCommit: '<c-j>' # move commit down one + moveUpCommit: '<c-k>' # move commit up one + amendToCommit: 'A' + pickCommit: 'p' # pick commit (when mid-rebase) + revertCommit: 't' + cherryPickCopy: 'c' + cherryPickCopyRange: 'C' + pasteCommits: 'v' + viewCommitFiles: '<enter>' + tagCommit: 'T' + stash: + popStash: 'g' + commitFiles: + checkoutCommitFile: 'c' + main: + toggleDragSelect: 'v' + toggleDragSelect-alt: 'V' + toggleSelectHunk: 'a' + PickBothHunks: 'b' + undo: 'z' ``` ## Platform Defaults: @@ -100,3 +188,95 @@ If you have issues with a light terminal theme where you can't read / see the te ## Example Coloring: ![border example](/docs/resources/colored-border-example.png) + +## For Colemak Users: +```yaml + keybinding: + universal: + quit: 'q' + quit-alt1: '<c-c>' # alternative/alias of quit + return: '<esc>' # return to previous menu, will quit if there's nowhere to return + quitWithoutChangingDirectory: 'Q' + togglePanel: '<tab>' # goto the next panel + prevItem: '<up>' # go one line up + nextItem: '<down>' # go one line down + prevItem-alt: 'k' # go one line up + nextItem-alt: 'j' # go one line down + prevBlock: '<left>' # goto the previous block / panel + nextBlock: '<right>' # goto the next block / panel + prevBlock-alt: 'h' # goto the previous block / panel + nextBlock-alt: 'l' # goto the next block / panel + optionMenu: 'x' # show help menu + optionMenu-alt1: '?' # show help menu + select: '<space>' + remove: 'd' + new: 'n' + edit: 'e' + openFile: 'o' + scrollUpMain: '<pgup>' # main panel scrool up + scrollDownMain: '<pgdown>' # main panel scrool down + scrollUpMain-alt1: 'K' # main panel scrool up + scrollDownMain-alt1: 'J' # main panel scrool down + scrollUpMain-alt2: '<c-u>' # main panel scrool up + scrollDownMain-alt2: '<c-d>' # main panel scrool down + createRebaseOptionsMenu: 'm' + pushFiles: 'P' + pullFiles: 'p' + refresh: 'R' + createPatchOptionsMenu: '<c-p>' + status: + checkForUpdate: 'u' + recentRepos: 's' + files: + commitChanges: 'c' + commitChangesWithoutHook: 'w' # commit changes without pre-commit hook + amendLastCommit: 'A' + commitChangesWithEditor: 'C' + ignoreFile: 'i' + refreshFiles: 'r' + stashAllChanges: 's' + viewStashOptions: 'S' + toggleStagedAll: 'a' # stage/unstage all + viewResetOptions: 'D' + fetch: 'f' + executeCustomCommand: 'X' + branches: + createPullRequest: 'o' + checkoutBranchesByName: 'c' + forceCheckoutBranch: 'F' + rebaseBranch: 'r' + mergeIntoCurrentBranch: 'M' + FastForward: 'f' # fast-forward this branch from its upstream + pushTag: 'P' + nextBranchTab: ']' + prevBranchTab: '[' + setUpstream: 'u' # set as upstream of checked-out branch + commits: + squashDown: 's' + renameCommit: 'r' + renameCommitWithEditor: 'R' + resetToThisCommit: 'g' + fixupCommit: 'f' + createFixupCommit: 'F' # create fixup commit for this commit + squashAboveCommits: 'S' + moveDownCommit: '<c-j>' # move commit down one + moveUpCommit: '<c-k>' # move commit up one + amendToCommit: 'A' + pickCommit: 'p' # pick commit (when mid-rebase) + revertCommit: 't' + cherryPickCopy: 'c' + cherryPickCopyRange: 'C' + pasteCommits: 'v' + viewCommitFiles: '<enter>' + tagCommit: 'T' + stash: + popStash: 'g' + commitFiles: + checkoutCommitFile: 'c' + main: + toggleDragSelect: 'v' + toggleDragSelect-alt: 'V' + toggleSelectHunk: 'a' + PickBothHunks: 'b' + undo: 'z' +``` |