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, it's better to disable a plugin (or
124
several) rather than uninstalling them completely. Such plugins
125
can be specified in the ``BZR_DISABLE_PLUGINS`` environment
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'
140
The path where Bazaar should look for shell plugin external commands.
149
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
150
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
151
Windows. (You can check the location for your system by using
154
There are three primary configuration files in this location:
156
* ``bazaar.conf`` describes default configuration options,
158
* ``locations.conf`` describes configuration information for
159
specific branch locations,
161
* ``authentication.conf`` describes credential information for
164
Each branch can also contain a configuration file that sets values specific
165
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
166
branch. This file is visible to all users of a branch, if you wish to override
167
one of the values for a branch with a setting that is specific to you then you
168
can do so in ``locations.conf``.
173
An ini file has three types of contructs: section headers, section
174
variables and comments.
179
A comment is any line that starts with a "#" (sometimes called a "hash
180
mark", "pound sign" or "number sign"). Comment lines are ignored by
181
Bazaar when parsing ini files.
186
A section header is a word enclosed in brackets that starts at the begining
187
of a line. A typical section header looks like this::
191
The only valid section headers for bazaar.conf currently are [DEFAULT] and
192
[ALIASES]. Section headers are case sensitive. The default section provides for
193
setting variables which can be overridden with the branch config file.
195
For ``locations.conf``, the variables from the section with the
196
longest matching section header are used to the exclusion of other
197
potentially valid section headers. A section header uses the path for
198
the branch as the section header. Some examples include::
200
[http://mybranches.isp.com/~jdoe/branchdir]
201
[/home/jdoe/branches/]
207
A section variable resides within a section. A section variable contains a
208
variable name, an equals sign and a value. For example::
210
email = John Doe <jdoe@isp.com>
211
check_signatures = require
217
Variables defined in a section affect the named directory or URL plus
218
any locations they contain. Policies can be used to change how a
219
variable value is interpreted for contained locations. Currently
220
there are three policies available:
223
the value is interpreted the same for contained locations. This is
224
the default behaviour.
226
the value is only used for the exact location specified by the
229
for contained locations, any additional path components are
230
appended to the value.
232
Policies are specified by keys with names of the form "$var:policy".
233
For example, to define the push location for a tree of branches, the
234
following could be used::
237
push_location = sftp://example.com/location
238
push_location:policy = appendpath
240
With this configuration, the push location for ``/top/location/branch1``
241
would be ``sftp://example.com/location/branch1``.
244
The main configuration file, bazaar.conf
245
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
247
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
248
The default section contains the default
249
configuration options for all branches. The default section can be
250
overriden by providing a branch-specific section in ``locations.conf``.
252
A typical ``bazaar.conf`` section often looks like the following::
255
email = John Doe <jdoe@isp.com>
256
editor = /usr/bin/vim
257
check_signatures = check-available
258
create_signatures = when-required
261
The branch location configuration file, locations.conf
262
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
264
``locations.conf`` allows one to specify overriding settings for
265
a specific branch. The format is almost identical to the default section in
266
bazaar.conf with one significant change: The section header, instead of saying
267
default, will be the path to a branch that you wish to override a value
268
for. The '?' and '*' wildcards are supported::
270
[/home/jdoe/branches/nethack]
271
email = Nethack Admin <nethack@nethack.com>
273
[http://hypothetical.site.com/branches/devel-branch]
274
create_signatures = always
275
check_signatures = always
277
[http://bazaar-vcs.org/bzr/*]
278
check_signatures = require
280
The authentication configuration file, authentication.conf
281
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
283
``authentication.conf`` allows one to specify credentials for
284
remote servers. This can be used for all the supported transports and any part
285
of bzr that requires authentication (smtp for example).
287
The syntax of the file obeys the same rules as the others except for the
288
variable policies which don't apply.
290
For more information on the possible uses of the authentication configuration
291
file see :doc:`authentication-help`.
294
Common variable options
295
-----------------------
300
A comma-separated list of debugging options to turn on. The same values
301
can be used as with the -D command-line option (see `help global-options`).
309
The email address to use when committing a branch. Typically takes the form
312
email = Full Name <account@hostname.tld>
317
The path of the editor that you wish to use if *bzr commit* is run without
318
a commit message. This setting is trumped by the environment variable
319
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
325
The default log format to use. Standard log formats are ``long``, ``short``
326
and ``line``. Additional formats may be provided by plugins. The default
332
Defines the behavior for signatures.
335
The gnupg signature for revisions must be present and must be valid.
338
Do not check gnupg signatures of revisions.
341
(default) If gnupg signatures for revisions are present, check them.
342
Bazaar will fail if it finds a bad signature, but will not fail if
343
no signature is present.
348
Defines the behaviour of signing revisions.
351
Sign every new revision that is committed.
354
(default) Sign newly committed revisions only when the branch requires
358
Refuse to sign newly committed revisions, even if the branch
364
Only useful in ``locations.conf``. Defines whether or not the
365
configuration for this section applies to subdirectories:
368
(default) This section applies to subdirectories as well.
371
This section only applies to the branch at this directory and not
377
(Default: "gpg"). Which program should be used to sign and check revisions.
380
gpg_signing_command = /usr/bin/gnpg
385
(Default: "bzr"). The path to the command that should be used to run the smart
386
server for bzr. This value may only be specified in locations.conf, because:
388
- it's needed before branch.conf is accessible
389
- allowing remote branch.conf files to specify commands would be a security
392
It is overridden by the BZR_REMOTE_PATH environment variable.
397
(Default: "localhost"). SMTP server to use when Bazaar needs to send
398
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
400
smtp_username, smtp_password
401
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
403
User and password to authenticate to the SMTP server. If smtp_username
404
is set, and smtp_password is not, Bazaar will prompt for a password.
405
These settings are only needed if the SMTP server requires authentication
411
A mail client to use for sending merge requests.
412
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
413
will try ``xdg-email``. If either of these fails, it will fall back to
416
Supported values for specific clients:
418
:claws: Use Claws. This skips a dialog for attaching files.
419
:evolution: Use Evolution.
422
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
423
this works around some bugs that xdg-email doesn't handle.
425
Supported generic values are:
428
:editor: Use your editor to compose the merge request. This also uses
429
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
430
smtp_username and smtp_password.
431
:mapi: Use your preferred e-mail client on Windows.
432
:xdg-email: Use xdg-email to run your preferred mail program
437
The branch you intend to submit your current work to. This is automatically
438
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
439
should usually be set on a per-branch or per-location basis.
444
A publically-accessible version of this branch (implying that this version is
445
not publically-accessible). Used (and set) by ``bzr send``.
450
A list of strings, each string represent a warning that can be emitted by
451
bzr. Mentioning a warning in this list tells bzr to not emit it.
455
* ``format_deprecation``:
456
whether the format deprecation warning is shown on repositories that are
457
using deprecated formats.
460
Branch type specific options
461
----------------------------
463
These options apply only to branches that use the ``dirstate-tags`` or
465
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
466
manually set in ``locations.conf`` or ``bazaar.conf``.
468
append_revisions_only
469
~~~~~~~~~~~~~~~~~~~~~
471
If set to "True" then revisions can only be appended to the log, not
472
removed. A branch with this setting enabled can only pull from
473
another branch if the other branch's log is a longer version of its
474
own. This is normally set by ``bzr init --append-revisions-only``.
479
If present, the location of the default branch for pull or merge.
480
This option is normally set by ``pull --remember`` or ``merge
486
If present, the location of the default branch for push. This option
487
is normally set by ``push --remember``.
492
If present, defines the ``--strict`` option default value for checking
493
uncommitted changes before pushing.
498
If present, defines the ``--strict`` option default value for checking
499
uncommitted changes before pushing into a different VCS without any
505
The location that commits should go to when acting as a checkout.
506
This option is normally set by ``bind``.
511
If set to "True", the branch should act as a checkout, and push each commit to
512
the bound_location. This option is normally set by ``bind``/``unbind``.
517
If present, defines the ``--strict`` option default value for checking
518
uncommitted changes before sending a merge directive.
added
removed
bzrlib/help_topics/en/configuration.txt
