Mercurial > vim-lawrencium
comparison doc/lawrencium.txt @ 60:137d5c895659
Updated documentation.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Wed, 14 Nov 2012 22:31:33 -0800 |
parents | 2b3fb72d5471 |
children | 02a1be804fe8 |
comparison
equal
deleted
inserted
replaced
59:396da6e76952 | 60:137d5c895659 |
---|---|
26 | 26 |
27 1. Introduction |lawrencium-intro| | 27 1. Introduction |lawrencium-intro| |
28 2. Commands |lawrencium-commands| | 28 2. Commands |lawrencium-commands| |
29 3. Status Window |lawrencium-status-window| | 29 3. Status Window |lawrencium-status-window| |
30 4. Log Window |lawrencium-log-window| | 30 4. Log Window |lawrencium-log-window| |
31 5. Global Settings |lawrencium-global-settings| | 31 5. Annotate Window |lawrencium-annotate-window| |
32 6. Global Settings |lawrencium-global-settings| | |
32 | 33 |
33 | 34 |
34 ============================================================================= | 35 ============================================================================= |
35 1. Introduction *lawrencium-intro* | 36 1. Introduction *lawrencium-intro* |
36 | 37 |
166 :Hgrepolog Opens the history (log) for the whole repository in a | 167 :Hgrepolog Opens the history (log) for the whole repository in a |
167 split window. Some extra-commands, along with some | 168 split window. Some extra-commands, along with some |
168 default mappings, are available in this window. | 169 default mappings, are available in this window. |
169 See |lawrencium-log-window|. | 170 See |lawrencium-log-window|. |
170 | 171 |
172 *:Hgannotate* | |
173 :Hgannotate Splits the current window to show annotations in the | |
174 left window. These annotation are retrieved with `hg | |
175 annotate`. | |
176 If the current file has local edits, the full output | |
177 of `hg annotate` will be opened instead, which is the | |
178 annotated parent revision. | |
179 Some extra-commands, along with some default mappings, | |
180 are available in this window. | |
181 See |lawrencium-annotate-window|. | |
182 | |
171 | 183 |
172 ============================================================================= | 184 ============================================================================= |
173 3. Status Window *lawrencium-status-window* | 185 3. Status Window *lawrencium-status-window* |
174 | 186 |
175 The `hg status` window opened by Lawrencium has a few special commands | 187 The `hg status` window opened by Lawrencium has a few special commands |
197 | 209 |
198 *:Hgstatusvdiff* | 210 *:Hgstatusvdiff* |
199 :Hgstatusvdiff Similar to |:Hgstatusdiff|, but use a vertical split. | 211 :Hgstatusvdiff Similar to |:Hgstatusdiff|, but use a vertical split. |
200 Similar to running |:Hgvdiff| on that file. | 212 Similar to running |:Hgvdiff| on that file. |
201 Mapped to <CTRL-V>. | 213 Mapped to <CTRL-V>. |
214 | |
215 *:Hgstatusdiffsum* | |
216 :Hgstatusdiffsum Similar to |:Hgstatusdiff|, but show a diff summary, | |
217 like the one shown with |:Hgdiffsum|, instead of | |
218 running a full Vim diff. | |
219 Mapped to <CTRL-U>. | |
220 | |
221 *:Hgstatusvdiffsum* | |
222 :Hgstatusvdiffsum Similar to |:Hgstatusdiffsum|, but use a vertical | |
223 split. | |
224 Mapped to <CTRL-H>. | |
202 | 225 |
203 *:Hgstatuscommit* | 226 *:Hgstatuscommit* |
204 :Hgstatuscommit Runs |:Hgcommit| on the files currently mentioned in | 227 :Hgstatuscommit Runs |:Hgcommit| on the files currently mentioned in |
205 the buffer, or in the current selection. The first | 228 the buffer, or in the current selection. The first |
206 option means you can delete lines from the buffer | 229 option means you can delete lines from the buffer |
278 q Quit the log window. | 301 q Quit the log window. |
279 | 302 |
280 | 303 |
281 | 304 |
282 ============================================================================= | 305 ============================================================================= |
283 5. Global Settings *lawrencium-global-settings* | 306 5. Annotate Window *lawrencium-annotate-window* |
307 | |
308 The following commands are available in a |:Hgannotate| window along with the | |
309 specified keyboard mappings, unless the |lawrencium_define_mappings| setting | |
310 is set to `0`. | |
311 | |
312 *Hgannotatediffsum* | |
313 :Hgannotatediffsum Show a diff summary (similar to |:Hgdiffsum|) for the | |
314 revision mentioned under the cursor. | |
315 Mapped to |<CR>|. | |
316 | |
317 | |
318 | |
319 ============================================================================= | |
320 6. Global Settings *lawrencium-global-settings* | |
284 | 321 |
285 The following global settings can be defined in your |vimrc| to change the | 322 The following global settings can be defined in your |vimrc| to change the |
286 default behaviour of Lawrencium. | 323 default behaviour of Lawrencium. |
287 | 324 |
288 *lawrencium_hg_executable* | 325 *lawrencium_hg_executable* |
314 map to the following file types: | 351 map to the following file types: |
315 | 352 |
316 diff diff | 353 diff diff |
317 graphlog graphlog | 354 graphlog graphlog |
318 | 355 |
356 *lawrencium_annotate_width_offset* | |
357 g:lawrencium_annotate_width_offset | |
358 Specifies the offset to use when computing the width | |
359 of the annotations window (opened with |:Hgannotate|). | |
360 Defaults to 0. | |
361 This is useful for example if you have |'listchars'| | |
362 set to display characters at the window border when | |
363 unwrapped lines are extending outside. | |
319 | 364 |
320 vim:tw=78:et:ft=help:norl: | 365 vim:tw=78:et:ft=help:norl: |