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,
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.
182
http_proxy, https_proxy
183
~~~~~~~~~~~~~~~~~~~~~~~
185
Specifies the network proxy for outgoing connections, for example::
187
http_proxy=http://proxy.example.com:3128/
188
https_proxy=http://proxy.example.com:3128/
197
Configuration files are located in ``$HOME/.bazaar`` on Unix and
198
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
199
Windows. (You can check the location for your system by using
202
There are three primary configuration files in this location:
204
* ``bazaar.conf`` describes default configuration options,
206
* ``locations.conf`` describes configuration information for
207
specific branch locations,
209
* ``authentication.conf`` describes credential information for
212
Each branch can also contain a configuration file that sets values specific
213
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
214
branch. This file is visible to all users of a branch, if you wish to override
215
one of the values for a branch with a setting that is specific to you then you
216
can do so in ``locations.conf``.
221
An ini file has three types of contructs: section headers, section
222
variables and comments.
227
A comment is any line that starts with a "#" (sometimes called a "hash
228
mark", "pound sign" or "number sign"). Comment lines are ignored by
229
Bazaar when parsing ini files.
234
A section header is a word enclosed in brackets that starts at the begining
235
of a line. A typical section header looks like this::
239
The only valid section headers for bazaar.conf currently are [DEFAULT] and
240
[ALIASES]. Section headers are case sensitive. The default section provides for
241
setting variables which can be overridden with the branch config file.
243
For ``locations.conf``, the variables from the section with the
244
longest matching section header are used to the exclusion of other
245
potentially valid section headers. A section header uses the path for
246
the branch as the section header. Some examples include::
248
[http://mybranches.isp.com/~jdoe/branchdir]
249
[/home/jdoe/branches/]
255
A section variable resides within a section. A section variable contains a
256
variable name, an equals sign and a value. For example::
258
email = John Doe <jdoe@isp.com>
259
check_signatures = require
265
Variables defined in a section affect the named directory or URL plus
266
any locations they contain. Policies can be used to change how a
267
variable value is interpreted for contained locations. Currently
268
there are three policies available:
271
the value is interpreted the same for contained locations. This is
272
the default behaviour.
274
the value is only used for the exact location specified by the
277
for contained locations, any additional path components are
278
appended to the value.
280
Policies are specified by keys with names of the form "$var:policy".
281
For example, to define the push location for a tree of branches, the
282
following could be used::
285
push_location = sftp://example.com/location
286
push_location:policy = appendpath
288
With this configuration, the push location for ``/top/location/branch1``
289
would be ``sftp://example.com/location/branch1``.
292
The main configuration file, bazaar.conf
293
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
296
The default section contains the default
297
configuration options for all branches. The default section can be
298
overriden by providing a branch-specific section in ``locations.conf``.
300
A typical ``bazaar.conf`` section often looks like the following::
303
email = John Doe <jdoe@isp.com>
304
editor = /usr/bin/vim
305
check_signatures = check-available
306
create_signatures = when-required
309
The branch location configuration file, locations.conf
310
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
312
``locations.conf`` allows one to specify overriding settings for
313
a specific branch. The format is almost identical to the default section in
314
bazaar.conf with one significant change: The section header, instead of saying
315
default, will be the path to a branch that you wish to override a value
316
for. The '?' and '*' wildcards are supported::
318
[/home/jdoe/branches/nethack]
319
email = Nethack Admin <nethack@nethack.com>
321
[http://hypothetical.site.com/branches/devel-branch]
322
create_signatures = always
323
check_signatures = always
325
[http://bazaar-vcs.org/bzr/*]
326
check_signatures = require
328
The authentication configuration file, authentication.conf
329
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
331
``authentication.conf`` allows one to specify credentials for
332
remote servers. This can be used for all the supported transports and any part
333
of bzr that requires authentication (smtp for example).
335
The syntax of the file obeys the same rules as the others except for the
336
variable policies which don't apply.
338
For more information on the possible uses of the authentication configuration
339
file see :doc:`authentication-help`.
342
Common variable options
343
-----------------------
348
A comma-separated list of debugging options to turn on. The same values
349
can be used as with the -D command-line option (see `help global-options`).
357
The email address to use when committing a branch. Typically takes the form
360
email = Full Name <account@hostname.tld>
365
The path of the editor that you wish to use if *bzr commit* is run without
366
a commit message. This setting is trumped by the environment variable
367
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
373
The default log format to use. Standard log formats are ``long``, ``short``
374
and ``line``. Additional formats may be provided by plugins. The default
380
Defines the behavior for signatures.
383
The gnupg signature for revisions must be present and must be valid.
386
Do not check gnupg signatures of revisions.
389
(default) If gnupg signatures for revisions are present, check them.
390
Bazaar will fail if it finds a bad signature, but will not fail if
391
no signature is present.
396
Defines the behaviour of signing revisions.
399
Sign every new revision that is committed.
402
(default) Sign newly committed revisions only when the branch requires
406
Refuse to sign newly committed revisions, even if the branch
412
Only useful in ``locations.conf``. Defines whether or not the
413
configuration for this section applies to subdirectories:
416
(default) This section applies to subdirectories as well.
419
This section only applies to the branch at this directory and not
425
(Default: "gpg"). Which program should be used to sign and check revisions.
428
gpg_signing_command = /usr/bin/gnpg
433
(Default: "bzr"). The path to the command that should be used to run the smart
434
server for bzr. This value may only be specified in locations.conf, because:
436
- it's needed before branch.conf is accessible
437
- allowing remote branch.conf files to specify commands would be a security
440
It is overridden by the BZR_REMOTE_PATH environment variable.
445
(Default: "localhost"). SMTP server to use when Bazaar needs to send
446
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
448
smtp_username, smtp_password
449
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
451
User and password to authenticate to the SMTP server. If smtp_username
452
is set, and smtp_password is not, Bazaar will prompt for a password.
453
These settings are only needed if the SMTP server requires authentication
459
A mail client to use for sending merge requests.
460
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
461
will try ``xdg-email``. If either of these fails, it will fall back to
464
Supported values for specific clients:
466
:claws: Use Claws. This skips a dialog for attaching files.
467
:evolution: Use Evolution.
470
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
471
this works around some bugs that xdg-email doesn't handle.
473
Supported generic values are:
476
:editor: Use your editor to compose the merge request. This also uses
477
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
478
smtp_username and smtp_password.
479
:mapi: Use your preferred e-mail client on Windows.
480
:xdg-email: Use xdg-email to run your preferred mail program
485
The branch you intend to submit your current work to. This is automatically
486
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
487
should usually be set on a per-branch or per-location basis.
492
A publically-accessible version of this branch (implying that this version is
493
not publically-accessible). Used (and set) by ``bzr send``.
498
A list of strings, each string represent a warning that can be emitted by
499
bzr. Mentioning a warning in this list tells bzr to not emit it.
503
* ``format_deprecation``:
504
whether the format deprecation warning is shown on repositories that are
505
using deprecated formats.
514
A Python unicode encoding name for text output from bzr, such as log
515
information. Values include: utf8, cp850, ascii, iso-8859-1. The default
516
is the terminal encoding prefered by the operating system.
519
Branch type specific options
520
----------------------------
522
These options apply only to branches that use the ``dirstate-tags`` or
524
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
525
manually set in ``locations.conf`` or ``bazaar.conf``.
527
append_revisions_only
528
~~~~~~~~~~~~~~~~~~~~~
530
If set to "True" then revisions can only be appended to the log, not
531
removed. A branch with this setting enabled can only pull from another
532
branch if the other branch's log is a longer version of its own. This is
533
normally set by ``bzr init --append-revisions-only``. If you set it
534
manually, use either 'True' or 'False' (case-sensitive) to maintain
535
compatibility with previous bzr versions (older than 2.2).
540
If present, the location of the default branch for pull or merge.
541
This option is normally set by ``pull --remember`` or ``merge
547
If present, the location of the default branch for push. This option
548
is normally set by ``push --remember``.
553
If present, defines the ``--strict`` option default value for checking
554
uncommitted changes before pushing.
559
If present, defines the ``--strict`` option default value for checking
560
uncommitted changes before pushing into a different VCS without any
566
The location that commits should go to when acting as a checkout.
567
This option is normally set by ``bind``.
572
If set to "True", the branch should act as a checkout, and push each commit to
573
the bound_location. This option is normally set by ``bind``/``unbind``.
578
If present, defines the ``--strict`` option default value for checking
579
uncommitted changes before sending a merge directive.
added
removed
bzrlib/help_topics/en/configuration.txt
