2
=======================
7
While most configuration is handled by configuration files, some options
8
which may be semi-permanent can also be controlled through the environment.
13
Override the email id used by Bazaar. Typical format::
15
"John Doe <jdoe@example.com>"
17
See also the ``email`` configuration value.
22
Override the progress display. Possible values are "none" or "text". If
23
the value is "none" then no progress bar is displayed. The value "text" draws
24
the ordinary command line progress bar.
29
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
31
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
32
* 1 = Invoke breakin debugger (default)
37
Override the home directory used by Bazaar.
42
Select a different SSH implementation.
47
Control whether to launch a debugger on error.
49
* 0 = Standard behavior
55
Path to the Bazaar executable to use when using the bzr+ssh protocol.
57
See also the ``bzr_remote_path`` configuration value.
62
Path to the editor Bazaar should use for commit messages, etc.
67
Location of the Bazaar log file. You can check the current location by
68
running ``bzr version``.
70
The log file contains debug information that is useful for diagnosing or
71
reporting problems with Bazaar.
73
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
80
The path to the plugins directory that Bazaar should use.
81
If not set, Bazaar will search for plugins in:
83
* the user specific plugin directory (containing the ``user`` plugins),
85
* the bzrlib directory (containing the ``core`` plugins),
87
* the site specific plugin directory if applicable (containing
88
the ``site`` plugins).
90
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
91
the way the plugin are searched.
93
As for the ``PATH`` variables, if multiple directories are
94
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
95
platform specific appropriate character (':' on Unix,
98
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
99
in ``user``. However it will continue to search in ``core`` and
100
``site`` unless they are explicitly removed.
102
If you need to change the order or remove one of these
103
directories, you should use special values:
105
* ``-user``, ``-core``, ``-site`` will remove the corresponding
106
path from the default values,
108
* ``+user``, ``+core``, ``+site`` will add the corresponding path
109
before the remaining default values (and also remove it from
112
Note that the special values 'user', 'core' and 'site' should be
113
used literally, they will be substituted by the corresponding,
114
platform specific, values.
116
The examples below use ':' as the separator, windows users
119
Overriding the default user plugin directory::
121
BZR_PLUGIN_PATH='/path/to/my/other/plugins'
123
Disabling the site directory while retaining the user directory::
125
BZR_PLUGIN_PATH='-site:+user'
127
Disabling all plugins (better achieved with --no-plugins)::
129
BZR_PLUGIN_PATH='-user:-core:-site'
131
Overriding the default site plugin directory::
133
BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
138
Under special circumstances (mostly when trying to diagnose a
139
bug), it's better to disable a plugin (or several) rather than
140
uninstalling them completely. Such plugins can be specified in
141
the ``BZR_DISABLE_PLUGINS`` environment variable.
143
In that case, ``bzr`` will stop loading the specified plugins and
144
will raise an import error if they are explicitly imported (by
145
another plugin that depends on them for example).
147
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
149
BZR_DISABLE_PLUGINS='myplugin:yourplugin'
154
When adding a new feature or working on a bug in a plugin,
155
developers often need to use a specific version of a given
156
plugin. Since python requires that the directory containing the
157
code is named like the plugin itself this make it impossible to
158
use arbitrary directory names (using a two-level directory scheme
159
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
160
if they don't appear in ``BZR_PLUGIN_PATH`` .
162
Plugins specified in this environment variable takes precedence
163
over the ones in ``BZR_PLUGIN_PATH``.
165
The variable specified a list of ``plugin_name@plugin path``,
166
``plugin_name`` being the name of the plugin as it appears in
167
python module paths, ``plugin_path`` being the path to the
168
directory containing the plugin code itself
169
(i.e. ``plugins/myplugin`` not ``plugins``). Use ':' as the list
170
separator, use ';' on windows.
175
Using a specific version of ``myplugin``:
176
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
181
The path where Bazaar should look for shell plugin external commands.
184
http_proxy, https_proxy
185
~~~~~~~~~~~~~~~~~~~~~~~
187
Specifies the network proxy for outgoing connections, for example::
189
http_proxy=http://proxy.example.com:3128/
190
https_proxy=http://proxy.example.com:3128/
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
200
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
201
Windows. (You can check the location for your system by using
204
There are three primary configuration files in this location:
206
* ``bazaar.conf`` describes default configuration options,
208
* ``locations.conf`` describes configuration information for
209
specific branch locations,
211
* ``authentication.conf`` describes credential information for
5
Information on how to configure Bazaar.
7
.. TODO: Should have some explanation of why you'd want things in
10
Location of configuration files
11
===============================
12
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
13
one, named ``bazaar.conf``, includes default configuration options. The other
14
file, ``locations.conf``, contains configuration information for specific
15
branch locations. These files are sometimes referred to as ``ini files``.
214
17
Each branch can also contain a configuration file that sets values specific
215
18
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
331
120
create_signatures = always
332
121
check_signatures = always
334
[http://example.com/bzr/*]
123
[http://bazaar-vcs.org/bzr/*]
335
124
check_signatures = require
337
The authentication configuration file, authentication.conf
338
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
340
``authentication.conf`` allows one to specify credentials for
341
remote servers. This can be used for all the supported transports and any part
342
of bzr that requires authentication (smtp for example).
344
The syntax of the file obeys the same rules as the others except for the
345
variable policies which don't apply.
347
For more information on the possible uses of the authentication configuration
348
file see :doc:`authentication-help`.
351
Common variable options
352
-----------------------
357
A comma-separated list of debugging options to turn on. The same values
358
can be used as with the -D command-line option (see `help global-options`).
126
Common Variable Options
127
=======================
366
131
The email address to use when committing a branch. Typically takes the form
369
134
email = Full Name <account@hostname.tld>
374
138
The path of the editor that you wish to use if *bzr commit* is run without
375
139
a commit message. This setting is trumped by the environment variable
376
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
382
The default log format to use. Standard log formats are ``long``, ``short``
383
and ``line``. Additional formats may be provided by plugins. The default
140
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
389
Reserved for future use. These options will allow a policy for branches to
144
Defines the behavior for signatures.
393
147
The gnupg signature for revisions must be present and must be valid.
434
182
branches below it.
436
184
gpg_signing_command
439
186
(Default: "gpg"). Which program should be used to sign and check revisions.
442
189
gpg_signing_command = /usr/bin/gnpg
447
(Default: "bzr"). The path to the command that should be used to run the smart
448
server for bzr. This value may only be specified in locations.conf, because:
450
- it's needed before branch.conf is accessible
451
- allowing remote branch.conf files to specify commands would be a security
454
It is overridden by the BZR_REMOTE_PATH environment variable.
459
193
(Default: "localhost"). SMTP server to use when Bazaar needs to send
460
194
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
462
196
smtp_username, smtp_password
463
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
197
----------------------------
465
198
User and password to authenticate to the SMTP server. If smtp_username
466
199
is set, and smtp_password is not, Bazaar will prompt for a password.
467
200
These settings are only needed if the SMTP server requires authentication
473
If set to true, bzr will automatically break locks held by processes from
474
the same machine and user that are no longer alive. Otherwise, it will
475
print a message and you can break the lock manually, if you are satisfied
476
the object is no longer in use.
481
A mail client to use for sending merge requests.
482
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
483
will try ``xdg-email``. If either of these fails, it will fall back to
486
Supported values for specific clients:
488
:claws: Use Claws. This skips a dialog for attaching files.
489
:evolution: Use Evolution.
492
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
493
this works around some bugs that xdg-email doesn't handle.
495
Supported generic values are:
498
:editor: Use your editor to compose the merge request. This also uses
499
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
500
smtp_username and smtp_password.
501
:mapi: Use your preferred e-mail client on Windows.
502
:xdg-email: Use xdg-email to run your preferred mail program
507
The branch you intend to submit your current work to. This is automatically
508
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
509
should usually be set on a per-branch or per-location basis.
514
A publically-accessible version of this branch (implying that this version is
515
not publically-accessible). Used (and set) by ``bzr send``.
520
A list of strings, each string represent a warning that can be emitted by
521
bzr. Mentioning a warning in this list tells bzr to not emit it.
525
* ``format_deprecation``:
526
whether the format deprecation warning is shown on repositories that are
527
using deprecated formats.
532
A format name for the default format used when creating branches. See ``bzr
533
help formats`` for possible values.
542
A Python unicode encoding name for text output from bzr, such as log
543
information. Values include: utf8, cp850, ascii, iso-8859-1. The default
544
is the terminal encoding prefered by the operating system.
547
Branch type specific options
548
----------------------------
550
These options apply only to branches that use the ``dirstate-tags`` or
552
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
553
manually set in ``locations.conf`` or ``bazaar.conf``.
207
These options apply only to branches that use the "experimental-branch6"
208
format. They are usually set in ``.bzr/branch/branch.conf`` automatically, but
209
may be manually set in ``locations.conf`` or ``bazaar.conf``.
555
211
append_revisions_only
556
~~~~~~~~~~~~~~~~~~~~~
212
---------------------
558
213
If set to "True" then revisions can only be appended to the log, not
559
removed. A branch with this setting enabled can only pull from another
560
branch if the other branch's log is a longer version of its own. This is
561
normally set by ``bzr init --append-revisions-only``. If you set it
562
manually, use either 'True' or 'False' (case-sensitive) to maintain
563
compatibility with previous bzr versions (older than 2.2).
214
removed. A branch with this setting enabled can only pull from
215
another branch if the other branch's log is a longer version of its
216
own. This is normally set by ``bzr init --append-revisions-only``.
568
If present, the location of the default branch for pull or merge. This option
569
is normally set when creating a branch, the first ``pull`` or by ``pull
220
If present, the location of the default branch for pull or merge.
221
This option is normally set by ``pull --remember`` or ``merge
575
226
If present, the location of the default branch for push. This option
576
is normally set by the first ``push`` or ``push --remember``.
581
If present, defines the ``--strict`` option default value for checking
582
uncommitted changes before pushing.
587
If present, defines the ``--strict`` option default value for checking
588
uncommitted changes before pushing into a different VCS without any
227
is normally set by ``push --remember``.
594
231
The location that commits should go to when acting as a checkout.
595
232
This option is normally set by ``bind``.
600
236
If set to "True", the branch should act as a checkout, and push each commit to
601
237
the bound_location. This option is normally set by ``bind``/``unbind``.
606
If present, defines the ``--strict`` option default value for checking
607
uncommitted changes before sending a merge directive.
616
Defines an external merge tool called <name> with the given command-line.
617
Arguments containing spaces should be quoted using single or double quotes. The
618
executable may omit its path if it can be found on the PATH.
620
The following markers can be used in the command-line to substitute filenames
621
involved in the merge conflict::
627
{this_temp} temp copy of file.THIS, used to overwrite output file if merge
632
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
634
bzr.default_mergetool
635
~~~~~~~~~~~~~~~~~~~~~
637
Specifies which external merge tool (as defined above) should be selected by
638
default in tools such as ``bzr qconflicts``.
642
bzr.default_mergetool = kdiff3
added
removed
doc/en/user-guide/configuration.txt
