mercurial-crew-with-dirclash: contrib/vim/hgcommand.txt annotate

annotate contrib/vim/hgcommand.txt @ 2592:457846f400e8

Vim script: Adaptation from CVS to Mercurial

author	"Mathieu Clabaut <mathieu.clabaut@gmail.com>"
date	Mon, 10 Jul 2006 23:45:16 +0200
parents	61f2008cd6bf
children

rev	line source
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	1 hgcommand.txt HGCommand
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	2
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	3 For instructions on installing this file, type
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	4 :help add-local-help
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	5 inside Vim.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	6
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	7 Author: Mathieu Clabaut <mathieu.clabaut@gmail.com>
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	8 Credits: Bob Hiestand <bob.hiestand@gmail.com>
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	9
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	10 ==============================================================================
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	11 1. Contents hgcommand-contents
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	12
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	13 Installation : \|hgcommand-install\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	14 HGCommand Intro : \|hgcommand\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	15 HGCommand Manual : \|hgcommand-manual\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	16 Customization : \|hgcommand-customize\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	17 SSH "integration" : \|hgcommand-ssh\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	18 Bugs : \|hgcommand-bugs\|
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	19
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	20 ==============================================================================
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	21
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	22 2. HGCommand Installation hgcommand-install
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	23
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	24 The HGCommand plugin comprises two files, hgcommand.vim and hgcommand.txt
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	25 (this file). In order to install the plugin, place the hgcommand.vim file
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	26 into a plugin' directory in your runtime path (please see \|add-global-plugin\|
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	27 and \|'runtimepath'\|.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	28
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	29 HGCommand may be customized by setting variables, creating maps, and
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	30 specifying event handlers. Please see \|hgcommand-customize\| for more
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	31 details.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	32
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	33 This help file can be included in the VIM help system by copying it into a
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	34 'doc' directory in your runtime path and then executing the \|:helptags\|
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	35 command, specifying the full path of the 'doc' directory. Please see
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	36 \|add-local-help\| for more details.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	37
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	38 ==============================================================================
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	39
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	40 3. HGCommand Intro hgcommand
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	41 hgcommand-intro
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	42
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	43 The HGCommand plugin provides global ex commands for manipulating
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	44 HG-controlled source files. In general, each command operates on the current
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	45 buffer and accomplishes a separate hg function, such as update, commit, log,
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	46 and others (please see \|hgcommand-commands\| for a list of all available
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	47 commands). The results of each operation are displayed in a scratch buffer.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	48 Several buffer variables are defined for those scratch buffers (please see
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	49 \|hgcommand-buffer-variables\|).
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	50
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	51 The notion of "current file" means either the current buffer, or, in the case
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	52 of a directory buffer, the file on the current line within the buffer.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	53
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	54 For convenience, any HGCommand invoked on a HGCommand scratch buffer acts as
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	55 though it was invoked on the original file and splits the screen so that the
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	56 output appears in a new window.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	57
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	58 Many of the commands accept revisions as arguments. By default, most operate
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	59 on the most recent revision on the current branch if no revision is specified
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	60 (though see \|HGCommandInteractive\| to prompt instead).
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	61
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	62 Each HGCommand is mapped to a key sequence starting with the <Leader>
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	63 keystroke. The default mappings may be overridden by supplying different
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	64 mappings before the plugin is loaded, such as in the vimrc, in the standard
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	65 fashion for plugin mappings. For examples, please see
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	66 \|hgcommand-mappings-override\|.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	67
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	68 The HGCommand plugin may be configured in several ways. For more details,
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	69 please see \|hgcommand-customize\|.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	70
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	71 ==============================================================================
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	72
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	73 4. HGCommand Manual hgcommand-manual
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	74
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	75 4.1 HGCommand commands hgcommand-commands
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	76
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	77 HGCommand defines the following commands:
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	78
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	79 \|:HGAdd\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	80 \|:HGAnnotate\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	81 \|:HGCommit\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	82 \|:HGDiff\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	83 \|:HGGotoOriginal\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	84 \|:HGLog\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	85 \|:HGRevert\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	86 \|:HGReview\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	87 \|:HGStatus\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	88 \|:HGUnedit\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	89 \|:HGUpdate\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	90 \|:HGVimDiff\|
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	91
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	92 :HGAdd :HGAdd
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	93
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	94 This command performs "hg add" on the current file. Please note, this does
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	95 not commit the newly-added file.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	96
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	97 :HGAnnotate :HGAnnotate
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	98
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	99 This command performs "hg annotate" on the current file. If an argument is
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	100 given, the argument is used as a revision number to display. If not given an
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	101 argument, it uses the most recent version of the file on the current branch.
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	102 Additionally, if the current buffer is a HGAnnotate buffer already, the
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	103 version number on the current line is used.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	104
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	105 If the \|HGCommandAnnotateParent\| variable is set to a non-zero value, the
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	106 version previous to the one on the current line is used instead. This allows
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	107 one to navigate back to examine the previous version of a line.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	108
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	109 The filetype of the HGCommand scratch buffer is set to 'HGAnnotate', to take
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	110 advantage of the bundled syntax file.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	111
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	112
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	113 :HGCommit[!] :HGCommit
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	114
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	115 If called with arguments, this performs "hg commit" using the arguments as
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	116 the log message.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	117
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	118 If '!' is used with no arguments, an empty log message is committed.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	119
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	120 If called with no arguments, this is a two-step command. The first step opens
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	121 a buffer to accept a log message. When that buffer is written, it is
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	122 automatically closed and the file is committed using the information from that
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	123 log message. The commit can be abandoned if the log message buffer is deleted
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	124 or wiped before being written.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	125
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	126 Alternatively, the mapping that is used to invoke :HGCommit (by default
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	127 <Leader>hgc) can be used in the log message buffer to immediately commit.
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	128 This
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	129 is useful if the \|HGCommandCommitOnWrite\| variable is set to 0 to disable the
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	130 normal commit-on-write behavior.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	131
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	132 :HGDiff :HGDiff
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	133
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	134 With no arguments, this performs "hg diff" on the current file against the
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	135 current repository version.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	136
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	137 With one argument, "hg diff" is performed on the current file against the
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	138 specified revision.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	139
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	140 With two arguments, hg diff is performed between the specified
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	141 revisions of the current file.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	142
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	143 This command uses the 'HGCommandDiffOpt' variable to specify diff options.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	144 If that variable does not exist, then 'wbBc' is assumed. If you wish to have
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	145 no options, then set it to the empty string.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	146
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	147
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	148 This command performs "hg edit" on the current file.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	149
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	150 :HGGotoOriginal :HGGotoOriginal
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	151
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	152 This command returns the current window to the source buffer, if the current
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	153 buffer is a HG command output buffer.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	154
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	155 :HGGotoOriginal!
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	156
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	157 Like ":HGGotoOriginal" but also executes :bufwipeout on all HG command
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	158 output buffers for the source buffer.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	159
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	160 :HGLog :HGLog
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	161
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	162 Performs "hg log" on the current file.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	163
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	164 If an argument is given, it is passed as an argument to the "-r" option of
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	165 "hg log".
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	166
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	167 :HGRevert :HGRevert
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	168
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	169 Replaces the current file with the most recent version from the repository in
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	170 order to wipe out any undesired changes.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	171
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	172 :HGReview :HGReview
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	173
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	174 Retrieves a particular version of the current file. If no argument is given,
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	175 the most recent version of the file on the current branch is retrieved.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	176 Otherwise, the specified version is retrieved.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	177
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	178 :HGStatus :HGStatus
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	179
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	180 Performs "hg status" on the current file.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	181
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	182 :HGUnedit :HGUnedit
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	183
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	184 Performs "hg unedit" on the current file. Again, yes, the output buffer here
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	185 is basically useless.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	186
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	187 :HGUpdate :HGUpdate
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	188
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	189 Performs "hg update" on the current file. This intentionally does not
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	190 automatically reload the current buffer, though vim should prompt the user to
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	191 do so if the underlying file is altered by this command.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	192
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	193 :HGVimDiff :HGVimDiff
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	194
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	195 With no arguments, this prompts the user for a revision and then uses vimdiff
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	196 to display the differences between the current file and the specified
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	197 revision. If no revision is specified, the most recent version of the file on
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	198 the current branch is used.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	199
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	200 With one argument, that argument is used as the revision as above. With two
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	201 arguments, the differences between the two revisions is displayed using
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	202 vimdiff.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	203
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	204 With either zero or one argument, the original buffer is used to perform the
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	205 vimdiff. When the other buffer is closed, the original buffer will be
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	206 returned to normal mode.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	207
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	208 Once vimdiff mode is started using the above methods, additional vimdiff
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	209 buffers may be added by passing a single version argument to the command.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	210 There may be up to 4 vimdiff buffers total.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	211
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	212 Using the 2-argument form of the command resets the vimdiff to only those 2
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	213 versions. Additionally, invoking the command on a different file will close
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	214 the previous vimdiff buffers.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	215
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	216
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	217 4.2 Mappings hgcommand-mappings
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	218
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	219 By default, a mapping is defined for each command. These mappings execute the
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	220 default (no-argument) form of each command.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	221
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	222 <Leader>hga HGAdd
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	223 <Leader>hgn HGAnnotate
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	224 <Leader>hgc HGCommit
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	225 <Leader>hgd HGDiff
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	226 <Leader>hgg HGGotoOriginal
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	227 <Leader>hgG HGGotoOriginal!
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	228 <Leader>hgl HGLog
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	229 <Leader>hgr HGReview
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	230 <Leader>hgs HGStatus
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	231 <Leader>hgt HGUnedit
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	232 <Leader>hgu HGUpdate
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	233 <Leader>hgv HGVimDiff
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	234
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	235 hgcommand-mappings-override
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	236
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	237 The default mappings can be overriden by user-provided instead by mapping to
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	238 <Plug>CommandName. This is especially useful when these mappings collide with
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	239 other existing mappings (vim will warn of this during plugin initialization,
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	240 but will not clobber the existing mappings).
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	241
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	242 For instance, to override the default mapping for :HGAdd to set it to '\add',
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	243 add the following to the vimrc:
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	244
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	245 nmap \add <Plug>HGAdd
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	246
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	247 4.3 Automatic buffer variables hgcommand-buffer-variables
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	248
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	249 Several buffer variables are defined in each HGCommand result buffer. These
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	250 may be useful for additional customization in callbacks defined in the event
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	251 handlers (please see \|hgcommand-events\|).
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	252
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	253 The following variables are automatically defined:
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	254
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	255 b:hgOrigBuffNR b:hgOrigBuffNR
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	256
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	257 This variable is set to the buffer number of the source file.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	258
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	259 b:hgcmd b:hgcmd
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	260
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	261 This variable is set to the name of the hg command that created the result
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	262 buffer.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	263 ==============================================================================
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	264
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	265 5. Configuration and customization hgcommand-customize
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	266 hgcommand-config
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	267
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	268 The HGCommand plugin can be configured in two ways: by setting configuration
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	269 variables (see \|hgcommand-options\|) or by defining HGCommand event handlers
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	270 (see \|hgcommand-events\|). Additionally, the HGCommand plugin provides
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	271 several option for naming the HG result buffers (see \|hgcommand-naming\|) and
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	272 supported a customized status line (see \|hgcommand-statusline\| and
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	273 \|hgcommand-buffer-management\|).
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	274
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	275 5.1 HGCommand configuration variables hgcommand-options
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	276
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	277 Several variables affect the plugin's behavior. These variables are checked
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	278 at time of execution, and may be defined at the window, buffer, or global
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	279 level and are checked in that order of precedence.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	280
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	281
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	282 The following variables are available:
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	283
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	284 \|HGCommandAnnotateParent\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	285 \|HGCommandCommitOnWrite\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	286 \|HGCommandHGExec\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	287 \|HGCommandDeleteOnHide\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	288 \|HGCommandDiffOpt\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	289 \|HGCommandDiffSplit\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	290 \|HGCommandEdit\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	291 \|HGCommandEnableBufferSetup\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	292 \|HGCommandInteractive\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	293 \|HGCommandNameMarker\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	294 \|HGCommandNameResultBuffers\|
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	295 \|HGCommandSplit\|
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	296
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	297 HGCommandAnnotateParent HGCommandAnnotateParent
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	298
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	299 This variable, if set to a non-zero value, causes the zero-argument form of
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	300 HGAnnotate when invoked on a HGAnnotate buffer to go to the version previous
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	301 to that displayed on the current line. If not set, it defaults to 0.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	302
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	303 HGCommandCommitOnWrite HGCommandCommitOnWrite
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	304
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	305 This variable, if set to a non-zero value, causes the pending hg commit
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	306 to take place immediately as soon as the log message buffer is written.
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	307 If set to zero, only the HGCommit mapping will cause the pending commit to
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	308 occur. If not set, it defaults to 1.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	309
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	310 HGCommandHGExec HGCommandHGExec
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	311
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	312 This variable controls the executable used for all HG commands If not set,
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	313 it defaults to "hg".
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	314
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	315 HGCommandDeleteOnHide HGCommandDeleteOnHide
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	316
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	317 This variable, if set to a non-zero value, causes the temporary HG result
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	318 buffers to automatically delete themselves when hidden.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	319
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	320 HGCommandDiffOpt HGCommandDiffOpt
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	321
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	322 This variable, if set, determines the options passed to the diff command of
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	323 HG. If not set, it defaults to 'wbBc'.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	324
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	325 HGCommandDiffSplit HGCommandDiffSplit
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	326
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	327 This variable overrides the \|HGCommandSplit\| variable, but only for buffers
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	328 created with \|:HGVimDiff\|.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	329
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	330 HGCommandEdit HGCommandEdit
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	331
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	332 This variable controls whether the original buffer is replaced ('edit') or
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	333 split ('split'). If not set, it defaults to 'edit'.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	334
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	335 HGCommandEnableBufferSetup HGCommandEnableBufferSetup
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	336
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	337 This variable, if set to a non-zero value, activates HG buffer management
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	338 mode see (\|hgcommand-buffer-management\|). This mode means that two buffer
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	339 variables, 'HGRevision' and 'HGBranch', are set if the file is
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	340 HG-controlled. This is useful for displaying version information in the
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	341 status bar.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	342
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	343 HGCommandInteractive HGCommandInteractive
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	344
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	345 This variable, if set to a non-zero value, causes appropriate commands (for
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	346 the moment, only \|:HGReview\|) to query the user for a revision to use instead
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	347 of the current revision if none is specified.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	348
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	349 HGCommandNameMarker HGCommandNameMarker
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	350
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	351 This variable, if set, configures the special attention-getting characters
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	352 that appear on either side of the hg buffer type in the buffer name. This
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	353 has no effect unless \|HGCommandNameResultBuffers\| is set to a true value. If
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	354 not set, it defaults to '_'.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	355
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	356 HGCommandNameResultBuffers HGCommandNameResultBuffers
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	357
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	358 This variable, if set to a true value, causes the hg result buffers to be
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	359 named in the old way ('<source file name> _<hg command>_'). If not set
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	360 or set to a false value, the result buffer is nameless.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	361
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	362 HGCommandSplit HGCommandSplit
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	363
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	364 This variable controls the orientation of the various window splits that
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	365 may occur (such as with HGVimDiff, when using a HG command on a HG
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	366 command buffer, or when the \|HGCommandEdit\| variable is set to 'split'.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	367 If set to 'horizontal', the resulting windows will be on stacked on top of
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	368 one another. If set to 'vertical', the resulting windows will be
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	369 side-by-side. If not set, it defaults to 'horizontal' for all but
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	370 HGVimDiff windows.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	371
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	372 5.2 HGCommand events hgcommand-events
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	373
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	374 For additional customization, HGCommand can trigger user-defined events.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	375 Event handlers are provided by defining User event autocommands (see
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	376 \|autocommand\|, \|User\|) in the HGCommand group with patterns matching the
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	377 event name.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	378
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	379 For instance, the following could be added to the vimrc to provide a 'q'
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	380 mapping to quit a HGCommand scratch buffer:
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	381
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	382 augroup HGCommand
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	383 au HGCommand User HGBufferCreated silent! nmap <unique> <buffer> q: bwipeout<cr>
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	384 augroup END
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	385
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	386 The following hooks are available:
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	387
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	388 HGBufferCreated This event is fired just after a hg command
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	389 result buffer is created and filled with the
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	390 result of a hg command. It is executed within
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	391 the context of the HG command buffer. The
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	392 HGCommand buffer variables may be useful for
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	393 handlers of this event (please see
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	394 \|hgcommand-buffer-variables\|).
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	395
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	396 HGBufferSetup This event is fired just after HG buffer setup
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	397 occurs, if enabled.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	398
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	399 HGPluginInit This event is fired when the HGCommand plugin
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	400 first loads.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	401
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	402 HGPluginFinish This event is fired just after the HGCommand
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	403 plugin loads.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	404
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	405 HGVimDiffFinish This event is fired just after the HGVimDiff
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	406 command executes to allow customization of,
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	407 for instance, window placement and focus.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	408
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	409 5.3 HGCommand buffer naming hgcommand-naming
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	410
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	411 By default, the buffers containing the result of HG commands are nameless
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	412 scratch buffers. It is intended that buffer variables of those buffers be
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	413 used to customize the statusline option so that the user may fully control the
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	414 display of result buffers.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	415
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	416 If the old-style naming is desired, please enable the
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	417 \|HGCommandNameResultBuffers\| variable. Then, each result buffer will receive
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	418 a unique name that includes the source file name, the HG command, and any
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	419 extra data (such as revision numbers) that were part of the command.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	420
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	421 5.4 HGCommand status line support hgcommand-statusline
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	422
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	423 It is intended that the user will customize the \|'statusline'\| option to
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	424 include HG result buffer attributes. A sample function that may be used in
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	425 the \|'statusline'\| option is provided by the plugin, HGGetStatusLine(). In
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	426 order to use that function in the status line, do something like the
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	427 following:
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	428
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	429 set statusline=%<%f\ %{HGGetStatusLine()}\ %h%m%r%=%l,%c%V\ %P
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	430
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	431 of which %{HGGetStatusLine()} is the relevant portion.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	432
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	433 The sample HGGetStatusLine() function handles both HG result buffers and
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	434 HG-managed files if HGCommand buffer management is enabled (please see
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	435 \|hgcommand-buffer-management\|).
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	436
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	437 5.5 HGCommand buffer management hgcommand-buffer-management
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	438
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	439 The HGCommand plugin can operate in buffer management mode, which means that
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	440 it attempts to set two buffer variables ('HGRevision' and 'HGBranch') upon
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	441 entry into a buffer. This is rather slow because it means that 'hg status'
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	442 will be invoked at each entry into a buffer (during the \|BufEnter\|
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	443 autocommand).
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	444
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	445 This mode is disabled by default. In order to enable it, set the
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	446 \|HGCommandEnableBufferSetup\| variable to a true (non-zero) value. Enabling
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	447 this mode simply provides the buffer variables mentioned above. The user must
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	448 explicitly include those in the \|'statusline'\| option if they are to appear in
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	449 the status line (but see \|hgcommand-statusline\| for a simple way to do that).
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	450
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	451 ==============================================================================
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	452
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	453 6. SSH "integration" hgcommand-ssh
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	454
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	455 The following instructions are intended for use in integrating the
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	456 hgcommand.vim plugin with an SSH-based HG environment.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	457
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	458 Familiarity with SSH and HG are assumed.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	459
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	460 These instructions assume that the intent is to have a message box pop up in
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	461 order to allow the user to enter a passphrase. If, instead, the user is
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	462 comfortable using certificate-based authentication, then only instructions
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	463 6.1.1 and 6.1.2 (and optionally 6.1.4) need to be followed; ssh should then
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	464 work transparently.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	465
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	466 6.1 Environment settings hgcommand-ssh-env
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	467
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	468 6.1.1 HGROOT should be set to something like:
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	469
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	470 :ext:user@host:/path_to_repository
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	471
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	472 6.1.2 HG_RSH should be set to:
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	473
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	474 ssh
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	475
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	476 Together, those settings tell HG to use ssh as the transport when
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	477 performing HG calls.
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	478
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	479 6.1.3 SSH_ASKPASS should be set to the password-dialog program. In my case,
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	480 running gnome, it's set to:
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	481
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	482 /usr/libexec/openssh/gnome-ssh-askpass
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	483
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	484 This tells SSH how to get passwords if no input is available.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	485
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	486 6.1.4 OPTIONAL. You may need to set SSH_SERVER to the location of the hg
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	487 executable on the remote (server) machine.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	488
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	489 6.2 HG wrapper program hgcommand-ssh-wrapper
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	490
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	491 Now you need to convince SSH to use the password-dialog program. This means
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	492 you need to execute SSH (and therefore HG) without standard input. The
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	493 following script is a simple perl wrapper that dissasociates the HG command
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	494 from the current terminal. Specific steps to do this may vary from system to
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	495 system; the following example works for me on linux.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	496
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	497 #!/usr/bin/perl -w
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	498 use strict;
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	499 use POSIX qw(setsid);
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	500 open STDIN, '/dev/null';
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	501 fork and do {wait; exit;};
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	502 setsid;
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	503 exec('hg', @ARGV);
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	504
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	505 6.3 Configuring hgcommand.vim hgcommand-ssh-config
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	506
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	507 At this point, you should be able to use your wrapper script to invoke HG with
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	508 various commands, and get the password dialog. All that's left is to make HG
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	509 use your newly-created wrapper script.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	510
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	511 6.3.1 Tell hgcommand.vim what HG executable to use. The easiest way to do this
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	512 is globally, by putting the following in your .vimrc:
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	513
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	514 let HGCommandHGExec=/path/to/hg/wrapper/script
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	515
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	516 6.4 Where to go from here hgcommand-ssh-other
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	517
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	518 The script given above works even when non-SSH HG connections are used,
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	519 except possibly when interactively entering the message for HG commit log
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	520 (depending on the editor you use... VIM works fine). Since the hgcommand.vim
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	521 plugin handles that message without a terminal, the wrapper script can be used
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	522 all the time.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	523
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	524 This allows mixed-mode operation, where some work is done with SSH-based HG
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	525 repositories, and others with pserver or local access.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	526
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	527 It is possible, though beyond the scope of the plugin, to dynamically set the
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	528 HG executable based on the HGROOT for the file being edited. The user
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	529 events provided (such as HGBufferCreated and HGBufferSetup) can be used to
457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	530 set a buffer-local value (b:HGCommandHGExec) to override the HG executable
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	531 on a file-by-file basis. Alternatively, much the same can be done (less
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	532 automatically) by the various project-oriented plugins out there.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	533
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	534 It is highly recommended for ease-of-use that certificates with no passphrase
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	535 or ssh-agent are employed so that the user is not given the password prompt
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	536 too often.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	537
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	538 ==============================================================================
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	539 9. Tips hgcommand-tips
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	540
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	541 9.1 Split window annotation, by Michael Anderson
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	542
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	543 :nmap <Leader>hgN :vs<CR><C-w>h<Leader>hgn:vertical res 40<CR>
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	544 \ggdddd:set scb<CR>:set nowrap<CR><C-w>lgg:set scb<CR>
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	545 \:set nowrap<CR>
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	546
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	547 This splits the buffer vertically, puts an annotation on the left (minus the
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	548 header) with the width set to 40. An editable/normal copy is placed on the
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	549 right. The two versions are scroll locked so they move as one. and wrapping
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	550 is turned off so that the lines line up correctly. The advantages are...
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	551
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	552 1) You get a versioning on the right.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	553 2) You can still edit your own code.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	554 3) Your own code still has syntax highlighting.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	555
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	556 ==============================================================================
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	557
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	558 8. Known bugs hgcommand-bugs
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	559
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	560 Please let me know if you run across any.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	561
2592 457846f400e8 Vim script: Adaptation from CVS to Mercurial "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: 2591 diff changeset	562 HGVimDiff, when using the original (real) source buffer as one of the diff
2591 61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	563 buffers, uses some hacks to try to restore the state of the original buffer
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	564 when the scratch buffer containing the other version is destroyed. There may
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	565 still be bugs in here, depending on many configuration details.
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	566
61f2008cd6bf Addition of CVScommand vim script as a base for HGcommand "Mathieu Clabaut <mathieu.clabaut@gmail.com>" parents: diff changeset	567 vim:tw=78:ts=8:ft=help

Mercurial > hg > mercurial-crew-with-dirclash

annotate contrib/vim/hgcommand.txt @ 2592:457846f400e8