comparison doc/lawrencium.txt @ 13:298261c939b3

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