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
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.
104
The examples below uses ':' as the separator, windows users
107
Overriding the default user plugin directory:
108
``BZR_PLUGIN_PATH='/path/to/my/other/plugins'``
110
Disabling the site directory while retaining the user directory:
111
``BZR_PLUGIN_PATH='-site:+user'``
113
Disabling all plugins (better achieved with --no-plugins):
114
``BZR_PLUGIN_PATH='-user:-core:-site'``
116
Overriding the default site plugin directory:
117
``BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user``
124
The path where Bazaar should look for shell plugin external commands.
133
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
134
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
135
Windows. (You can check the location for your system by using
138
There are three primary configuration files in this location:
140
* ``bazaar.conf`` describes default configuration options,
142
* ``locations.conf`` describes configuration information for
143
specific branch locations,
145
* ``authentication.conf`` describes credential information for
148
Each branch can also contain a configuration file that sets values specific
149
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
150
branch. This file is visible to all users of a branch, if you wish to override
151
one of the values for a branch with a setting that is specific to you then you
152
can do so in ``locations.conf``.
16
157
An ini file has three types of contructs: section headers, section
17
158
variables and comments.
21
163
A comment is any line that starts with a "#" (sometimes called a "hash
22
164
mark", "pound sign" or "number sign"). Comment lines are ignored by
23
165
Bazaar when parsing ini files.
27
170
A section header is a word enclosed in brackets that starts at the begining
28
of a line, typical section headers look like this::
171
of a line. A typical section header looks like this::
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.
175
The only valid section headers for bazaar.conf currently are [DEFAULT] and
176
[ALIASES]. Section headers are case sensitive. The default section provides for
177
setting variables which can be overridden with the branch config file.
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::
179
For ``locations.conf``, the variables from the section with the
180
longest matching section header are used to the exclusion of other
181
potentially valid section headers. A section header uses the path for
182
the branch as the section header. Some examples include::
41
184
[http://mybranches.isp.com/~jdoe/branchdir]
42
185
[/home/jdoe/branches/]
49
191
A section variable resides within a section. A section variable contains a
50
variable name, an equals sign and a value and generally takes the following
192
variable name, an equals sign and a value. For example::
53
194
email = John Doe <jdoe@isp.com>
54
195
check_signatures = require
201
Variables defined in a section affect the named directory or URL plus
202
any locations they contain. Policies can be used to change how a
203
variable value is interpreted for contained locations. Currently
204
there are three policies available:
207
the value is interpreted the same for contained locations. This is
208
the default behaviour.
210
the value is only used for the exact location specified by the
213
for contained locations, any additional path components are
214
appended to the value.
216
Policies are specified by keys with names of the form "$var:policy".
217
For example, to define the push location for a tree of branches, the
218
following could be used::
221
push_location = sftp://example.com/location
222
push_location:policy = appendpath
224
With this configuration, the push location for ``/top/location/branch1``
225
would be ``sftp://example.com/location/branch1``.
57
228
The main configuration file, bazaar.conf
58
----------------------------------------
229
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
61
section called '''[DEFAULT]'''. This default section contains the default
231
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
232
The default section contains the default
62
233
configuration options for all branches. The default section can be
63
overriden by providing a branch specific section in locations.conf.
234
overriden by providing a branch-specific section in ``locations.conf``.
65
A typical bazaar.conf section often looks like the following::
236
A typical ``bazaar.conf`` section often looks like the following::
68
239
email = John Doe <jdoe@isp.com>
86
261
[http://bazaar-vcs.org/bzr/*]
87
262
check_signatures = require
89
Common Variable options
90
=======================
264
The authentication configuration file, authentication.conf
265
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
267
``authentication.conf`` allows one to specify credentials for
268
remote servers. This can be used for all the supported transports and any part
269
of bzr that requires authentication (smtp for example).
271
The syntax of the file obeys the same rules as the others except for the
272
variable policies which don't apply.
274
For more information on the possible uses of the authentication configuration
275
file see `Authentication Settings`_.
278
Common variable options
279
-----------------------
284
A comma-separated list of debugging options to turn on. The same values
285
can be used as with the -D command-line option (see `help global-options`).
94
293
The email address to use when committing a branch. Typically takes the form
97
296
email = Full Name <account@hostname.tld>
101
301
The path of the editor that you wish to use if *bzr commit* is run without
102
a commit log message. This setting is trumped by the environment variables
103
$BZR_EDITOR or $EDITOR.
302
a commit message. This setting is trumped by the environment variable
303
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
309
The default log format to use. Standard log formats are ``long``, ``short``
310
and ``line``. Additional formats may be provided by plugins. The default
107
316
Defines the behavior for signatures.
110
the gnupg signature for revisions must be present and must be valid
319
The gnupg signature for revisions must be present and must be valid.
113
Do not check gnupg signatures of revisions.
322
Do not check gnupg signatures of revisions.
116
325
(default) If gnupg signatures for revisions are present, check them.
117
326
Bazaar will fail if it finds a bad signature, but will not fail if
118
no signature is present
327
no signature is present.
120
329
create_signatures
122
Defines the behaviour of signing revisions. Has three possible values:
123
always, never and when-requied.
332
Defines the behaviour of signing revisions.
126
sign every new revision that is committed
335
Sign every new revision that is committed.
129
338
(default) Sign newly committed revisions only when the branch requires
133
Refuse to sign newly committed revisions, even if the branch requires signatures
342
Refuse to sign newly committed revisions, even if the branch
137
Only useful in locations.conf. Defines whether or not the configuration for
138
this section applies to subdirectories:
348
Only useful in ``locations.conf``. Defines whether or not the
349
configuration for this section applies to subdirectories:
141
(default) This section applies to subdirectories as well
352
(default) This section applies to subdirectories as well.
144
355
This section only applies to the branch at this directory and not
147
358
gpg_signing_command
149
361
(Default: "gpg"). Which program should be used to sign and check revisions.
152
364
gpg_signing_command = /usr/bin/gnpg
369
(Default: "bzr"). The path to the command that should be used to run the smart
370
server for bzr. This value may only be specified in locations.conf, because:
372
- it's needed before branch.conf is accessible
373
- allowing remote branch.conf files to specify commands would be a security
376
It is overridden by the BZR_REMOTE_PATH environment variable.
381
(Default: "localhost"). SMTP server to use when Bazaar needs to send
382
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
384
smtp_username, smtp_password
385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
387
User and password to authenticate to the SMTP server. If smtp_username
388
is set, and smtp_password is not, Bazaar will prompt for a password.
389
These settings are only needed if the SMTP server requires authentication
395
A mail client to use for sending merge requests.
396
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
397
will try ``xdg-email``. If either of these fails, it will fall back to
400
Supported values for specific clients:
402
:claws: Use Claws. This skips a dialog for attaching files.
403
:evolution: Use Evolution.
406
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
407
this works around some bugs that xdg-email doesn't handle.
409
Supported generic values are:
412
:editor: Use your editor to compose the merge request. This also uses
413
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
414
smtp_username and smtp_password.
415
:mapi: Use your preferred e-mail client on Windows.
416
:xdg-email: Use xdg-email to run your preferred mail program
421
The branch you intend to submit your current work to. This is automatically
422
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
423
should usually be set on a per-branch or per-location basis.
428
A publically-accessible version of this branch (implying that this version is
429
not publically-accessible). Used (and set) by ``bzr send``.
432
Branch type specific options
433
----------------------------
435
These options apply only to branches that use the ``dirstate-tags`` or
437
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
438
manually set in ``locations.conf`` or ``bazaar.conf``.
440
append_revisions_only
441
~~~~~~~~~~~~~~~~~~~~~
443
If set to "True" then revisions can only be appended to the log, not
444
removed. A branch with this setting enabled can only pull from
445
another branch if the other branch's log is a longer version of its
446
own. This is normally set by ``bzr init --append-revisions-only``.
451
If present, the location of the default branch for pull or merge.
452
This option is normally set by ``pull --remember`` or ``merge
458
If present, the location of the default branch for push. This option
459
is normally set by ``push --remember``.
464
If present, defines the ``--strict`` option default value for checking
465
uncommitted changes before pushing.
470
The location that commits should go to when acting as a checkout.
471
This option is normally set by ``bind``.
476
If set to "True", the branch should act as a checkout, and push each commit to
477
the bound_location. This option is normally set by ``bind``/``unbind``.
482
If present, defines the ``--strict`` option default value for checking
483
uncommitted changes before sending a merge directive.
added
removed
bzrlib/help_topics/en/configuration.txt
