# HG changeset patch # User Steve Losh # Date 1308016434 14400 # Node ID dadef6acf2190e8e4dde83eaffefd51dc814353e # Parent 566ffcc452e2d51c823c5483337ce7a148982ec1 Seriously, Vim? God damn it. diff -r 566ffcc452e2 -r dadef6acf219 doc/threesome.txt --- a/doc/threesome.txt Mon Jun 13 21:49:25 2011 -0400 +++ b/doc/threesome.txt Mon Jun 13 21:53:54 2011 -0400 @@ -26,37 +26,37 @@ CONTENTS *Threesome-contents* 1. Version Control Integration ................. |ThreesomeVCS| - 1.1 Mercurial .............................. |ThreesomeVCS-hg| - 1.2 Git .................................... |ThreesomeVCS-git| + 1.1 Mercurial .............................. |ThreesomeVCS_hg| + 1.2 Git .................................... |ThreesomeVCS_git| 2. Basic Usage ................................. |ThreesomeUsage| - 2.1 Files .................................. |ThreesomeUsage-files| - 2.2 Modes .................................. |ThreesomeUsage-modes| + 2.1 Files .................................. |ThreesomeUsage_files| + 2.2 Modes .................................. |ThreesomeUsage_modes| 3. Key Bindings ................................ |ThreesomeKeys| - 3.1 Mode Selection Keys .................... |ThreesomeKeys-mode| - 3.2 File Selection Keys .................... |ThreesomeKeys-file| - 3.3 Other Keys ............................. |ThreesomeKeys-other| + 3.1 Mode Selection Keys .................... |ThreesomeKeys_mode| + 3.2 File Selection Keys .................... |ThreesomeKeys_file| + 3.3 Other Keys ............................. |ThreesomeKeys_other| 4. Modes ....................................... |ThreesomeModes| - 4.1 Grid ................................... |ThreesomeModes-grid| - 4.2 Loupe .................................. |ThreesomeModes-loupe| - 4.3 Compare ................................ |ThreesomeModes-compare| - 4.4 Path ................................... |ThreesomeModes-path| + 4.1 Grid ................................... |ThreesomeModes_grid| + 4.2 Loupe .................................. |ThreesomeModes_loupe| + 4.3 Compare ................................ |ThreesomeModes_compare| + 4.4 Path ................................... |ThreesomeModes_path| 5. Configuration ............................... |ThreesomeConfig| - 5.1 threesome_debug ........................ |ThreesomeConfig-debug| - 5.2 threesome_disable ...................... |ThreesomeConfig-disable| - 5.3 threesome_initial_diff_grid ............ |ThreesomeConfig-id_grid| - 5.4 threesome_initial_diff_loupe ........... |ThreesomeConfig-id_loupe| - 5.5 threesome_initial_diff_compare ......... |ThreesomeConfig-id_compare| - 5.6 threesome_initial_diff_path ............ |ThreesomeConfig-id_path| - 5.7 threesome_initial_layout_grid .......... |ThreesomeConfig-il_grid| - 5.8 threesome_initial_layout_loupe ......... |ThreesomeConfig-il_loupe| - 5.9 threesome_initial_layout_compare ....... |ThreesomeConfig-il_compare| - 5.10 threesome_initial_layout_path ......... |ThreesomeConfig-il_path| - 5.11 threesome_initial_scrollbind_grid ..... |ThreesomeConfig-is_grid| - 5.12 threesome_initial_scrollbind_loupe .... |ThreesomeConfig-is_loupe| - 5.13 threesome_initial_scrollbind_compare .. |ThreesomeConfig-is_compare| - 5.14 threesome_initial_scrollbind_path ..... |ThreesomeConfig-is_path| - 5.15 threesome_initial_mode ................ |ThreesomeConfig-im| - 5.16 threesome_wrap ........................ |ThreesomeConfig-wrap| + 5.1 threesome_debug ........................ |ThreesomeConfig_debug| + 5.2 threesome_disable ...................... |ThreesomeConfig_disable| + 5.3 threesome_initial_diff_grid ............ |ThreesomeConfig_id_grid| + 5.4 threesome_initial_diff_loupe ........... |ThreesomeConfig_id_loupe| + 5.5 threesome_initial_diff_compare ......... |ThreesomeConfig_id_compare| + 5.6 threesome_initial_diff_path ............ |ThreesomeConfig_id_path| + 5.7 threesome_initial_layout_grid .......... |ThreesomeConfig_il_grid| + 5.8 threesome_initial_layout_loupe ......... |ThreesomeConfig_il_loupe| + 5.9 threesome_initial_layout_compare ....... |ThreesomeConfig_il_compare| + 5.10 threesome_initial_layout_path ......... |ThreesomeConfig_il_path| + 5.11 threesome_initial_scrollbind_grid ..... |ThreesomeConfig_is_grid| + 5.12 threesome_initial_scrollbind_loupe .... |ThreesomeConfig_is_loupe| + 5.13 threesome_initial_scrollbind_compare .. |ThreesomeConfig_is_compare| + 5.14 threesome_initial_scrollbind_path ..... |ThreesomeConfig_is_path| + 5.15 threesome_initial_mode ................ |ThreesomeConfig_im| + 5.16 threesome_wrap ........................ |ThreesomeConfig_wrap| 6. License ..................................... |ThreesomeLicense| 7. Bugs ........................................ |ThreesomeBugs| 8. Contributing ................................ |ThreesomeContributing| @@ -75,7 +75,7 @@ "vim" in the following commands with your choice of "mvim" or "gvim". ------------------------------------------------------------------------------ -1.1 Mercurial *ThreesomeVCS-hg* +1.1 Mercurial *ThreesomeVCS_hg* Add the following lines to "~/.hgrc": > @@ -89,7 +89,7 @@ which need to be resolved. ------------------------------------------------------------------------------ -1.2 Git *ThreesomeVCS-git* +1.2 Git *ThreesomeVCS_git* Add the following lines to "~/.gitconfig": > @@ -120,54 +120,54 @@ Threesome has several "modes" to help you work with the various files. ------------------------------------------------------------------------------ -2.1 Files *ThreesomeUsage-files* +2.1 Files *ThreesomeUsage_files* When resolving a merge there are four files you will work with: -Original *ThreesomeUsage-files-original* +Original *ThreesomeUsage_files_original* The original file, as it appears in the parent revision of the two revisions being merged. -One *ThreesomeUsage-files-one* +One *ThreesomeUsage_files_one* The file as it appears in the first revision being merged. This is usually the "current" revision, or the one you are at when you run "hg merge REV"). -Two *ThreesomeUsage-files-two* +Two *ThreesomeUsage_files_two* The file as it appears in the second revision being merged. This is usually the "target" revision, or the one you specify in the "hg merge REV" command). -Result *ThreesomeUsage-files-result* +Result *ThreesomeUsage_files_result* The result of merging the two revisions of the file. This is the file that your version control system expects to contain the final result once you're done. ------------------------------------------------------------------------------ -2.2 Modes *ThreesomeUsage-modes* +2.2 Modes *ThreesomeUsage_modes* Threesome has four "modes" or "views" for working with the files. -Grid *ThreesomeUsage-modes-grid* +Grid *ThreesomeUsage_modes_grid* Shows all four files at once to give you an overview of the merge. See |ThreesomeModes-grid| for more information. -Loupe *ThreesomeUsage-modes-loupe* +Loupe *ThreesomeUsage_modes_loupe* Shows a single file at a time for close examination of a single file. See |ThreesomeModes-loupe| for more information. -Compare *ThreesomeUsage-modes-compare* +Compare *ThreesomeUsage_modes_compare* Shows two files at a time for examining the movement of changes between pairs of files. See |ThreesomeModes-compare| for more information. -Path *ThreesomeUsage-modes-path* +Path *ThreesomeUsage_modes_path* Shows three files at a time: - The original @@ -194,7 +194,7 @@ effects should be fairly intuitive. ------------------------------------------------------------------------------ -3.1 Mode Selection Keys *ThreesomeKeys-mode* +3.1 Mode Selection Keys *ThreesomeKeys_mode* g *Grid* Switch to grid view. @@ -209,7 +209,7 @@ Switch to path view. ------------------------------------------------------------------------------ -3.2 File Selection Keys *ThreesomeKeys-file* +3.2 File Selection Keys *ThreesomeKeys_file* o *Original* Select the original file. @@ -224,7 +224,7 @@ Select the result file. ------------------------------------------------------------------------------ -3.3 Other Keys *ThreesomeKeys-other* +3.3 Other Keys *ThreesomeKeys_other* d *Diff* Cycle through various diff combinations. @@ -267,12 +267,12 @@ This section describes each mode in detail. ------------------------------------------------------------------------------ -4.1 Grid *ThreesomeModes-grid* +4.1 Grid *ThreesomeModes_grid* The grid view is used to get an overview of all files at once to get a birds' eye view of the merge. -Grid Layouts *ThreesomeModes-grid-layouts* +Grid Layouts *ThreesomeModes_grid_layouts* ------------ Layout 0 Layout 1 Layout 2 @@ -287,7 +287,7 @@ | | | | | | | | +-------------------+ +--------------------------+ +---------------+ -Grid-Specific Key Bindings *ThreesomeModes-grid-keys* +Grid-Specific Key Bindings *ThreesomeModes_grid_keys* -------------------------- o *Original-Grid* @@ -302,18 +302,18 @@ u2 *UseHunk2-Grid* Place a hunk from file two into the result file. -Grid Diffs *ThreesomeModes-grid-diffs* +Grid Diffs *ThreesomeModes_grid_diffs* ---------- 1. No diff. 2. Diff all files. ------------------------------------------------------------------------------ -4.2 Loupe *ThreesomeModes-loupe* +4.2 Loupe *ThreesomeModes_loupe* The loupe view is used to focus on and examine a single file in detail. -Loupe Layouts *ThreesomeModes-loupe-layouts* +Loupe Layouts *ThreesomeModes_loupe_layouts* ------------- Layout 0 @@ -326,24 +326,24 @@ | | +-----------------+ -Loupe-Specific Key Bindings *ThreesomeModes-loupe-keys* +Loupe-Specific Key Bindings *ThreesomeModes_loupe_keys* --------------------------- u *UseHunk-Loupe* Disabled in this mode. -Loupe Diffs *ThreesomeModes-loupe-diffs* +Loupe Diffs *ThreesomeModes_loupe_diffs* ----------- No diffs are possible in loupe mode. ------------------------------------------------------------------------------ -4.3 Compare *ThreesomeModes-compare* +4.3 Compare *ThreesomeModes_compare* The compare view is used to examine the differences between two files at a time. -Compare Layouts *ThreesomeModes-compare-layouts* +Compare Layouts *ThreesomeModes_compare_layouts* --------------- Layout 0 Layout 1 @@ -359,7 +359,7 @@ | Two | Two | | | +-------------------+ +-------------------+ -Compare-Specific Key Bindings *ThreesomeModes-compare-keys* +Compare-Specific Key Bindings *ThreesomeModes_compare_keys* ----------------------------- u *UseHunk-Compare* @@ -367,19 +367,19 @@ both visible, place a hunk from one/two into the result file. Otherwise: disabled. -Compare Diffs *ThreesomeModes-compare-diffs* +Compare Diffs *ThreesomeModes_compare_diffs* ------------- 1. No diff. 2. Diff both files. ------------------------------------------------------------------------------ -4.4 Path *ThreesomeModes-path* +4.4 Path *ThreesomeModes_path* The path view is used to view the flow of changed through one "path" or "branch" of the merge. -Path Layouts *ThreesomeModes-path-layouts* +Path Layouts *ThreesomeModes_path_layouts* ------------ Layout 0 Layout 1 @@ -395,7 +395,7 @@ +--------------------------+ +-------------------+ -Path-Specific Key Bindings *ThreesomeModes-path-keys* +Path-Specific Key Bindings *ThreesomeModes_path_keys* -------------------------- u *UseHunk-Path* @@ -403,7 +403,7 @@ is currently in the center window) into the result file. -Path Diffs *ThreesomeModes-path-diffs* +Path Diffs *ThreesomeModes_path_diffs* ---------- 1. No diff. @@ -422,7 +422,7 @@ let g:threesome_initial_layout_compare = 1 ------------------------------------------------------------------------------ -5.1 g:threesome_debug *ThreesomeConfig-debug* +5.1 g:threesome_debug *ThreesomeConfig_debug* Set this to 1 to force Threesome to reload every time its file is sourced. @@ -430,7 +430,7 @@ Default: 0 (Threesome is loaded only once) ------------------------------------------------------------------------------ -5.2 g:threesome_disable *ThreesomeConfig-disable* +5.2 g:threesome_disable *ThreesomeConfig_disable* Set this to 1 to disable Threesome entirely. @@ -441,7 +441,7 @@ Default: 0 (Threesome is enabled as usual) ------------------------------------------------------------------------------ -5.3 g:threesome_initial_diff_grid *ThreesomeConfig-id_grid* +5.3 g:threesome_initial_diff_grid *ThreesomeConfig_id_grid* Set this to change the diff the grid mode starts in. @@ -451,7 +451,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.4 g:threesome_initial_diff_loupe *ThreesomeConfig-id_loupe* +5.4 g:threesome_initial_diff_loupe *ThreesomeConfig_id_loupe* Set this to change the diff the loupe mode starts in. @@ -461,7 +461,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.5 g:threesome_initial_diff_compare *ThreesomeConfig-id_compare* +5.5 g:threesome_initial_diff_compare *ThreesomeConfig_id_compare* Set this to change the diff the compare mode starts in. @@ -471,7 +471,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.6 g:threesome_initial_diff_path *ThreesomeConfig-id_path* +5.6 g:threesome_initial_diff_path *ThreesomeConfig_id_path* Set this to change the diff the path mode starts in. @@ -481,7 +481,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.7 g:threesome_initial_layout_grid *ThreesomeConfig-il_grid* +5.7 g:threesome_initial_layout_grid *ThreesomeConfig_il_grid* Set this to change the layout the grid mode starts in. @@ -491,7 +491,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.8 g:threesome_initial_layout_loupe *ThreesomeConfig-il_loupe* +5.8 g:threesome_initial_layout_loupe *ThreesomeConfig_il_loupe* Set this to change the layout the loupe mode starts in. @@ -501,7 +501,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.9 g:threesome_initial_layout_compare *ThreesomeConfig-il_compare* +5.9 g:threesome_initial_layout_compare *ThreesomeConfig_il_compare* Set this to change the layout the compare mode starts in. @@ -511,7 +511,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.10 g:threesome_initial_layout_path *ThreesomeConfig-il_path* +5.10 g:threesome_initial_layout_path *ThreesomeConfig_il_path* Set this to change the layout the path mode starts in. @@ -521,7 +521,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.11 g:threesome_initial_scrollbind_grid *ThreesomeConfig-is_grid* +5.11 g:threesome_initial_scrollbind_grid *ThreesomeConfig_is_grid* Set this to 1 to enable |scrollbind| by default in grid mode. @@ -529,7 +529,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.12 g:threesome_initial_scrollbind_loupe *ThreesomeConfig-is_loupe* +5.12 g:threesome_initial_scrollbind_loupe *ThreesomeConfig_is_loupe* Set this to 1 to enable |scrollbind| by default in loupe mode. @@ -537,7 +537,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.13 g:threesome_initial_scrollbind_compare *ThreesomeConfig-is_compare* +5.13 g:threesome_initial_scrollbind_compare *ThreesomeConfig_is_compare* Set this to 1 to enable |scrollbind| by default in compare mode. @@ -545,7 +545,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.14 g:threesome_initial_scrollbind_path *ThreesomeConfig-is_path* +5.14 g:threesome_initial_scrollbind_path *ThreesomeConfig_is_path* Set this to 1 to enable |scrollbind| by default in path mode. @@ -553,7 +553,7 @@ Default: 0 ------------------------------------------------------------------------------ -5.15 g:threesome_initial_mode *ThreesomeConfig-im* +5.15 g:threesome_initial_mode *ThreesomeConfig_im* Set this to change the mode Threesome initially starts up in. @@ -563,7 +563,7 @@ Default: "grid" ------------------------------------------------------------------------------ -5.16 g:threesome_wrap *ThreesomeConfig-wrap* +5.16 g:threesome_wrap *ThreesomeConfig_wrap* Set this to "wrap" or "nowrap" to set |wrap| or |nowrap| on all windows by default.