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