<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Using plugins — Bazaar 2.6.0 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/bzr.ico"/>
<link rel="top" title="Bazaar 2.6.0 documentation" href="../index.html" />
<link rel="up" title="Bazaar User Guide" href="index.html" />
<link rel="next" title="Bazaar Zen" href="zen.html" />
<link rel="prev" title="Using aliases" href="using_aliases.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="zen.html" title="Bazaar Zen"
accesskey="N">next</a></li>
<li class="right" >
<a href="using_aliases.html" title="Using aliases"
accesskey="P">previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="../_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li><a href="../index.html">Table of Contents (2.6.0)</a> »</li>
<li><a href="index.html" accesskey="U">Bazaar User Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="using-plugins">
<h1>Using plugins<a class="headerlink" href="#using-plugins" title="Permalink to this headline">¶</a></h1>
<div class="section" id="what-is-a-plugin">
<h2>What is a plugin?<a class="headerlink" href="#what-is-a-plugin" title="Permalink to this headline">¶</a></h2>
<p>A plugin is an external component for Bazaar that is typically made by
third parties. A plugin is capable of augmenting Bazaar by adding new
functionality. A plugin can also change current Bazaar behavior by
replacing current functionality. Sample applications of plugins are:</p>
<ul class="simple">
<li>overriding commands</li>
<li>adding new commands</li>
<li>providing additional network transports</li>
<li>customizing log output.</li>
</ul>
<p>The sky is the limit for the customization that can be done through plugins.
In fact, plugins often work as a way for developers to test new features for
Bazaar prior to inclusion in the official codebase. Plugins are helpful
at feature retirement time as well, e.g. deprecated file formats may one
day be removed from the Bazaar core and be made available as a plugin instead.</p>
<p>Plugins are good for users, good for external developers and good for
Bazaar itself.</p>
</div>
<div class="section" id="where-to-find-plugins">
<h2>Where to find plugins<a class="headerlink" href="#where-to-find-plugins" title="Permalink to this headline">¶</a></h2>
<p>We keep our list of plugins on the <a class="reference external" href="http://wiki.bazaar.canonical.com/BzrPlugins">http://wiki.bazaar.canonical.com/BzrPlugins</a> page.</p>
</div>
<div class="section" id="how-to-install-a-plugin">
<h2>How to install a plugin<a class="headerlink" href="#how-to-install-a-plugin" title="Permalink to this headline">¶</a></h2>
<p>Installing a plugin is very easy! If not already created, create a
<tt class="docutils literal"><span class="pre">plugins</span></tt> directory under your Bazaar configuration directory,
<tt class="docutils literal"><span class="pre">~/.bazaar/</span></tt> on Unix and
<tt class="docutils literal"><span class="pre">C:\Documents</span> <span class="pre">and</span> <span class="pre">Settings\<username>\Application</span> <span class="pre">Data\Bazaar\2.0\</span></tt>
on Windows. Within this directory (referred to as $BZR_HOME below),
each plugin is placed in its own subdirectory.</p>
<p>Plugins work particularly well with Bazaar branches. For example, to
install the bzrtools plugins for your main user account on GNU/Linux,
one can perform the following:</p>
<div class="highlight-python"><div class="highlight"><pre>bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
~/.bazaar/plugins/bzrtools
</pre></div>
</div>
<p>When installing plugins, the directories that you install them in must
be valid python identifiers. This means that they can only contain
certain characters, notably they cannot contain hyphens (<tt class="docutils literal"><span class="pre">-</span></tt>). Rather
than installing <tt class="docutils literal"><span class="pre">bzr-gtk</span></tt> to <tt class="docutils literal"><span class="pre">$BZR_HOME/plugins/bzr-gtk</span></tt>, install it
to <tt class="docutils literal"><span class="pre">$BZR_HOME/plugins/gtk</span></tt>.</p>
</div>
<div class="section" id="alternative-plugin-locations">
<h2>Alternative plugin locations<a class="headerlink" href="#alternative-plugin-locations" title="Permalink to this headline">¶</a></h2>
<p>If you have the necessary permissions, plugins can also be installed on a
system-wide basis. One can additionally override the personal plugins
location by setting the environment variable <tt class="docutils literal"><span class="pre">BZR_PLUGIN_PATH</span></tt> (see <a class="reference external" href="../user-reference/configuration-help.html#bzr-plugin-path">User
Reference</a>
for a detailed explanation).</p>
</div>
<div class="section" id="listing-the-installed-plugins">
<h2>Listing the installed plugins<a class="headerlink" href="#listing-the-installed-plugins" title="Permalink to this headline">¶</a></h2>
<p>To do this, use the plugins command like this:</p>
<div class="highlight-python"><div class="highlight"><pre>bzr plugins
</pre></div>
</div>
<p>The name, location and version of each plugin installed will be displayed.</p>
<p>New commands added by plugins can be seen by running <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">help</span> <span class="pre">commands</span></tt>.
The commands provided by a plugin are shown followed by the name of the
plugin in brackets.</p>
</div>
<div class="section" id="popular-plugins">
<h2>Popular plugins<a class="headerlink" href="#popular-plugins" title="Permalink to this headline">¶</a></h2>
<p>Here is a sample of some of the more popular plugins.</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="25%" />
<col width="51%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Category</th>
<th class="head">Name</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>GUI</td>
<td>QBzr</td>
<td>Qt-based GUI tools</td>
</tr>
<tr class="row-odd"><td>GUI</td>
<td>bzr-gtk</td>
<td>GTK-based GUI tools</td>
</tr>
<tr class="row-even"><td>GUI</td>
<td>bzr-eclipse</td>
<td>Eclipse integration</td>
</tr>
<tr class="row-odd"><td>General</td>
<td>bzrtools</td>
<td>misc. enhancements including shelf</td>
</tr>
<tr class="row-even"><td>General</td>
<td>difftools</td>
<td>external diff tool helper</td>
</tr>
<tr class="row-odd"><td>General</td>
<td>extmerge</td>
<td>external merge tool helper</td>
</tr>
<tr class="row-even"><td>Integration</td>
<td>bzr-svn</td>
<td>use Subversion as a repository</td>
</tr>
<tr class="row-odd"><td>Migration</td>
<td>cvsps</td>
<td>migrate CVS patch-sets</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>If you wish to write your own plugins, it is not difficult to do.
See <a class="reference external" href="writingaplugin.html">Writing a plugin</a> in the appendices to get
started.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Using plugins</a><ul>
<li><a class="reference internal" href="#what-is-a-plugin">What is a plugin?</a></li>
<li><a class="reference internal" href="#where-to-find-plugins">Where to find plugins</a></li>
<li><a class="reference internal" href="#how-to-install-a-plugin">How to install a plugin</a></li>
<li><a class="reference internal" href="#alternative-plugin-locations">Alternative plugin locations</a></li>
<li><a class="reference internal" href="#listing-the-installed-plugins">Listing the installed plugins</a></li>
<li><a class="reference internal" href="#popular-plugins">Popular plugins</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="using_aliases.html"
title="previous chapter">Using aliases</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="zen.html"
title="next chapter">Bazaar Zen</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-guide/plugins.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="zen.html" title="Bazaar Zen"
>next</a></li>
<li class="right" >
<a href="using_aliases.html" title="Using aliases"
>previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="../_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li><a href="../index.html">Table of Contents (2.6.0)</a> »</li>
<li><a href="index.html" >Bazaar User Guide</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2011 Canonical Ltd.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
