<!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>Configuration Settings — Bazaar v2.2.4 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.2.4',
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 v2.2.4 documentation" href="../index.html" />
<link rel="up" title="Bazaar User Reference" href="index.html" />
<link rel="next" title="Conflict Types" href="conflict-types-help.html" />
<link rel="prev" title="Bug Tracker Settings" href="bugs-help.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="conflict-types-help.html" title="Conflict Types"
accesskey="N">next</a></li>
<li class="right" >
<a href="bugs-help.html" title="Bug Tracker Settings"
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.2.4)</a> »</li>
<li><a href="index.html" accesskey="U">Bazaar User Reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="configuration-settings">
<h1>Configuration Settings<a class="headerlink" href="#configuration-settings" title="Permalink to this headline">¶</a></h1>
<div class="section" id="environment-settings">
<h2>Environment settings<a class="headerlink" href="#environment-settings" title="Permalink to this headline">¶</a></h2>
<p>While most configuration is handled by configuration files, some options
which may be semi-permanent can also be controlled through the environment.</p>
<div class="section" id="bzr-email">
<h3>BZR_EMAIL<a class="headerlink" href="#bzr-email" title="Permalink to this headline">¶</a></h3>
<p>Override the email id used by Bazaar. Typical format:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="s">"John Doe <jdoe@example.com>"</span>
</pre></div>
</div>
<p>See also the <tt class="docutils literal"><span class="pre">email</span></tt> configuration value.</p>
</div>
<div class="section" id="bzr-progress-bar">
<h3>BZR_PROGRESS_BAR<a class="headerlink" href="#bzr-progress-bar" title="Permalink to this headline">¶</a></h3>
<p>Override the progress display. Possible values are “none”, “dots”, “tty”</p>
</div>
<div class="section" id="bzr-sigquit-pdb">
<h3>BZR_SIGQUIT_PDB<a class="headerlink" href="#bzr-sigquit-pdb" title="Permalink to this headline">¶</a></h3>
<p>Control whether SIGQUIT behaves normally or invokes a breakin debugger.</p>
<ul class="simple">
<li>0 = Standard SIGQUIT behavior (normally, exit with a core dump)</li>
<li>1 = Invoke breakin debugger (default)</li>
</ul>
</div>
<div class="section" id="bzr-home">
<h3>BZR_HOME<a class="headerlink" href="#bzr-home" title="Permalink to this headline">¶</a></h3>
<p>Override the home directory used by Bazaar.</p>
</div>
<div class="section" id="bzr-ssh">
<h3>BZR_SSH<a class="headerlink" href="#bzr-ssh" title="Permalink to this headline">¶</a></h3>
<p>Select a different SSH implementation.</p>
</div>
<div class="section" id="bzr-pdb">
<h3>BZR_PDB<a class="headerlink" href="#bzr-pdb" title="Permalink to this headline">¶</a></h3>
<p>Control whether to launch a debugger on error.</p>
<ul class="simple">
<li>0 = Standard behavior</li>
<li>1 = Launch debugger</li>
</ul>
</div>
<div class="section" id="bzr-remote-path">
<h3>BZR_REMOTE_PATH<a class="headerlink" href="#bzr-remote-path" title="Permalink to this headline">¶</a></h3>
<p>Path to the Bazaar executable to use when using the bzr+ssh protocol.</p>
<p>See also the <tt class="docutils literal"><span class="pre">bzr_remote_path</span></tt> configuration value.</p>
</div>
<div class="section" id="bzr-editor">
<h3>BZR_EDITOR<a class="headerlink" href="#bzr-editor" title="Permalink to this headline">¶</a></h3>
<p>Path to the editor Bazaar should use for commit messages, etc.</p>
</div>
<div class="section" id="bzr-log">
<h3>BZR_LOG<a class="headerlink" href="#bzr-log" title="Permalink to this headline">¶</a></h3>
<p>Location of the Bazaar log file. You can check the current location by
running <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">version</span></tt>.</p>
<p>The log file contains debug information that is useful for diagnosing or
reporting problems with Bazaar.</p>
<p>Setting this to <tt class="docutils literal"><span class="pre">NUL</span></tt> on Windows or <tt class="docutils literal"><span class="pre">/dev/null</span></tt> on other platforms
will disable logging.</p>
</div>
<div class="section" id="bzr-plugin-path">
<h3>BZR_PLUGIN_PATH<a class="headerlink" href="#bzr-plugin-path" title="Permalink to this headline">¶</a></h3>
<p>The path to the plugins directory that Bazaar should use.
If not set, Bazaar will search for plugins in:</p>
<ul class="simple">
<li>the user specific plugin directory (containing the <tt class="docutils literal"><span class="pre">user</span></tt> plugins),</li>
<li>the bzrlib directory (containing the <tt class="docutils literal"><span class="pre">core</span></tt> plugins),</li>
<li>the site specific plugin directory if applicable (containing
the <tt class="docutils literal"><span class="pre">site</span></tt> plugins).</li>
</ul>
<p>If <tt class="docutils literal"><span class="pre">BZR_PLUGIN_PATH</span></tt> is set in any fashion, it will change the
the way the plugin are searched.</p>
<p>As for the <tt class="docutils literal"><span class="pre">PATH</span></tt> variables, if multiple directories are
specified in <tt class="docutils literal"><span class="pre">BZR_PLUGIN_PATH</span></tt> they should be separated by the
platform specific appropriate character (‘:’ on Unix,
‘;’ on windows)</p>
<p>By default if <tt class="docutils literal"><span class="pre">BZR_PLUGIN_PATH</span></tt> is set, it replaces searching
in <tt class="docutils literal"><span class="pre">user</span></tt>. However it will continue to search in <tt class="docutils literal"><span class="pre">core</span></tt> and
<tt class="docutils literal"><span class="pre">site</span></tt> unless they are explicitly removed.</p>
<p>If you need to change the order or remove one of these
directories, you should use special values:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">-user</span></tt>, <tt class="docutils literal"><span class="pre">-core</span></tt>, <tt class="docutils literal"><span class="pre">-site</span></tt> will remove the corresponding
path from the default values,</li>
<li><tt class="docutils literal"><span class="pre">+user</span></tt>, <tt class="docutils literal"><span class="pre">+core</span></tt>, <tt class="docutils literal"><span class="pre">+site</span></tt> will add the corresponding path
before the remaining default values (and also remove it from
the default values).</li>
</ul>
<p>Note that the special values ‘user’, ‘core’ and ‘site’ should be
used literally, they will be substituted by the corresponding,
platform specific, values.</p>
<p>The examples below use ‘:’ as the separator, windows users
should use ‘;’.</p>
<p>Overriding the default user plugin directory:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">BZR_PLUGIN_PATH</span><span class="o">=</span><span class="s">'/path/to/my/other/plugins'</span>
</pre></div>
</div>
<p>Disabling the site directory while retaining the user directory:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">BZR_PLUGIN_PATH</span><span class="o">=</span><span class="s">'-site:+user'</span>
</pre></div>
</div>
<p>Disabling all plugins (better achieved with –no-plugins):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">BZR_PLUGIN_PATH</span><span class="o">=</span><span class="s">'-user:-core:-site'</span>
</pre></div>
</div>
<p>Overriding the default site plugin directory:</p>
<div class="highlight-python"><pre>BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user</pre>
</div>
</div>
<div class="section" id="bzr-disable-plugins">
<h3>BZR_DISABLE_PLUGINS<a class="headerlink" href="#bzr-disable-plugins" title="Permalink to this headline">¶</a></h3>
<p>Under special circumstances (mostly when trying to diagnose a
bug), it’s better to disable a plugin (or several) rather than
uninstalling them completely. Such plugins can be specified in
the <tt class="docutils literal"><span class="pre">BZR_DISABLE_PLUGINS</span></tt> environment variable.</p>
<p>In that case, <tt class="docutils literal"><span class="pre">bzr</span></tt> will stop loading the specified plugins and
will raise an import error if they are explicitly imported (by
another plugin that depends on them for example).</p>
<p>Disabling <tt class="docutils literal"><span class="pre">myplugin</span></tt> and <tt class="docutils literal"><span class="pre">yourplugin</span></tt> is achieved by:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">BZR_DISABLE_PLUGINS</span><span class="o">=</span><span class="s">'myplugin:yourplugin'</span>
</pre></div>
</div>
</div>
<div class="section" id="bzr-plugins-at">
<h3>BZR_PLUGINS_AT<a class="headerlink" href="#bzr-plugins-at" title="Permalink to this headline">¶</a></h3>
<p>When adding a new feature or working on a bug in a plugin,
developers often need to use a specific version of a given
plugin. Since python requires that the directory containing the
code is named like the plugin itself this make it impossible to
use arbitrary directory names (using a two-level directory scheme
is inconvenient). <tt class="docutils literal"><span class="pre">BZR_PLUGINS_AT</span></tt> allows such directories even
if they don’t appear in <tt class="docutils literal"><span class="pre">BZR_PLUGIN_PATH</span></tt> .</p>
<p>Plugins specified in this environment variable takes precedence
over the ones in <tt class="docutils literal"><span class="pre">BZR_PLUGIN_PATH</span></tt>.</p>
<p>The variable specified a list of <tt class="docutils literal"><span class="pre">plugin_name@plugin</span> <span class="pre">path</span></tt>,
<tt class="docutils literal"><span class="pre">plugin_name</span></tt> being the name of the plugin as it appears in
python module paths, <tt class="docutils literal"><span class="pre">plugin_path</span></tt> being the path to the
directory containing the plugin code itself
(i.e. <tt class="docutils literal"><span class="pre">plugins/myplugin</span></tt> not <tt class="docutils literal"><span class="pre">plugins</span></tt>). Use ‘:’ as the list
separator, use ‘;’ on windows.</p>
</div>
<div class="section" id="example">
<h3>Example:<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<p>Using a specific version of <tt class="docutils literal"><span class="pre">myplugin</span></tt>:
<tt class="docutils literal"><span class="pre">BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin</span></tt></p>
</div>
<div class="section" id="bzrpath">
<h3>BZRPATH<a class="headerlink" href="#bzrpath" title="Permalink to this headline">¶</a></h3>
<p>The path where Bazaar should look for shell plugin external commands.</p>
</div>
<div class="section" id="http-proxy-https-proxy">
<h3>http_proxy, https_proxy<a class="headerlink" href="#http-proxy-https-proxy" title="Permalink to this headline">¶</a></h3>
<p>Specifies the network proxy for outgoing connections, for example:</p>
<div class="highlight-python"><pre>http_proxy=http://proxy.example.com:3128/
https_proxy=http://proxy.example.com:3128/</pre>
</div>
</div>
</div>
<div class="section" id="configuration-files">
<h2>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this headline">¶</a></h2>
<div class="section" id="location">
<h3>Location<a class="headerlink" href="#location" title="Permalink to this headline">¶</a></h3>
<p>Configuration files are located in <tt class="docutils literal"><span class="pre">$HOME/.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. (You can check the location for your system by using
<tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">version</span></tt>.)</p>
<p>There are three primary configuration files in this location:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> describes default configuration options,</li>
<li><tt class="docutils literal"><span class="pre">locations.conf</span></tt> describes configuration information for
specific branch locations,</li>
<li><tt class="docutils literal"><span class="pre">authentication.conf</span></tt> describes credential information for
remote servers.</li>
</ul>
<p>Each branch can also contain a configuration file that sets values specific
to that branch. This file is found at <tt class="docutils literal"><span class="pre">.bzr/branch/branch.conf</span></tt> within the
branch. This file is visible to all users of a branch, if you wish to override
one of the values for a branch with a setting that is specific to you then you
can do so in <tt class="docutils literal"><span class="pre">locations.conf</span></tt>.</p>
</div>
<div class="section" id="general-format">
<h3>General format<a class="headerlink" href="#general-format" title="Permalink to this headline">¶</a></h3>
<p>An ini file has three types of contructs: section headers, section
variables and comments.</p>
<div class="section" id="comments">
<h4>Comments<a class="headerlink" href="#comments" title="Permalink to this headline">¶</a></h4>
<p>A comment is any line that starts with a “#” (sometimes called a “hash
mark”, “pound sign” or “number sign”). Comment lines are ignored by
Bazaar when parsing ini files.</p>
</div>
<div class="section" id="section-headers">
<h4>Section headers<a class="headerlink" href="#section-headers" title="Permalink to this headline">¶</a></h4>
<p>A section header is a word enclosed in brackets that starts at the begining
of a line. A typical section header looks like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span><span class="n">DEFAULT</span><span class="p">]</span>
</pre></div>
</div>
<p>The only valid section headers for bazaar.conf currently are [DEFAULT] and
[ALIASES]. Section headers are case sensitive. The default section provides for
setting variables which can be overridden with the branch config file.</p>
<p>For <tt class="docutils literal"><span class="pre">locations.conf</span></tt>, the variables from the section with the
longest matching section header are used to the exclusion of other
potentially valid section headers. A section header uses the path for
the branch as the section header. Some examples include:</p>
<div class="highlight-python"><pre>[http://mybranches.isp.com/~jdoe/branchdir]
[/home/jdoe/branches/]</pre>
</div>
</div>
<div class="section" id="section-variables">
<h4>Section variables<a class="headerlink" href="#section-variables" title="Permalink to this headline">¶</a></h4>
<p>A section variable resides within a section. A section variable contains a
variable name, an equals sign and a value. For example:</p>
<div class="highlight-python"><pre>email = John Doe <jdoe@isp.com>
check_signatures = require</pre>
</div>
</div>
<div class="section" id="variable-policies">
<h4>Variable policies<a class="headerlink" href="#variable-policies" title="Permalink to this headline">¶</a></h4>
<p>Variables defined in a section affect the named directory or URL plus
any locations they contain. Policies can be used to change how a
variable value is interpreted for contained locations. Currently
there are three policies available:</p>
<blockquote>
<div><dl class="docutils">
<dt>none:</dt>
<dd>the value is interpreted the same for contained locations. This is
the default behaviour.</dd>
<dt>norecurse:</dt>
<dd>the value is only used for the exact location specified by the
section name.</dd>
<dt>appendpath:</dt>
<dd>for contained locations, any additional path components are
appended to the value.</dd>
</dl>
</div></blockquote>
<p>Policies are specified by keys with names of the form “$var:policy”.
For example, to define the push location for a tree of branches, the
following could be used:</p>
<div class="highlight-python"><pre>[/top/location]
push_location = sftp://example.com/location
push_location:policy = appendpath</pre>
</div>
<p>With this configuration, the push location for <tt class="docutils literal"><span class="pre">/top/location/branch1</span></tt>
would be <tt class="docutils literal"><span class="pre">sftp://example.com/location/branch1</span></tt>.</p>
</div>
</div>
<div class="section" id="the-main-configuration-file-bazaar-conf">
<h3>The main configuration file, bazaar.conf<a class="headerlink" href="#the-main-configuration-file-bazaar-conf" title="Permalink to this headline">¶</a></h3>
<p><tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> allows two sections: <tt class="docutils literal"><span class="pre">[DEFAULT]</span></tt> and <tt class="docutils literal"><span class="pre">[ALIASES]</span></tt>.
The default section contains the default
configuration options for all branches. The default section can be
overriden by providing a branch-specific section in <tt class="docutils literal"><span class="pre">locations.conf</span></tt>.</p>
<p>A typical <tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> section often looks like the following:</p>
<div class="highlight-python"><pre>[DEFAULT]
email = John Doe <jdoe@isp.com>
editor = /usr/bin/vim
check_signatures = check-available
create_signatures = when-required</pre>
</div>
</div>
<div class="section" id="the-branch-location-configuration-file-locations-conf">
<h3>The branch location configuration file, locations.conf<a class="headerlink" href="#the-branch-location-configuration-file-locations-conf" title="Permalink to this headline">¶</a></h3>
<p><tt class="docutils literal"><span class="pre">locations.conf</span></tt> allows one to specify overriding settings for
a specific branch. The format is almost identical to the default section in
bazaar.conf with one significant change: The section header, instead of saying
default, will be the path to a branch that you wish to override a value
for. The ‘?’ and ‘*’ wildcards are supported:</p>
<div class="highlight-python"><pre>[/home/jdoe/branches/nethack]
email = Nethack Admin <nethack@nethack.com>
[http://hypothetical.site.com/branches/devel-branch]
create_signatures = always
check_signatures = always
[http://bazaar-vcs.org/bzr/*]
check_signatures = require</pre>
</div>
</div>
<div class="section" id="the-authentication-configuration-file-authentication-conf">
<h3>The authentication configuration file, authentication.conf<a class="headerlink" href="#the-authentication-configuration-file-authentication-conf" title="Permalink to this headline">¶</a></h3>
<p><tt class="docutils literal"><span class="pre">authentication.conf</span></tt> allows one to specify credentials for
remote servers. This can be used for all the supported transports and any part
of bzr that requires authentication (smtp for example).</p>
<p>The syntax of the file obeys the same rules as the others except for the
variable policies which don’t apply.</p>
<p>For more information on the possible uses of the authentication configuration
file see <a class="reference internal" href="authentication-help.html"><em>Authentication Settings</em></a>.</p>
</div>
</div>
<div class="section" id="common-variable-options">
<h2>Common variable options<a class="headerlink" href="#common-variable-options" title="Permalink to this headline">¶</a></h2>
<div class="section" id="debug-flags">
<h3>debug_flags<a class="headerlink" href="#debug-flags" title="Permalink to this headline">¶</a></h3>
<p>A comma-separated list of debugging options to turn on. The same values
can be used as with the -D command-line option (see <cite>help global-options</cite>).
For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">debug_flags</span> <span class="o">=</span> <span class="n">hpss</span>
</pre></div>
</div>
</div>
<div class="section" id="email">
<h3>email<a class="headerlink" href="#email" title="Permalink to this headline">¶</a></h3>
<p>The email address to use when committing a branch. Typically takes the form
of:</p>
<div class="highlight-python"><pre>email = Full Name <account@hostname.tld></pre>
</div>
</div>
<div class="section" id="editor">
<h3>editor<a class="headerlink" href="#editor" title="Permalink to this headline">¶</a></h3>
<p>The path of the editor that you wish to use if <em>bzr commit</em> is run without
a commit message. This setting is trumped by the environment variable
<tt class="docutils literal"><span class="pre">BZR_EDITOR</span></tt>, and overrides the <tt class="docutils literal"><span class="pre">VISUAL</span></tt> and <tt class="docutils literal"><span class="pre">EDITOR</span></tt> environment
variables.</p>
</div>
<div class="section" id="log-format">
<h3>log_format<a class="headerlink" href="#log-format" title="Permalink to this headline">¶</a></h3>
<p>The default log format to use. Standard log formats are <tt class="docutils literal"><span class="pre">long</span></tt>, <tt class="docutils literal"><span class="pre">short</span></tt>
and <tt class="docutils literal"><span class="pre">line</span></tt>. Additional formats may be provided by plugins. The default
value is <tt class="docutils literal"><span class="pre">long</span></tt>.</p>
</div>
<div class="section" id="check-signatures">
<h3>check_signatures<a class="headerlink" href="#check-signatures" title="Permalink to this headline">¶</a></h3>
<p>Defines the behavior for signatures.</p>
<dl class="docutils">
<dt>require</dt>
<dd>The gnupg signature for revisions must be present and must be valid.</dd>
<dt>ignore</dt>
<dd>Do not check gnupg signatures of revisions.</dd>
<dt>check-available</dt>
<dd>(default) If gnupg signatures for revisions are present, check them.
Bazaar will fail if it finds a bad signature, but will not fail if
no signature is present.</dd>
</dl>
</div>
<div class="section" id="create-signatures">
<h3>create_signatures<a class="headerlink" href="#create-signatures" title="Permalink to this headline">¶</a></h3>
<p>Defines the behaviour of signing revisions.</p>
<dl class="docutils">
<dt>always</dt>
<dd>Sign every new revision that is committed.</dd>
<dt>when-required</dt>
<dd>(default) Sign newly committed revisions only when the branch requires
signed revisions.</dd>
<dt>never</dt>
<dd>Refuse to sign newly committed revisions, even if the branch
requires signatures.</dd>
</dl>
</div>
<div class="section" id="recurse">
<h3>recurse<a class="headerlink" href="#recurse" title="Permalink to this headline">¶</a></h3>
<p>Only useful in <tt class="docutils literal"><span class="pre">locations.conf</span></tt>. Defines whether or not the
configuration for this section applies to subdirectories:</p>
<dl class="docutils">
<dt>true</dt>
<dd>(default) This section applies to subdirectories as well.</dd>
<dt>false</dt>
<dd>This section only applies to the branch at this directory and not
branches below it.</dd>
</dl>
</div>
<div class="section" id="gpg-signing-command">
<h3>gpg_signing_command<a class="headerlink" href="#gpg-signing-command" title="Permalink to this headline">¶</a></h3>
<p>(Default: “gpg”). Which program should be used to sign and check revisions.
For example:</p>
<div class="highlight-python"><pre>gpg_signing_command = /usr/bin/gnpg</pre>
</div>
</div>
<div class="section" id="id1">
<h3>bzr_remote_path<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<p>(Default: “bzr”). The path to the command that should be used to run the smart
server for bzr. This value may only be specified in locations.conf, because:</p>
<ul class="simple">
<li>it’s needed before branch.conf is accessible</li>
<li>allowing remote branch.conf files to specify commands would be a security
risk</li>
</ul>
<p>It is overridden by the BZR_REMOTE_PATH environment variable.</p>
</div>
<div class="section" id="smtp-server">
<h3>smtp_server<a class="headerlink" href="#smtp-server" title="Permalink to this headline">¶</a></h3>
<p>(Default: “localhost”). SMTP server to use when Bazaar needs to send
email, eg. with <tt class="docutils literal"><span class="pre">merge-directive</span> <span class="pre">--mail-to</span></tt>, or the bzr-email plugin.</p>
</div>
<div class="section" id="smtp-username-smtp-password">
<h3>smtp_username, smtp_password<a class="headerlink" href="#smtp-username-smtp-password" title="Permalink to this headline">¶</a></h3>
<p>User and password to authenticate to the SMTP server. If smtp_username
is set, and smtp_password is not, Bazaar will prompt for a password.
These settings are only needed if the SMTP server requires authentication
to send mail.</p>
</div>
<div class="section" id="mail-client">
<h3>mail_client<a class="headerlink" href="#mail-client" title="Permalink to this headline">¶</a></h3>
<p>A mail client to use for sending merge requests.
By default, bzr will try to use <tt class="docutils literal"><span class="pre">mapi</span></tt> on Windows. On other platforms, it
will try <tt class="docutils literal"><span class="pre">xdg-email</span></tt>. If either of these fails, it will fall back to
<tt class="docutils literal"><span class="pre">editor</span></tt>.</p>
<p>Supported values for specific clients:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">claws:</th><td class="field-body">Use Claws. This skips a dialog for attaching files.</td>
</tr>
<tr class="field"><th class="field-name">evolution:</th><td class="field-body">Use Evolution.</td>
</tr>
<tr class="field"><th class="field-name">kmail:</th><td class="field-body">Use KMail.</td>
</tr>
<tr class="field"><th class="field-name">mutt:</th><td class="field-body">Use Mutt.</td>
</tr>
<tr class="field"><th class="field-name">thunderbird:</th><td class="field-body">Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
this works around some bugs that xdg-email doesn’t handle.</td>
</tr>
</tbody>
</table>
<p>Supported generic values are:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">default:</th><td class="field-body">See above.</td>
</tr>
<tr class="field"><th class="field-name">editor:</th><td class="field-body">Use your editor to compose the merge request. This also uses
your commit id, (see <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">whoami</span></tt>), smtp_server and (optionally)
smtp_username and smtp_password.</td>
</tr>
<tr class="field"><th class="field-name">mapi:</th><td class="field-body">Use your preferred e-mail client on Windows.</td>
</tr>
<tr class="field"><th class="field-name">xdg-email:</th><td class="field-body">Use xdg-email to run your preferred mail program</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="submit-branch">
<h3>submit_branch<a class="headerlink" href="#submit-branch" title="Permalink to this headline">¶</a></h3>
<p>The branch you intend to submit your current work to. This is automatically
set by <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">send</span></tt>, and is also used by the <tt class="docutils literal"><span class="pre">submit:</span></tt> revision spec. This
should usually be set on a per-branch or per-location basis.</p>
</div>
<div class="section" id="public-branch">
<h3>public_branch<a class="headerlink" href="#public-branch" title="Permalink to this headline">¶</a></h3>
<p>A publically-accessible version of this branch (implying that this version is
not publically-accessible). Used (and set) by <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">send</span></tt>.</p>
</div>
<div class="section" id="suppress-warnings">
<h3>suppress_warnings<a class="headerlink" href="#suppress-warnings" title="Permalink to this headline">¶</a></h3>
<p>A list of strings, each string represent a warning that can be emitted by
bzr. Mentioning a warning in this list tells bzr to not emit it.</p>
<p>Valid values:</p>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">format_deprecation</span></tt>:</dt>
<dd><p class="first last">whether the format deprecation warning is shown on repositories that are
using deprecated formats.</p>
</dd>
</dl>
</li>
</ul>
</div>
</div>
<div class="section" id="unicode-options">
<h2>Unicode options<a class="headerlink" href="#unicode-options" title="Permalink to this headline">¶</a></h2>
<div class="section" id="output-encoding">
<h3>output_encoding<a class="headerlink" href="#output-encoding" title="Permalink to this headline">¶</a></h3>
<p>A Python unicode encoding name for text output from bzr, such as log
information. Values include: utf8, cp850, ascii, iso-8859-1. The default
is the terminal encoding prefered by the operating system.</p>
</div>
</div>
<div class="section" id="branch-type-specific-options">
<h2>Branch type specific options<a class="headerlink" href="#branch-type-specific-options" title="Permalink to this headline">¶</a></h2>
<p>These options apply only to branches that use the <tt class="docutils literal"><span class="pre">dirstate-tags</span></tt> or
later format. They
are usually set in <tt class="docutils literal"><span class="pre">.bzr/branch/branch.conf</span></tt> automatically, but may be
manually set in <tt class="docutils literal"><span class="pre">locations.conf</span></tt> or <tt class="docutils literal"><span class="pre">bazaar.conf</span></tt>.</p>
<div class="section" id="append-revisions-only">
<h3>append_revisions_only<a class="headerlink" href="#append-revisions-only" title="Permalink to this headline">¶</a></h3>
<p>If set to “True” then revisions can only be appended to the log, not
removed. A branch with this setting enabled can only pull from another
branch if the other branch’s log is a longer version of its own. This is
normally set by <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">init</span> <span class="pre">--append-revisions-only</span></tt>. If you set it
manually, use either ‘True’ or ‘False’ (case-sensitive) to maintain
compatibility with previous bzr versions (older than 2.2).</p>
</div>
<div class="section" id="parent-location">
<h3>parent_location<a class="headerlink" href="#parent-location" title="Permalink to this headline">¶</a></h3>
<p>If present, the location of the default branch for pull or merge.
This option is normally set by <tt class="docutils literal"><span class="pre">pull</span> <span class="pre">--remember</span></tt> or <tt class="docutils literal"><span class="pre">merge</span>
<span class="pre">--remember</span></tt>.</p>
</div>
<div class="section" id="push-location">
<h3>push_location<a class="headerlink" href="#push-location" title="Permalink to this headline">¶</a></h3>
<p>If present, the location of the default branch for push. This option
is normally set by <tt class="docutils literal"><span class="pre">push</span> <span class="pre">--remember</span></tt>.</p>
</div>
<div class="section" id="push-strict">
<h3>push_strict<a class="headerlink" href="#push-strict" title="Permalink to this headline">¶</a></h3>
<p>If present, defines the <tt class="docutils literal"><span class="pre">--strict</span></tt> option default value for checking
uncommitted changes before pushing.</p>
</div>
<div class="section" id="dpush-strict">
<h3>dpush_strict<a class="headerlink" href="#dpush-strict" title="Permalink to this headline">¶</a></h3>
<p>If present, defines the <tt class="docutils literal"><span class="pre">--strict</span></tt> option default value for checking
uncommitted changes before pushing into a different VCS without any
custom bzr metadata.</p>
</div>
<div class="section" id="bound-location">
<h3>bound_location<a class="headerlink" href="#bound-location" title="Permalink to this headline">¶</a></h3>
<p>The location that commits should go to when acting as a checkout.
This option is normally set by <tt class="docutils literal"><span class="pre">bind</span></tt>.</p>
</div>
<div class="section" id="bound">
<h3>bound<a class="headerlink" href="#bound" title="Permalink to this headline">¶</a></h3>
<p>If set to “True”, the branch should act as a checkout, and push each commit to
the bound_location. This option is normally set by <tt class="docutils literal"><span class="pre">bind</span></tt>/<tt class="docutils literal"><span class="pre">unbind</span></tt>.</p>
</div>
<div class="section" id="send-strict">
<h3>send_strict<a class="headerlink" href="#send-strict" title="Permalink to this headline">¶</a></h3>
<p>If present, defines the <tt class="docutils literal"><span class="pre">--strict</span></tt> option default value for checking
uncommitted changes before sending a merge directive.</p>
</div>
</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="#">Configuration Settings</a><ul>
<li><a class="reference internal" href="#environment-settings">Environment settings</a><ul>
<li><a class="reference internal" href="#bzr-email">BZR_EMAIL</a></li>
<li><a class="reference internal" href="#bzr-progress-bar">BZR_PROGRESS_BAR</a></li>
<li><a class="reference internal" href="#bzr-sigquit-pdb">BZR_SIGQUIT_PDB</a></li>
<li><a class="reference internal" href="#bzr-home">BZR_HOME</a></li>
<li><a class="reference internal" href="#bzr-ssh">BZR_SSH</a></li>
<li><a class="reference internal" href="#bzr-pdb">BZR_PDB</a></li>
<li><a class="reference internal" href="#bzr-remote-path">BZR_REMOTE_PATH</a></li>
<li><a class="reference internal" href="#bzr-editor">BZR_EDITOR</a></li>
<li><a class="reference internal" href="#bzr-log">BZR_LOG</a></li>
<li><a class="reference internal" href="#bzr-plugin-path">BZR_PLUGIN_PATH</a></li>
<li><a class="reference internal" href="#bzr-disable-plugins">BZR_DISABLE_PLUGINS</a></li>
<li><a class="reference internal" href="#bzr-plugins-at">BZR_PLUGINS_AT</a></li>
<li><a class="reference internal" href="#example">Example:</a></li>
<li><a class="reference internal" href="#bzrpath">BZRPATH</a></li>
<li><a class="reference internal" href="#http-proxy-https-proxy">http_proxy, https_proxy</a></li>
</ul>
</li>
<li><a class="reference internal" href="#configuration-files">Configuration files</a><ul>
<li><a class="reference internal" href="#location">Location</a></li>
<li><a class="reference internal" href="#general-format">General format</a><ul>
<li><a class="reference internal" href="#comments">Comments</a></li>
<li><a class="reference internal" href="#section-headers">Section headers</a></li>
<li><a class="reference internal" href="#section-variables">Section variables</a></li>
<li><a class="reference internal" href="#variable-policies">Variable policies</a></li>
</ul>
</li>
<li><a class="reference internal" href="#the-main-configuration-file-bazaar-conf">The main configuration file, bazaar.conf</a></li>
<li><a class="reference internal" href="#the-branch-location-configuration-file-locations-conf">The branch location configuration file, locations.conf</a></li>
<li><a class="reference internal" href="#the-authentication-configuration-file-authentication-conf">The authentication configuration file, authentication.conf</a></li>
</ul>
</li>
<li><a class="reference internal" href="#common-variable-options">Common variable options</a><ul>
<li><a class="reference internal" href="#debug-flags">debug_flags</a></li>
<li><a class="reference internal" href="#email">email</a></li>
<li><a class="reference internal" href="#editor">editor</a></li>
<li><a class="reference internal" href="#log-format">log_format</a></li>
<li><a class="reference internal" href="#check-signatures">check_signatures</a></li>
<li><a class="reference internal" href="#create-signatures">create_signatures</a></li>
<li><a class="reference internal" href="#recurse">recurse</a></li>
<li><a class="reference internal" href="#gpg-signing-command">gpg_signing_command</a></li>
<li><a class="reference internal" href="#id1">bzr_remote_path</a></li>
<li><a class="reference internal" href="#smtp-server">smtp_server</a></li>
<li><a class="reference internal" href="#smtp-username-smtp-password">smtp_username, smtp_password</a></li>
<li><a class="reference internal" href="#mail-client">mail_client</a></li>
<li><a class="reference internal" href="#submit-branch">submit_branch</a></li>
<li><a class="reference internal" href="#public-branch">public_branch</a></li>
<li><a class="reference internal" href="#suppress-warnings">suppress_warnings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#unicode-options">Unicode options</a><ul>
<li><a class="reference internal" href="#output-encoding">output_encoding</a></li>
</ul>
</li>
<li><a class="reference internal" href="#branch-type-specific-options">Branch type specific options</a><ul>
<li><a class="reference internal" href="#append-revisions-only">append_revisions_only</a></li>
<li><a class="reference internal" href="#parent-location">parent_location</a></li>
<li><a class="reference internal" href="#push-location">push_location</a></li>
<li><a class="reference internal" href="#push-strict">push_strict</a></li>
<li><a class="reference internal" href="#dpush-strict">dpush_strict</a></li>
<li><a class="reference internal" href="#bound-location">bound_location</a></li>
<li><a class="reference internal" href="#bound">bound</a></li>
<li><a class="reference internal" href="#send-strict">send_strict</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="bugs-help.html"
title="previous chapter">Bug Tracker Settings</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="conflict-types-help.html"
title="next chapter">Conflict Types</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-reference/configuration-help.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" size="18" />
<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="conflict-types-help.html" title="Conflict Types"
>next</a></li>
<li class="right" >
<a href="bugs-help.html" title="Bug Tracker Settings"
>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.2.4)</a> »</li>
<li><a href="index.html" >Bazaar User Reference</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, Canonical Ltd.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
