*p4python*	Perforce integration via P4Python API.

This plugin provides a fairly comprehensive Perforce integration
to Vim.  Most basic commands that are useful when working on 
single files are supported.

The plugin was tested against:
    Vim 7.2,7.3
    Perforce 2009.2,2010.1
    Mac/Linux/Windows, in GUI and terminal

INSTALLATION:
Make sure you satisfy the requirements described below, then:
    Add p4python.vim to your Vim plugin directory.
    Add p4python.txt to your Vim doc directory.
    Start Vim and type :helptags <vim doc directory>.
    Get help by :help p4python.

REQUIREMENTS:
    P4Python API 
    Properly configured Perforce environment in the current
        working directory
    If you want to use P4RevGraph, you'll need Perl and the
        Graph::Easy module.

If Vim is not compiled with Python support, the plugin will 
not load.  On Windows, the version of Python that Vim is
built against must be available.

If Vim is not compiled with Perl support, or the Graph::Easy
module is not available, P4RevGraph will fail.

If the P4Python API is not available, the plugin will not
load.

If the current directory does not have a Perforce environment,
then the plugin will load, but most commands would generate
error messages.

NOTES:
Originally this plugin was going to be very limited in scope.
However, the ease of adding functionality via P4Python 
encouraged me to keep adding more Perforce commands.  So,
almost all Perforce commands are now available via the menu,
with the exception of a few administrative and special purpose
commands.

The commands most commonly useful while working with a single
file are made available via keyboard mappings.  Other commands
are available via the menu.

Rather than adding support for every option of every command,
I picked the options that would be most useful or appropriate
while working on single files.  For instance, running the
'P4Branches' command returns a list of branches owned by the
current user.  More generally, the P4Run command lets you enter
an arbitrary Perforce command.

This plugin is not a replacement for a full featured Perforce
client program.  If you need to do graphical merges or use 
time-lapse view, try out P4V.

The P4RevGraph function tries to build an ASCII-art revision
graph, showing only direct integration records.  It may be
useful in some circumstances, but a complex integration
history will almost certainly generate a diagram that is
difficult to read and understand.  Again, if you need a real
revision graph capability, try P4V.

The plugin tries to get information from Perforce about every
file being edited.  If your Perforce connection is slow, you
can disable the BufRead calls.

COMMANDS:
Call the method "PluginHelp" for a list of available commands.

MAPPINGS:
<Leader>a P4Add
<Leader>b P4Branches()
<Leader>c P4Clients()
<Leader>d P4Delete()
<Leader>e P4Edit()
<Leader>f P4Fstat() 
<Leader>g P4Sync()
<Leader>h P4Filelog()
<Leader>i P4Info()
<Leader>k P4Diff()
<Leader>l P4Lock()
<Leader>n P4Annotate()
<Leader>o P4Opened()
<Leader>p PluginHelp()
<Leader>r P4Revert()
<Leader>s P4Submit()
<Leader>t P4Tag()
<Leader>u P4Unlock()
<Leader>w P4Where()
<Leader>x P4Fix()
<Leader>z P4Run()

COPYRIGHT:
Perforce and P4Python are copyright Perforce Software, Inc.

Copyright (c) Perforce Software, Inc., 1997-2010. All rights reserved

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1.  Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE
SOFTWARE, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.

User contributed content on the Perforce Public Depot is not supported by Perforce,
although it may be supported by its author. This applies to all contributions 
even those submitted by Perforce employees.