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
Location of the Bazaar log file. You can check the current location by
66
running ``bzr version``.
68
The log file contains debug information that is useful for diagnosing or
69
reporting problems with Bazaar.
71
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
78
The path to the plugins directory that Bazaar should use.
79
If not set, Bazaar will search for plugins in:
81
* the user specific plugin directory (containing the ``user`` plugins),
83
* the bzrlib directory (containing the ``core`` plugins),
85
* the site specific plugin directory if applicable (containing
86
the ``site`` plugins).
88
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
89
the way the plugin are searched.
91
As for the ``PATH`` variables, if multiple directories are
92
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
93
platform specific appropriate character (':' on Unix/Linux/etc,
96
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
97
in ``user``. However it will continue to search in ``core`` and
98
``site`` unless they are explicitly removed.
100
If you need to change the order or remove one of these
101
directories, you should use special values:
103
* ``-user``, ``-core``, ``-site`` will remove the corresponding
104
path from the default values,
106
* ``+user``, ``+core``, ``+site`` will add the corresponding path
107
before the remaining default values (and also remove it from
110
Note that the special values 'user', 'core' and 'site' should be
111
used literally, they will be substituted by the corresponding,
112
platform specific, values.
114
The examples below use ':' as the separator, windows users
117
Overriding the default user plugin directory::
119
BZR_PLUGIN_PATH='/path/to/my/other/plugins'
121
Disabling the site directory while retaining the user directory::
123
BZR_PLUGIN_PATH='-site:+user'
125
Disabling all plugins (better achieved with --no-plugins)::
127
BZR_PLUGIN_PATH='-user:-core:-site'
129
Overriding the default site plugin directory::
131
BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
136
Under special circumstances (mostly when trying to diagnose a
137
bug), it's better to disable a plugin (or several) rather than
138
uninstalling them completely. Such plugins can be specified in
139
the ``BZR_DISABLE_PLUGINS`` environment variable.
141
In that case, ``bzr`` will stop loading the specified plugins and
142
will raise an import error if they are explicitly imported (by
143
another plugin that depends on them for example).
145
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
147
BZR_DISABLE_PLUGINS='myplugin:yourplugin'
152
When adding a new feature or working on a bug in a plugin,
153
developers often need to use a specific version of a given
154
plugin. Since python requires that the directory containing the
155
code is named like the plugin itself this make it impossible to
156
use arbitrary directory names (using a two-level directory scheme
157
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
158
if they don't appear in ``BZR_PLUGIN_PATH`` .
160
Plugins specified in this environment variable takes precedence
161
over the ones in ``BZR_PLUGIN_PATH``.
163
The variable specified a list of ``plugin_name@plugin path``,
164
``plugin_name`` being the name of the plugin as it appears in
165
python module paths, ``plugin_path`` being the path to the
166
directory containing the plugin code itself
167
(i.e. ``plugins/myplugin`` not ``plugins``). Use ':' as the list
168
separator, use ';' on windows.
173
Using a specific version of ``myplugin``:
174
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
179
The path where Bazaar should look for shell plugin external commands.
188
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
189
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
190
Windows. (You can check the location for your system by using
193
There are three primary configuration files in this location:
195
* ``bazaar.conf`` describes default configuration options,
197
* ``locations.conf`` describes configuration information for
198
specific branch locations,
200
* ``authentication.conf`` describes credential information for
203
Each branch can also contain a configuration file that sets values specific
204
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
205
branch. This file is visible to all users of a branch, if you wish to override
206
one of the values for a branch with a setting that is specific to you then you
207
can do so in ``locations.conf``.
5
Information on how to configure Bazaar.
7
Location of configuration file
8
==============================
9
Each user gets a pair of configurations files in $HOME/.bazaar. The first
10
one, named bazaar.conf, includes default configuration options. The other
11
file, locations.conf, contains configuration information for specific
212
16
An ini file has three types of contructs: section headers, section
213
17
variables and comments.
218
21
A comment is any line that starts with a "#" (sometimes called a "hash
219
22
mark", "pound sign" or "number sign"). Comment lines are ignored by
220
23
Bazaar when parsing ini files.
225
27
A section header is a word enclosed in brackets that starts at the begining
226
of a line. A typical section header looks like this::
28
of a line, typical section headers look like this::
230
The only valid section headers for bazaar.conf currently are [DEFAULT] and
231
[ALIASES]. Section headers are case sensitive. The default section provides for
232
setting variables which can be overridden with the branch config file.
32
The only valid section header for bazaar.conf is [DEFAULT], which is case
33
senstive. The default section provides for setting variables which can be
34
overridden with the branch config file.
234
For ``locations.conf``, the variables from the section with the
235
longest matching section header are used to the exclusion of other
236
potentially valid section headers. A section header uses the path for
237
the branch as the section header. Some examples include::
36
For locations.conf, the variables from the section with the longest matching
37
section header are used to the exclusion of other potentially valid section
38
headers. A section header uses the path for the branch as the section
39
header. Some examples include::
239
41
[http://mybranches.isp.com/~jdoe/branchdir]
240
42
[/home/jdoe/branches/]
246
49
A section variable resides within a section. A section variable contains a
247
variable name, an equals sign and a value. For example::
50
variable name, an equals sign and a value and generally takes the following
249
53
email = John Doe <jdoe@isp.com>
250
54
check_signatures = require
256
Variables defined in a section affect the named directory or URL plus
257
any locations they contain. Policies can be used to change how a
258
variable value is interpreted for contained locations. Currently
259
there are three policies available:
262
the value is interpreted the same for contained locations. This is
263
the default behaviour.
265
the value is only used for the exact location specified by the
268
for contained locations, any additional path components are
269
appended to the value.
271
Policies are specified by keys with names of the form "$var:policy".
272
For example, to define the push location for a tree of branches, the
273
following could be used::
276
push_location = sftp://example.com/location
277
push_location:policy = appendpath
279
With this configuration, the push location for ``/top/location/branch1``
280
would be ``sftp://example.com/location/branch1``.
283
57
The main configuration file, bazaar.conf
284
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
----------------------------------------
286
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
287
The default section contains the default
60
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
61
section called '''[DEFAULT]'''. This default section contains the default
288
62
configuration options for all branches. The default section can be
289
overriden by providing a branch-specific section in ``locations.conf``.
63
overriden by providing a branch specific section in locations.conf.
291
A typical ``bazaar.conf`` section often looks like the following::
65
A typical bazaar.conf section often looks like the following::
294
68
email = John Doe <jdoe@isp.com>
316
86
[http://bazaar-vcs.org/bzr/*]
317
87
check_signatures = require
319
The authentication configuration file, authentication.conf
320
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
322
``authentication.conf`` allows one to specify credentials for
323
remote servers. This can be used for all the supported transports and any part
324
of bzr that requires authentication (smtp for example).
326
The syntax of the file obeys the same rules as the others except for the
327
variable policies which don't apply.
329
For more information on the possible uses of the authentication configuration
330
file see :doc:`authentication-help`.
333
Common variable options
334
-----------------------
339
A comma-separated list of debugging options to turn on. The same values
340
can be used as with the -D command-line option (see `help global-options`).
89
Common Variable options
90
=======================
348
94
The email address to use when committing a branch. Typically takes the form
351
97
email = Full Name <account@hostname.tld>
356
101
The path of the editor that you wish to use if *bzr commit* is run without
357
a commit message. This setting is trumped by the environment variable
358
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
364
The default log format to use. Standard log formats are ``long``, ``short``
365
and ``line``. Additional formats may be provided by plugins. The default
102
a commit log message. This setting is trumped by the environment variables
103
$BZR_EDITOR or $EDITOR.
371
107
Defines the behavior for signatures.
374
The gnupg signature for revisions must be present and must be valid.
110
the gnupg signature for revisions must be present and must be valid
377
Do not check gnupg signatures of revisions.
113
Do not check gnupg signatures of revisions.
380
116
(default) If gnupg signatures for revisions are present, check them.
381
117
Bazaar will fail if it finds a bad signature, but will not fail if
382
no signature is present.
118
no signature is present
384
120
create_signatures
387
Defines the behaviour of signing revisions.
122
Defines the behaviour of signing revisions. Has three possible values:
123
always, never and when-requied.
390
Sign every new revision that is committed.
126
sign every new revision that is committed
393
129
(default) Sign newly committed revisions only when the branch requires
397
Refuse to sign newly committed revisions, even if the branch
133
Refuse to sign newly committed revisions, even if the branch requires signatures
403
Only useful in ``locations.conf``. Defines whether or not the
404
configuration for this section applies to subdirectories:
137
Only useful in locations.conf. Defines whether or not the configuration for
138
this section applies to subdirectories:
407
(default) This section applies to subdirectories as well.
141
(default) This section applies to subdirectories as well
410
144
This section only applies to the branch at this directory and not
413
147
gpg_signing_command
416
149
(Default: "gpg"). Which program should be used to sign and check revisions.
419
152
gpg_signing_command = /usr/bin/gnpg
424
(Default: "bzr"). The path to the command that should be used to run the smart
425
server for bzr. This value may only be specified in locations.conf, because:
427
- it's needed before branch.conf is accessible
428
- allowing remote branch.conf files to specify commands would be a security
431
It is overridden by the BZR_REMOTE_PATH environment variable.
436
(Default: "localhost"). SMTP server to use when Bazaar needs to send
437
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
439
smtp_username, smtp_password
440
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
442
User and password to authenticate to the SMTP server. If smtp_username
443
is set, and smtp_password is not, Bazaar will prompt for a password.
444
These settings are only needed if the SMTP server requires authentication
450
A mail client to use for sending merge requests.
451
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
452
will try ``xdg-email``. If either of these fails, it will fall back to
455
Supported values for specific clients:
457
:claws: Use Claws. This skips a dialog for attaching files.
458
:evolution: Use Evolution.
461
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
462
this works around some bugs that xdg-email doesn't handle.
464
Supported generic values are:
467
:editor: Use your editor to compose the merge request. This also uses
468
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
469
smtp_username and smtp_password.
470
:mapi: Use your preferred e-mail client on Windows.
471
:xdg-email: Use xdg-email to run your preferred mail program
476
The branch you intend to submit your current work to. This is automatically
477
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
478
should usually be set on a per-branch or per-location basis.
483
A publically-accessible version of this branch (implying that this version is
484
not publically-accessible). Used (and set) by ``bzr send``.
489
A list of strings, each string represent a warning that can be emitted by
490
bzr. Mentioning a warning in this list tells bzr to not emit it.
494
* ``format_deprecation``:
495
whether the format deprecation warning is shown on repositories that are
496
using deprecated formats.
499
Branch type specific options
500
----------------------------
502
These options apply only to branches that use the ``dirstate-tags`` or
504
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
505
manually set in ``locations.conf`` or ``bazaar.conf``.
507
append_revisions_only
508
~~~~~~~~~~~~~~~~~~~~~
510
If set to "True" then revisions can only be appended to the log, not
511
removed. A branch with this setting enabled can only pull from another
512
branch if the other branch's log is a longer version of its own. This is
513
normally set by ``bzr init --append-revisions-only``. If you set it
514
manually, use either 'True' or 'False' (case-sensitive) to maintain
515
compatibility with previous bzr versions (older than 2.2).
520
If present, the location of the default branch for pull or merge.
521
This option is normally set by ``pull --remember`` or ``merge
527
If present, the location of the default branch for push. This option
528
is normally set by ``push --remember``.
533
If present, defines the ``--strict`` option default value for checking
534
uncommitted changes before pushing.
539
If present, defines the ``--strict`` option default value for checking
540
uncommitted changes before pushing into a different VCS without any
546
The location that commits should go to when acting as a checkout.
547
This option is normally set by ``bind``.
552
If set to "True", the branch should act as a checkout, and push each commit to
553
the bound_location. This option is normally set by ``bind``/``unbind``.
558
If present, defines the ``--strict`` option default value for checking
559
uncommitted changes before sending a merge directive.
added
removed
doc/configuration.txt
