#pragma section-numbers 2
= Aurum =

Vim plugin providing Mercurial ↔ Vim integration

<<TableOfContents>>

== Status ==

'''This plugin is not distributed with Mercurial or Vim.'''

''Author: '' ''Nikolay Pavlov''

Repository: ''https://bitbucket.org/ZyX_I/aurum''

Web page: ''https://bitbucket.org/ZyX_I/aurum'', ''http://www.vim.org/scripts/script.php?script_id=3828''

~-Warning: do not edit the Overview section below by hand. It is generated by the script from the help file. Instead [[https://bitbucket.org/ZyX_I/aurum/issues/new|create an issue]].-~

== Overview ==

This plugin provides a vim <--> VCS (currently mercurial, git and subversion) integration for your projects. Features:

  * Partially committing changes ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuRecord|:AuRecord]]).

  * Viewing file state at particular revision ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#aurum%3A%2F%2Ffile|aurum://file]], [[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuFile|:AuFile]]).

  * Viewing uncommited changes in a vimdiff, as well as changes between     specific revisions ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuVimDiff|:AuVimDiff]]). It is also possible to open multiple     tabs with all changes to all files viewed as side-by-side diffs.

  * Viewing revisions log ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuLog|:AuLog]]). Output is highly customizable.

  * Viewing working directory status ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuStatus|:AuStatus]]).

  * Commiting changes ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuCommit|:AuCommit]]), commit messages are remembered in case of     rollback ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#g%3Aaurum_remembermsg|g:aurum_remembermsg]]).

  * Obtaining various URL’s out of remote repository URL (like URL of the HTML     version of the current file with URL fragment pointing to the current line     attached: useful for sharing) ([[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuHyperlink|:AuHyperlink]]). For mercurial it also     supports git and subversion revisions (in case you are using hg-git and     hgsubversion respectively).

  * [[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#aurum%23changeset%28%29|aurum#changeset()]], [[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#aurum%23repository%28%29|aurum#repository()]] and [[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#aurum%23status%28%29|aurum#status()]] functions     that are to be used from modeline.

  * Frontends for various other VCS commands.

Most commands can be reached with a set of mappings (see [[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#aurum-mappings|aurum-mappings]]), all mappings are customizable.


Plugin’s mercurial driver is able to use mercurial python API as well as its CLI, but remember that the former is much slower and less tested. In order to use mercurial python API you must have vim compiled with +python (mercurial currently does not support python 3) and have mercurial in python’s sys.path (note: on windows msi installer is not adding mercurial to sys.path, so you won’t be able to use its python API).


Plugin requires some additional plugins:

  * [[https://bitbucket.org/ZyX_I/frawor|frawor]]

  * (optional) [[https://bitbucket.org/ZyX_I/ansi_esc_echo|ansi_esc_echo]]

  * (optional) one of

      * [[http://www.vim.org/scripts/script.php?script_id=3025|Command-T]]

      * [[http://www.vim.org/scripts/script.php?script_id=3736|ctrlp]]

      * [[http://www.vim.org/scripts/script.php?script_id=1984|FuzzyFinder]]

      * [[http://www.vim.org/scripts/script.php?script_id=3396|unite]]

      * [[http://www.vim.org/scripts/script.php?script_id=2337|ku]]

      * [[http://www.vim.org/scripts/script.php?script_id=1863|tlib]]

    for [[http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#%3AAuFile|:AuFile]] prompt option and a number of OpenAny/AnnotateAny mappings.

(with their dependencies).


Note: aurum supports [[https://github.com/MarcWeber/vim-addon-manager|VAM]]. It       is prefered that you use it for aurum installation.


== Configuration ==
This plugin does not require any modifications to .hgrc. You can use [[http://www.vim.org/scripts/script.php?script_id=2905|vim-addon-manager]] to install it or manually clone https://bitbucket.org/ZyX_I/aurum and https://bitbucket.org/ZyX_I/frawor somewhere and add
{{{#!viml
set rtp+=/path/to/aurum,/path/to/frawor
}}}
to your vimrc.