Mercurial > vim-lawrencium
annotate doc/lawrencium.txt @ 20:01932a36df03
Updated documentation.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Tue, 13 Dec 2011 17:35:50 -0800 |
| parents | 298261c939b3 |
| children | 3a0f7bb6ea64 |
| rev | line source |
|---|---|
| 0 | 1 *lawrencium.txt* Mercurial wrapper for VIM |
| 2 | |
| 13 | 3 |
| 4 LAWRENCIUM REFERENCE MANUAL | |
| 5 by Ludovic Chabant | |
| 6 | |
| 7 | |
| 8 *lawrencium* | |
| 0 | 9 |
| 13 | 10 1. Introduction |lawrencium-intro| |
| 11 2. Commands |lawrencium-commands| | |
| 0 | 12 |
| 13 | 13 |
| 14 ============================================================================= | |
| 15 1. Introduction *lawrencium-intro* | |
| 0 | 16 |
| 17 When a file from a Mercurial repository is open in a buffer, that buffer gets | |
| 18 new commands defined. | |
| 19 | |
| 13 | 20 This plugin is only available if 'compatible' is not set. |
| 21 | |
| 22 Grab the latest version or report a bug on BitBucket: | |
| 23 | |
| 24 http://bitbucket.org/ludovicchabant/vim-lawrencium | |
| 25 | |
| 26 | |
| 27 | |
| 28 ============================================================================= | |
| 29 2. Commands *lawrencium-commands* | |
| 0 | 30 |
| 31 All commands defined by |lawrencium| are local to each buffer. | |
| 32 | |
| 13 | 33 *:Hg* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
34 :Hg {args} Run an arbitrary Mercurial command. Similar to :!hg |
| 0 | 35 [args] but the '--repository' is automatically |
| 36 specified with the root of the repository the current | |
|
20
01932a36df03
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
13
diff
changeset
|
37 file belongs to, and it will auto-complete any |
|
01932a36df03
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
13
diff
changeset
|
38 standard command or option. |
| 0 | 39 |
| 13 | 40 *:Hg!* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
41 :Hg! {args} Like |:Hg|, but the output of the command is placed in |
| 0 | 42 a temp file and edited in the |preview-window|. |
| 43 | |
| 13 | 44 *:Hgcd* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
45 :Hgcd[!] {path} |:cd| relative to the root of the repository. |
| 0 | 46 |
| 13 | 47 *:Hglcd* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
48 :Hglcd[!] {path} |:lcd| relative to the root of the repository. |
|
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
49 |
| 13 | 50 *:Hgedit* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
51 :Hgedit {file} |:edit| {file} relative to the root of the repository. |
|
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
52 |
| 13 | 53 *:Hgedit!* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
54 :Hgedit! {file} |:edit!| {file} relative to the root of the repository. |
| 0 | 55 |
| 13 | 56 *:Hgstatus* |
| 0 | 57 :Hgstatus Shows the output of 'hg status' in the |
| 58 |preview-window|. | |
| 13 | 59 You can navigate to the next/previous file with <C-N> |
| 60 and <C-P>, open a file with <cr>, diff the local file | |
| 61 with the parent revision with <C-D> and <C-V>, | |
| 62 depending on whether you want a horizontal or vertical | |
|
20
01932a36df03
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
13
diff
changeset
|
63 split window, add an untracked file with <C-A>, and |
|
01932a36df03
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
13
diff
changeset
|
64 refresh the window with <C-R>. |
| 13 | 65 |
| 66 *:Hgdiff* | |
| 67 :Hgdiff Diffs the current file against its parent revision. | |
| 68 | |
| 69 *:Hgdiff_f* | |
| 70 :Hgdiff {revspec} Diffs the current file against the specified revision. | |
| 71 | |
| 72 *:Hgvdiff* | |
| 73 :Hgvdiff Same as |:Hgdiff| but uses a vertical split. | |
| 74 | |
| 75 *:Hgvdiff_f* | |
| 76 :Hgvdiff {revspec} Same as |:Hgdiff_f| but uses a vertical split. | |
| 77 | |
| 78 *:Hgcommit* | |
| 79 :Hgcommit Opens a new window to edit a commit message into a | |
| 80 temporary file and, upon quitting the buffer, if that | |
| 81 file has been written to, commit the current changes | |
| 82 to the repository. | |
| 83 | |
| 84 *:Hgvcommit* | |
| 85 :Hgvcommit Same as |:Hgcommit| but uses a vertical split to edit | |
| 86 the commit message. | |
| 0 | 87 |
| 88 | |
| 89 | |
| 90 | |
| 91 vim:tw=78:et:ft=help:norl: |