<!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>Configuring email — 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="Serving Bazaar with Apache" href="http_smart_server.html" />
<link rel="prev" title="Advanced shared repository layouts" href="shared_repository_layouts.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="http_smart_server.html" title="Serving Bazaar with Apache"
accesskey="N">next</a></li>
<li class="right" >
<a href="shared_repository_layouts.html" title="Advanced shared repository layouts"
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="configuring-email">
<h1>Configuring email<a class="headerlink" href="#configuring-email" title="Permalink to this headline">¶</a></h1>
<div class="section" id="why-set-up-an-email-address-with-bazaar">
<h2>Why set up an email address with Bazaar?<a class="headerlink" href="#why-set-up-an-email-address-with-bazaar" title="Permalink to this headline">¶</a></h2>
<p>Bazaar stores the specified email address in revisions when they’re
created so that people can tell who committed which revisions. The
email addresses are not verified, therefore they could be bogus, so
you have to trust the people involved in your project. Additionally,
the email address in a revision gives others a way to contact the
author of a revision for credit and/or blame. :)</p>
</div>
<div class="section" id="how-to-set-up-your-email-address">
<h2>How to set up your email address<a class="headerlink" href="#how-to-set-up-your-email-address" title="Permalink to this headline">¶</a></h2>
<p>Bazaar will try to guess an email address based on your username and the
hostname if none is set. This will probably not be what you want, so three
ways exist to tell Bazaar what email to use:</p>
<p>You can set your email in one of several configuration files. Like
other configuration values, you can set it in <tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> as a
general setting. If you want to override the value for a particular
branch, or set of branches, you can use <tt class="docutils literal"><span class="pre">locations.conf</span></tt>.
<tt class="docutils literal"><span class="pre">.bzr/branch/branch.conf</span></tt> will also work, but will cause all commits
to that branch to use the same email address, even if someone else
does them.</p>
<p>The order of precedence is</p>
<blockquote>
<div><ol class="arabic simple">
<li>If the <tt class="docutils literal"><span class="pre">BZR_EMAIL</span></tt> environment variable is set.</li>
<li>If an email is set for your current branch in the <tt class="docutils literal"><span class="pre">locations.conf</span></tt>
file.</li>
<li>If an email is set four your current branch in the
<tt class="docutils literal"><span class="pre">.bzr/branch/branch.conf</span></tt> file.</li>
<li>If an email is set in the <tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> default configuration file.</li>
<li>If the <cite>EMAIL</cite> environment variable is set.</li>
<li>Bazaar will try to guess based on your username and the hostname.</li>
</ol>
</div></blockquote>
<p>To check on what Bazaar thinks your current email is, use the <tt class="docutils literal"><span class="pre">whoami</span></tt>
(“who am i?”) command:</p>
<div class="highlight-python"><div class="highlight"><pre>% bzr whoami
Joe Cool <joe@example.com>
</pre></div>
</div>
</div>
<div class="section" id="setting-email-via-the-whoami-command">
<h2>Setting email via the ‘whoami’ command<a class="headerlink" href="#setting-email-via-the-whoami-command" title="Permalink to this headline">¶</a></h2>
<p>You can use the whoami command to set your email globally:</p>
<div class="highlight-python"><div class="highlight"><pre>% bzr whoami "Joe Cool <joe@example.com>"
</pre></div>
</div>
<p>or only for the current branch:</p>
<div class="highlight-python"><div class="highlight"><pre>% bzr whoami --branch "Joe Cool <joe@example.com>"
</pre></div>
</div>
<p>These modify your global <tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> or branch <tt class="docutils literal"><span class="pre">branch.conf</span></tt> file, respectively.</p>
</div>
<div class="section" id="setting-email-via-default-configuration-file">
<h2>Setting email via default configuration file<a class="headerlink" href="#setting-email-via-default-configuration-file" title="Permalink to this headline">¶</a></h2>
<p>To use the default ini file, create or edit the <tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> file (in
<tt class="docutils literal"><span class="pre">~/.bazaar/</span></tt> on Unix and in <tt class="docutils literal"><span class="pre">%APPDATA%\bazaar\2.0\</span></tt> in Windows)
and set an email address as shown below. Please note that the word DEFAULT
is case sensitive, and must be in upper-case.</p>
<div class="highlight-python"><div class="highlight"><pre>[DEFAULT]
email=Your Name <name@isp.com>
</pre></div>
</div>
<p>For more information on the ini file format, see <a class="reference external" href="../user-reference/index.html#configuration-settings">Configuration Settings</a> in
the Bazaar User Reference.</p>
</div>
<div class="section" id="setting-email-on-a-per-branch-basis">
<h2>Setting email on a per-branch basis<a class="headerlink" href="#setting-email-on-a-per-branch-basis" title="Permalink to this headline">¶</a></h2>
<p>The second approach is to set email on a branch by branch basis by
using the <tt class="docutils literal"><span class="pre">locations.conf</span></tt> configuration file like this:</p>
<div class="highlight-python"><div class="highlight"><pre>[/some/branch/location]
email=Your Name <name@other-isp.com>
</pre></div>
</div>
<p>This will set your email address in the branch at <tt class="docutils literal"><span class="pre">/some/branch/location</span></tt>,
overriding the default specified in the <tt class="docutils literal"><span class="pre">bazaar.conf</span></tt> above.</p>
</div>
<div class="section" id="setting-email-via-environment-variable">
<h2>Setting email via environment variable<a class="headerlink" href="#setting-email-via-environment-variable" title="Permalink to this headline">¶</a></h2>
<p>The final method Bazaar will use is checking for the <tt class="docutils literal"><span class="pre">BZR_EMAIL</span></tt>
and <tt class="docutils literal"><span class="pre">EMAIL</span></tt> environment variables. Generally, you would use this
method to override the email in a script context. If you would like
to set a general default, then please see the ini methods above.</p>
</div>
<div class="section" id="concerns-about-spam">
<h2>Concerns about spam<a class="headerlink" href="#concerns-about-spam" title="Permalink to this headline">¶</a></h2>
<p>Some people want to avoid sharing their email address so as not to get
spam. Bazaar will never disclose your email address, unless you publish
a branch or changeset in a public location. It’s recommended that you
<em>do</em> use a real address, so that people can contact you about your work,
but it’s not required. You can use an address which is obfuscated, which
bounces, or which goes through an anti-spam service such as
<cite>spamgourmet.com</cite>.</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="#">Configuring email</a><ul>
<li><a class="reference internal" href="#why-set-up-an-email-address-with-bazaar">Why set up an email address with Bazaar?</a></li>
<li><a class="reference internal" href="#how-to-set-up-your-email-address">How to set up your email address</a></li>
<li><a class="reference internal" href="#setting-email-via-the-whoami-command">Setting email via the ‘whoami’ command</a></li>
<li><a class="reference internal" href="#setting-email-via-default-configuration-file">Setting email via default configuration file</a></li>
<li><a class="reference internal" href="#setting-email-on-a-per-branch-basis">Setting email on a per-branch basis</a></li>
<li><a class="reference internal" href="#setting-email-via-environment-variable">Setting email via environment variable</a></li>
<li><a class="reference internal" href="#concerns-about-spam">Concerns about spam</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="shared_repository_layouts.html"
title="previous chapter">Advanced shared repository layouts</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="http_smart_server.html"
title="next chapter">Serving Bazaar with Apache</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-guide/setting_up_email.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="http_smart_server.html" title="Serving Bazaar with Apache"
>next</a></li>
<li class="right" >
<a href="shared_repository_layouts.html" title="Advanced shared repository layouts"
>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>
