Mercurial > vim-lawrencium
annotate doc/lawrencium.txt @ 34:cfc15ff67aaf
Updated documentation.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Tue, 27 Dec 2011 23:56:55 -0800 |
| parents | 3a0f7bb6ea64 |
| children | a384b4aff211 |
| 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| | |
|
31
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
12 3. Status Window |lawrencium-status-window| |
| 0 | 13 |
| 13 | 14 |
| 15 ============================================================================= | |
| 16 1. Introduction *lawrencium-intro* | |
| 0 | 17 |
| 18 When a file from a Mercurial repository is open in a buffer, that buffer gets | |
| 19 new commands defined. | |
| 20 | |
| 13 | 21 This plugin is only available if 'compatible' is not set. |
| 22 | |
| 23 Grab the latest version or report a bug on BitBucket: | |
| 24 | |
| 25 http://bitbucket.org/ludovicchabant/vim-lawrencium | |
| 26 | |
| 27 | |
| 28 | |
| 29 ============================================================================= | |
| 30 2. Commands *lawrencium-commands* | |
| 0 | 31 |
| 32 All commands defined by |lawrencium| are local to each buffer. | |
| 33 | |
| 13 | 34 *:Hg* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
35 :Hg {args} Run an arbitrary Mercurial command. Similar to :!hg |
| 0 | 36 [args] but the '--repository' is automatically |
| 37 specified with the root of the repository the current | |
|
20
01932a36df03
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
13
diff
changeset
|
38 file belongs to, and it will auto-complete any |
|
01932a36df03
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
13
diff
changeset
|
39 standard command or option. |
| 0 | 40 |
| 13 | 41 *:Hg!* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
42 :Hg! {args} Like |:Hg|, but the output of the command is placed in |
| 0 | 43 a temp file and edited in the |preview-window|. |
| 44 | |
| 13 | 45 *:Hgcd* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
46 :Hgcd[!] {path} |:cd| relative to the root of the repository. |
| 0 | 47 |
| 13 | 48 *:Hglcd* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
49 :Hglcd[!] {path} |:lcd| relative to the root of the repository. |
|
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
50 |
| 13 | 51 *:Hgedit* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
52 :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
|
53 |
| 13 | 54 *:Hgedit!* |
|
6
1da613c13d81
Better hg-status window.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
55 :Hgedit! {file} |:edit!| {file} relative to the root of the repository. |
| 0 | 56 |
| 13 | 57 *:Hgstatus* |
| 0 | 58 :Hgstatus Shows the output of 'hg status' in the |
|
31
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
59 |preview-window|. Some extra-commands, along with some |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
60 default mappins, are available in this window. See |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
61 |lawrencium-status-window|. |
| 13 | 62 |
| 63 *:Hgdiff* | |
| 64 :Hgdiff Diffs the current file against its parent revision. | |
| 65 | |
| 66 *:Hgdiff_f* | |
| 67 :Hgdiff {revspec} Diffs the current file against the specified revision. | |
| 68 | |
| 69 *:Hgvdiff* | |
| 70 :Hgvdiff Same as |:Hgdiff| but uses a vertical split. | |
| 71 | |
| 72 *:Hgvdiff_f* | |
| 73 :Hgvdiff {revspec} Same as |:Hgdiff_f| but uses a vertical split. | |
| 74 | |
| 75 *:Hgcommit* | |
| 76 :Hgcommit Opens a new window to edit a commit message into a | |
| 77 temporary file and, upon quitting the buffer, if that | |
| 78 file has been written to, commit the current changes | |
| 79 to the repository. | |
| 80 | |
| 81 *:Hgvcommit* | |
| 82 :Hgvcommit Same as |:Hgcommit| but uses a vertical split to edit | |
| 83 the commit message. | |
| 0 | 84 |
| 85 | |
| 86 | |
|
31
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
87 ============================================================================= |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
88 3. Status Window *lawrencium-status-window* |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
89 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
90 The `hg status` window opened by Lawrencium has a few special commands |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
91 defined in it. Also, unless the global `lawrencium_define_mappings` is set to |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
92 `0`, some commands are mapped to keyboard shortcuts, as detailed in the |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
93 following descriptions. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
94 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
95 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
96 *:Hgstatusedit* |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
97 :Hgstatusedit Open the file mentioned on the current line. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
98 Mapped to <cr>. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
99 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
100 *:Hgstatusaddremove* |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
101 :Hgstatusaddremove Run `hg addremove` on the file mentioned on the |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
102 current line, or on the lines currently selected in |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
103 visual selection mode (see |visual-start|). |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
104 Mapped to <C-A>. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
105 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
106 *:Hgstatusdiff* |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
107 :Hgstatusdiff Open a diff window on the file mentioned on the |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
108 current line, between the working directory version |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
109 and the parent revision version. Similar to running |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
110 |:Hgdiff| on that file. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
111 Mapped to <C-D>. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
112 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
113 *:Hgstatusvdiff* |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
114 :Hgstatusvdiff Similar to |:Hgstatusdiff|, but use a vertical split. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
115 Similar to running |:Hgvdiff| on that file. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
116 Mapped to <C-V>. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
117 |
|
34
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
118 *:Hgstatuscommit* |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
119 :Hgstatuscommit Runs |:Hgcommit| on the files currently mentioned in |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
120 the buffer, or in the current selection. The first |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
121 option means you can delete lines from the buffer |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
122 until the remaining filenames are those you want to |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
123 commit. |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
124 Mapped to <C-S>. |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
125 |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
126 *:Hgstatusvcommit* |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
127 :Hgstatusvcommit Similar to |:Hgstatuscommit|, but use a vertical |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
128 split, as with |:Hgvcommit|. |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
129 Not mapped byd default. |
|
cfc15ff67aaf
Updated documentation.
Ludovic Chabant <ludovic@chabant.com>
parents:
31
diff
changeset
|
130 |
|
31
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
131 *:Hgstatusrefresh* |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
132 :Hgstatusrefresh Refreshes the status window by running `hg status` |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
133 again. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
134 Mapped to <C-R>. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
135 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
136 *lawrencium-status-mappings* |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
137 A few other mappings are available in the status window: |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
138 |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
139 <C-N> Jump to the next filename. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
140 <C-P> Jump to the previous filename. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
141 q Quit the status window. |
|
3a0f7bb6ea64
Hgstatus window improvements and bug fixes:
Ludovic Chabant <ludovic@chabant.com>
parents:
20
diff
changeset
|
142 |
| 0 | 143 |
| 144 vim:tw=78:et:ft=help:norl: |