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", "dots", "tty"
27
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
29
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
30
* 1 = Invoke breakin debugger (default)
35
Override the home directory used by Bazaar.
40
Select a different SSH implementation.
45
Control whether to launch a debugger on error.
47
* 0 = Standard behavior
53
Path to the Bazaar executable to use when using the bzr+ssh protocol.
55
See also the ``bzr_remote_path`` configuration value.
60
Path to the editor Bazaar should use for commit messages, etc.
65
The path to the plugins directory that Bazaar should use.
66
If not set, Bazaar will search for plugins in:
68
* the user specific plugin directory (containing the ``user`` plugins),
70
* the bzrlib directory (containing the ``core`` plugins),
72
* the site specific plugin directory if applicable (containing
73
the ``site`` plugins).
75
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
76
the way the plugin are searched.
78
As for the ``PATH`` variables, if multiple directories are
79
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
80
platform specific appropriate character (':' on Unix/Linux/etc,
83
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
84
in ``user``. However it will continue to search in ``core`` and
85
``site`` unless they are explicitly removed.
87
If you need to change the order or remove one of these
88
directories, you should use special values:
90
* ``-user``, ``-core``, ``-site`` will remove the corresponding
91
path from the default values,
93
* ``+user``, ``+core``, ``+site`` will add the corresponding path
94
before the remaining default values (and also remove it from
97
Note that the special values 'user', 'core' and 'site' should be
98
used literally, they will be substituted by the corresponding,
99
platform specific, values.
101
The examples below use ':' as the separator, windows users
104
Overriding the default user plugin directory::
106
BZR_PLUGIN_PATH='/path/to/my/other/plugins'
108
Disabling the site directory while retaining the user directory::
110
BZR_PLUGIN_PATH='-site:+user'
112
Disabling all plugins (better achieved with --no-plugins)::
114
BZR_PLUGIN_PATH='-user:-core:-site'
116
Overriding the default site plugin directory::
118
BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
123
Under special circumstances (mostly when trying to diagnose a
124
bug), it's better to disable a plugin (or several) rather than
125
uninstalling them completely. Such plugins can be specified in
126
the ``BZR_DISABLE_PLUGINS`` environment variable.
128
In that case, ``bzr`` will stop loading the specified plugins and
129
will raise an import error if they are explicitly imported (by
130
another plugin that depends on them for example).
132
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
134
BZR_DISABLE_PLUGINS='myplugin:yourplugin'
139
When adding a new feature or working on a bug in a plugin,
140
developers often need to use a specific version of a given
141
plugin. Since python requires that the directory containing the
142
code is named like the plugin itself this make it impossible to
143
use arbitrary directory names (using a two-level directory scheme
144
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
145
if they don't appear in ``BZR_PLUGIN_PATH`` .
147
Plugins specified in this environment variable takes precedence
148
over the ones in ``BZR_PLUGIN_PATH``.
150
The variable specified a list of ``plugin_name@plugin path``,
151
``plugin_name`` being the name of the plugin as it appears in
152
python module paths, ``plugin_path`` being the path to the
153
directory containing the plugin code itself
154
(i.e. ``plugins/myplugin`` not ``plugins``). Use ':' as the list
155
separator, use ';' on windows.
160
Using a specific version of ``myplugin``:
161
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
166
The path where Bazaar should look for shell plugin external commands.
175
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
176
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
177
Windows. (You can check the location for your system by using
180
There are three primary configuration files in this location:
182
* ``bazaar.conf`` describes default configuration options,
184
* ``locations.conf`` describes configuration information for
185
specific branch locations,
187
* ``authentication.conf`` describes credential information for
190
Each branch can also contain a configuration file that sets values specific
191
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
192
branch. This file is visible to all users of a branch, if you wish to override
193
one of the values for a branch with a setting that is specific to you then you
194
can do so in ``locations.conf``.
199
An ini file has three types of contructs: section headers, section
200
variables and comments.
205
A comment is any line that starts with a "#" (sometimes called a "hash
206
mark", "pound sign" or "number sign"). Comment lines are ignored by
207
Bazaar when parsing ini files.
212
A section header is a word enclosed in brackets that starts at the begining
213
of a line. A typical section header looks like this::
217
The only valid section headers for bazaar.conf currently are [DEFAULT] and
218
[ALIASES]. Section headers are case sensitive. The default section provides for
219
setting variables which can be overridden with the branch config file.
221
For ``locations.conf``, the variables from the section with the
222
longest matching section header are used to the exclusion of other
223
potentially valid section headers. A section header uses the path for
224
the branch as the section header. Some examples include::
226
[http://mybranches.isp.com/~jdoe/branchdir]
227
[/home/jdoe/branches/]
233
A section variable resides within a section. A section variable contains a
234
variable name, an equals sign and a value. For example::
236
email = John Doe <jdoe@isp.com>
237
check_signatures = require
243
Variables defined in a section affect the named directory or URL plus
244
any locations they contain. Policies can be used to change how a
245
variable value is interpreted for contained locations. Currently
246
there are three policies available:
249
the value is interpreted the same for contained locations. This is
250
the default behaviour.
252
the value is only used for the exact location specified by the
255
for contained locations, any additional path components are
256
appended to the value.
258
Policies are specified by keys with names of the form "$var:policy".
259
For example, to define the push location for a tree of branches, the
260
following could be used::
263
push_location = sftp://example.com/location
264
push_location:policy = appendpath
266
With this configuration, the push location for ``/top/location/branch1``
267
would be ``sftp://example.com/location/branch1``.
270
The main configuration file, bazaar.conf
271
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
274
The default section contains the default
275
configuration options for all branches. The default section can be
276
overriden by providing a branch-specific section in ``locations.conf``.
278
A typical ``bazaar.conf`` section often looks like the following::
281
email = John Doe <jdoe@isp.com>
282
editor = /usr/bin/vim
283
check_signatures = check-available
284
create_signatures = when-required
287
The branch location configuration file, locations.conf
288
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
290
``locations.conf`` allows one to specify overriding settings for
291
a specific branch. The format is almost identical to the default section in
292
bazaar.conf with one significant change: The section header, instead of saying
293
default, will be the path to a branch that you wish to override a value
294
for. The '?' and '*' wildcards are supported::
296
[/home/jdoe/branches/nethack]
297
email = Nethack Admin <nethack@nethack.com>
299
[http://hypothetical.site.com/branches/devel-branch]
300
create_signatures = always
301
check_signatures = always
303
[http://bazaar-vcs.org/bzr/*]
304
check_signatures = require
306
The authentication configuration file, authentication.conf
307
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
309
``authentication.conf`` allows one to specify credentials for
310
remote servers. This can be used for all the supported transports and any part
311
of bzr that requires authentication (smtp for example).
313
The syntax of the file obeys the same rules as the others except for the
314
variable policies which don't apply.
316
For more information on the possible uses of the authentication configuration
317
file see :doc:`authentication-help`.
320
Common variable options
321
-----------------------
326
A comma-separated list of debugging options to turn on. The same values
327
can be used as with the -D command-line option (see `help global-options`).
335
The email address to use when committing a branch. Typically takes the form
338
email = Full Name <account@hostname.tld>
343
The path of the editor that you wish to use if *bzr commit* is run without
344
a commit message. This setting is trumped by the environment variable
345
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
351
The default log format to use. Standard log formats are ``long``, ``short``
352
and ``line``. Additional formats may be provided by plugins. The default
358
Defines the behavior for signatures.
361
The gnupg signature for revisions must be present and must be valid.
364
Do not check gnupg signatures of revisions.
367
(default) If gnupg signatures for revisions are present, check them.
368
Bazaar will fail if it finds a bad signature, but will not fail if
369
no signature is present.
374
Defines the behaviour of signing revisions.
377
Sign every new revision that is committed.
380
(default) Sign newly committed revisions only when the branch requires
384
Refuse to sign newly committed revisions, even if the branch
390
Only useful in ``locations.conf``. Defines whether or not the
391
configuration for this section applies to subdirectories:
394
(default) This section applies to subdirectories as well.
397
This section only applies to the branch at this directory and not
403
(Default: "gpg"). Which program should be used to sign and check revisions.
406
gpg_signing_command = /usr/bin/gnpg
411
(Default: "bzr"). The path to the command that should be used to run the smart
412
server for bzr. This value may only be specified in locations.conf, because:
414
- it's needed before branch.conf is accessible
415
- allowing remote branch.conf files to specify commands would be a security
418
It is overridden by the BZR_REMOTE_PATH environment variable.
423
(Default: "localhost"). SMTP server to use when Bazaar needs to send
424
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
426
smtp_username, smtp_password
427
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429
User and password to authenticate to the SMTP server. If smtp_username
430
is set, and smtp_password is not, Bazaar will prompt for a password.
431
These settings are only needed if the SMTP server requires authentication
437
A mail client to use for sending merge requests.
438
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
439
will try ``xdg-email``. If either of these fails, it will fall back to
442
Supported values for specific clients:
444
:claws: Use Claws. This skips a dialog for attaching files.
445
:evolution: Use Evolution.
448
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
449
this works around some bugs that xdg-email doesn't handle.
451
Supported generic values are:
454
:editor: Use your editor to compose the merge request. This also uses
455
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
456
smtp_username and smtp_password.
457
:mapi: Use your preferred e-mail client on Windows.
458
:xdg-email: Use xdg-email to run your preferred mail program
463
The branch you intend to submit your current work to. This is automatically
464
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
465
should usually be set on a per-branch or per-location basis.
470
A publically-accessible version of this branch (implying that this version is
471
not publically-accessible). Used (and set) by ``bzr send``.
476
A list of strings, each string represent a warning that can be emitted by
477
bzr. Mentioning a warning in this list tells bzr to not emit it.
481
* ``format_deprecation``:
482
whether the format deprecation warning is shown on repositories that are
483
using deprecated formats.
486
Branch type specific options
487
----------------------------
489
These options apply only to branches that use the ``dirstate-tags`` or
491
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
492
manually set in ``locations.conf`` or ``bazaar.conf``.
494
append_revisions_only
495
~~~~~~~~~~~~~~~~~~~~~
497
If set to "True" then revisions can only be appended to the log, not
498
removed. A branch with this setting enabled can only pull from
499
another branch if the other branch's log is a longer version of its
500
own. This is normally set by ``bzr init --append-revisions-only``.
505
If present, the location of the default branch for pull or merge.
506
This option is normally set by ``pull --remember`` or ``merge
512
If present, the location of the default branch for push. This option
513
is normally set by ``push --remember``.
518
If present, defines the ``--strict`` option default value for checking
519
uncommitted changes before pushing.
524
If present, defines the ``--strict`` option default value for checking
525
uncommitted changes before pushing into a different VCS without any
531
The location that commits should go to when acting as a checkout.
532
This option is normally set by ``bind``.
537
If set to "True", the branch should act as a checkout, and push each commit to
538
the bound_location. This option is normally set by ``bind``/``unbind``.
543
If present, defines the ``--strict`` option default value for checking
544
uncommitted changes before sending a merge directive.
added
removed
bzrlib/help_topics/en/configuration.txt
