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
12
branch locations. These files are sometimes referred to as ``ini files``.
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 option.
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 option.
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
214
Each branch can also contain a configuration file that sets values specific
215
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
216
branch. This file is visible to all users of a branch, if you wish to override
217
one of the values for a branch with a setting that is specific to you then you
218
can do so in ``locations.conf``.
16
223
An ini file has three types of contructs: section headers, section
17
224
variables and comments.
21
229
A comment is any line that starts with a "#" (sometimes called a "hash
22
230
mark", "pound sign" or "number sign"). Comment lines are ignored by
23
231
Bazaar when parsing ini files.
27
236
A section header is a word enclosed in brackets that starts at the begining
28
237
of a line. A typical section header looks like this::
32
The only valid section header for bazaar.conf is [DEFAULT], which is
33
case sensitive. The default section provides for setting variables
34
which can be overridden with the branch config file.
241
The only valid section headers for bazaar.conf currently are [DEFAULT] and
242
[ALIASES]. Section headers are case sensitive. The default section provides for
243
setting variables which can be overridden with the branch config file.
36
245
For ``locations.conf``, the variables from the section with the
37
246
longest matching section header are used to the exclusion of other
97
312
email = John Doe <jdoe@isp.com>
98
313
editor = /usr/bin/vim
99
check_signatures = check-available
100
314
create_signatures = when-required
102
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
103
specific branch. The format is almost identical to the default section in
104
bazaar.conf with one significant change: The section header, instead of
105
saying default, will be the path to a branch that you wish to override a
106
value for. The '?' and '*' wildcards are supported::
317
The branch location configuration file, locations.conf
318
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
320
``locations.conf`` allows one to specify overriding settings for
321
a specific branch. The format is almost identical to the default section in
322
bazaar.conf with one significant change: The section header, instead of saying
323
default, will be the path to a branch that you wish to override a value
324
for. The '?' and '*' wildcards are supported::
108
326
[/home/jdoe/branches/nethack]
109
327
email = Nethack Admin <nethack@nethack.com>
111
329
[http://hypothetical.site.com/branches/devel-branch]
112
330
create_signatures = always
113
check_signatures = always
115
[http://bazaar-vcs.org/bzr/*]
116
check_signatures = require
118
Common Variable Options
119
=======================
332
The authentication configuration file, authentication.conf
333
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
335
``authentication.conf`` allows one to specify credentials for
336
remote servers. This can be used for all the supported transports and any part
337
of bzr that requires authentication (smtp for example).
339
The syntax of the file obeys the same rules as the others except for the
340
variable policies which don't apply.
342
For more information on the possible uses of the authentication configuration
343
file see :doc:`authentication-help`.
346
Common variable options
347
-----------------------
352
A comma-separated list of debugging options to turn on. The same values
353
can be used as with the -D command-line option (see `help global-options`).
360
debug_flags = hpss,evil
123
365
The email address to use when committing a branch. Typically takes the form
126
368
email = Full Name <account@hostname.tld>
130
373
The path of the editor that you wish to use if *bzr commit* is run without
131
a commit log message. This setting is trumped by the environment variable
132
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
374
a commit message. This setting is trumped by the environment variable
375
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
381
The default log format to use. Standard log formats are ``long``, ``short``
382
and ``line``. Additional formats may be provided by plugins. The default
136
Defines the behavior for signatures.
388
Reserved for future use. These options will allow a policy for branches to
139
392
The gnupg signature for revisions must be present and must be valid.
142
Do not check gnupg signatures of revisions.
395
Do not check gnupg signatures of revisions.
145
398
(default) If gnupg signatures for revisions are present, check them.
173
446
This section only applies to the branch at this directory and not
176
449
gpg_signing_command
178
452
(Default: "gpg"). Which program should be used to sign and check revisions.
181
455
gpg_signing_command = /usr/bin/gnpg
187
These options apply only to branches that use the "experimental-branch6"
188
format. They are usually set in ``.bzr/branch/branch.conf`` automatically, but
189
may be manually set in ``locations.conf`` or ``bazaar.conf``.
457
The specified command must accept the options "--clearsign" and "-u <email>".
462
(Default: "bzr"). The path to the command that should be used to run the smart
463
server for bzr. This value may only be specified in locations.conf, because:
465
- it's needed before branch.conf is accessible
466
- allowing remote branch.conf files to specify commands would be a security
469
It is overridden by the BZR_REMOTE_PATH environment variable.
474
(Default: "localhost"). SMTP server to use when Bazaar needs to send
475
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
477
smtp_username, smtp_password
478
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
480
User and password to authenticate to the SMTP server. If smtp_username
481
is set, and smtp_password is not, Bazaar will prompt for a password.
482
These settings are only needed if the SMTP server requires authentication
488
If set to true, bzr will automatically break locks held by processes from
489
the same machine and user that are no longer alive. Otherwise, it will
490
print a message and you can break the lock manually, if you are satisfied
491
the object is no longer in use.
496
A mail client to use for sending merge requests.
497
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
498
will try ``xdg-email``. If either of these fails, it will fall back to
501
Supported values for specific clients:
503
:claws: Use Claws. This skips a dialog for attaching files.
504
:evolution: Use Evolution.
507
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
508
this works around some bugs that xdg-email doesn't handle.
510
Supported generic values are:
513
:editor: Use your editor to compose the merge request. This also uses
514
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
515
smtp_username and smtp_password.
516
:mapi: Use your preferred e-mail client on Windows.
517
:xdg-email: Use xdg-email to run your preferred mail program
522
If true (default), repository changes are flushed through the OS buffers
523
to physical disk. This is somewhat slower, but means data should not be
524
lost if the machine crashes. See also dirstate.fdatasync.
529
The branch you intend to submit your current work to. This is automatically
530
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
531
should usually be set on a per-branch or per-location basis.
536
A publically-accessible version of this branch (implying that this version is
537
not publically-accessible). Used (and set) by ``bzr send``.
542
A list of strings, each string represent a warning that can be emitted by
543
bzr. Mentioning a warning in this list tells bzr to not emit it.
547
* ``format_deprecation``:
548
whether the format deprecation warning is shown on repositories that are
549
using deprecated formats.
554
A format name for the default format used when creating branches. See ``bzr
555
help formats`` for possible values.
564
A Python unicode encoding name for text output from bzr, such as log
565
information. Values include: utf8, cp850, ascii, iso-8859-1. The default
566
is the terminal encoding prefered by the operating system.
569
Branch type specific options
570
----------------------------
572
These options apply only to branches that use the ``dirstate-tags`` or
574
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
575
manually set in ``locations.conf`` or ``bazaar.conf``.
191
577
append_revisions_only
192
---------------------
578
~~~~~~~~~~~~~~~~~~~~~
193
580
If set to "True" then revisions can only be appended to the log, not
194
removed. A branch with this setting enabled can only pull from
195
another branch if the other branch's log is a longer version of its
196
own. This is normally set by ``bzr init --append-revisions-only``.
581
removed. A branch with this setting enabled can only pull from another
582
branch if the other branch's log is a longer version of its own. This is
583
normally set by ``bzr init --append-revisions-only``. If you set it
584
manually, use either 'True' or 'False' (case-sensitive) to maintain
585
compatibility with previous bzr versions (older than 2.2).
200
If present, the location of the default branch for pull or merge.
201
This option is normally set by ``pull --remember`` or ``merge
590
If present, the location of the default branch for pull or merge. This option
591
is normally set when creating a branch, the first ``pull`` or by ``pull
206
597
If present, the location of the default branch for push. This option
207
is normally set by ``push --remember``.
598
is normally set by the first ``push`` or ``push --remember``.
603
If present, defines the ``--strict`` option default value for checking
604
uncommitted changes before pushing.
609
If present, defines the ``--strict`` option default value for checking
610
uncommitted changes before pushing into a different VCS without any
211
616
The location that commits should go to when acting as a checkout.
212
617
This option is normally set by ``bind``.
216
622
If set to "True", the branch should act as a checkout, and push each commit to
217
623
the bound_location. This option is normally set by ``bind``/``unbind``.
628
If present, defines the ``--strict`` option default value for checking
629
uncommitted changes before sending a merge directive.
631
add.maximum_file_size
632
~~~~~~~~~~~~~~~~~~~~~
634
Defines the maximum file size the command line "add" operation will allow
635
in recursive mode, with files larger than this value being skipped. You may
636
specify this value as an integer (in which case it is interpreted as bytes),
637
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0
638
will disable skipping.
646
Defines an external merge tool called <name> with the given command-line.
647
Arguments containing spaces should be quoted using single or double quotes. The
648
executable may omit its path if it can be found on the PATH.
650
The following markers can be used in the command-line to substitute filenames
651
involved in the merge conflict::
657
{this_temp} temp copy of file.THIS, used to overwrite output file if merge
662
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
664
bzr.default_mergetool
665
~~~~~~~~~~~~~~~~~~~~~
667
Specifies which external merge tool (as defined above) should be selected by
668
default in tools such as ``bzr qconflicts``.
672
bzr.default_mergetool = kdiff3
added
removed
bzrlib/help_topics/en/configuration.txt
