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
5
Information on how to configure Bazaar.
7
.. TODO: Should have some explanation of why you'd want things in
10
Location of configuration files
11
===============================
12
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
13
one, named ``bazaar.conf``, includes default configuration options. The other
14
file, ``locations.conf``, contains configuration information for specific
15
branch locations. These files are sometimes referred to as ``ini files``.
148
17
Each branch can also contain a configuration file that sets values specific
149
18
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
151
20
one of the values for a branch with a setting that is specific to you then you
152
21
can do so in ``locations.conf``.
157
25
An ini file has three types of contructs: section headers, section
158
26
variables and comments.
163
30
A comment is any line that starts with a "#" (sometimes called a "hash
164
31
mark", "pound sign" or "number sign"). Comment lines are ignored by
165
32
Bazaar when parsing ini files.
170
36
A section header is a word enclosed in brackets that starts at the begining
171
37
of a line. A typical section header looks like this::
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.
41
The only valid section header for bazaar.conf is [DEFAULT], which is
42
case sensitive. The default section provides for setting variables
43
which can be overridden with the branch config file.
179
45
For ``locations.conf``, the variables from the section with the
180
46
longest matching section header are used to the exclusion of other
241
107
check_signatures = check-available
242
108
create_signatures = when-required
245
The branch location configuration file, locations.conf
246
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248
``locations.conf`` allows one to specify overriding settings for
249
a specific branch. The format is almost identical to the default section in
250
bazaar.conf with one significant change: The section header, instead of saying
251
default, will be the path to a branch that you wish to override a value
252
for. The '?' and '*' wildcards are supported::
110
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
111
specific branch. The format is almost identical to the default section in
112
bazaar.conf with one significant change: The section header, instead of
113
saying default, will be the path to a branch that you wish to override a
114
value for. The '?' and '*' wildcards are supported::
254
116
[/home/jdoe/branches/nethack]
255
117
email = Nethack Admin <nethack@nethack.com>
261
123
[http://bazaar-vcs.org/bzr/*]
262
124
check_signatures = require
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 :doc:`authentication-help`.
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`).
126
Common Variable Options
127
=======================
293
131
The email address to use when committing a branch. Typically takes the form
296
134
email = Full Name <account@hostname.tld>
301
138
The path of the editor that you wish to use if *bzr commit* is run without
302
139
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
140
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
316
144
Defines the behavior for signatures.
356
182
branches below it.
358
184
gpg_signing_command
361
186
(Default: "gpg"). Which program should be used to sign and check revisions.
364
189
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
193
(Default: "localhost"). SMTP server to use when Bazaar needs to send
382
194
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
384
196
smtp_username, smtp_password
385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
197
----------------------------
387
198
User and password to authenticate to the SMTP server. If smtp_username
388
199
is set, and smtp_password is not, Bazaar will prompt for a password.
389
200
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``.
434
A list of strings, each string represent a warning that can be emitted by
435
bzr. Mentioning a warning in this list tells bzr to not emit it.
439
* ``format_deprecation``:
440
whether the format deprecation warning is shown on repositories that are
441
using deprecated formats.
444
Branch type specific options
445
----------------------------
447
These options apply only to branches that use the ``dirstate-tags`` or
449
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
450
manually set in ``locations.conf`` or ``bazaar.conf``.
207
These options apply only to branches that use the "experimental-branch6"
208
format. They are usually set in ``.bzr/branch/branch.conf`` automatically, but
209
may be manually set in ``locations.conf`` or ``bazaar.conf``.
452
211
append_revisions_only
453
~~~~~~~~~~~~~~~~~~~~~
212
---------------------
455
213
If set to "True" then revisions can only be appended to the log, not
456
214
removed. A branch with this setting enabled can only pull from
457
215
another branch if the other branch's log is a longer version of its
458
216
own. This is normally set by ``bzr init --append-revisions-only``.
463
220
If present, the location of the default branch for pull or merge.
464
221
This option is normally set by ``pull --remember`` or ``merge
470
226
If present, the location of the default branch for push. This option
471
227
is normally set by ``push --remember``.
476
If present, defines the ``--strict`` option default value for checking
477
uncommitted changes before pushing.
482
If present, defines the ``--strict`` option default value for checking
483
uncommitted changes before pushing into a different VCS without any
489
231
The location that commits should go to when acting as a checkout.
490
232
This option is normally set by ``bind``.
495
236
If set to "True", the branch should act as a checkout, and push each commit to
496
237
the bound_location. This option is normally set by ``bind``/``unbind``.
501
If present, defines the ``--strict`` option default value for checking
502
uncommitted changes before sending a merge directive.
added
removed
doc/configuration.txt
