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.
70
The path where Bazaar should look for shell plugin external commands.
79
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
80
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
81
Windows. (You can check the location for your system by using
84
There are three primary configuration files in this location:
86
* ``bazaar.conf`` describes default configuration options,
88
* ``locations.conf`` describes configuration information for
89
specific branch locations,
91
* ``authentication.conf`` describes credential information for
94
Each branch can also contain a configuration file that sets values specific
95
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
96
branch. This file is visible to all users of a branch, if you wish to override
97
one of the values for a branch with a setting that is specific to you then you
98
can do so in ``locations.conf``.
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``.
103
16
An ini file has three types of contructs: section headers, section
104
17
variables and comments.
109
21
A comment is any line that starts with a "#" (sometimes called a "hash
110
22
mark", "pound sign" or "number sign"). Comment lines are ignored by
111
23
Bazaar when parsing ini files.
116
27
A section header is a word enclosed in brackets that starts at the begining
117
28
of a line. A typical section header looks like this::
121
The only valid section headers for bazaar.conf currently are [DEFAULT] and
122
[ALIASES]. Section headers are case sensitive. The default section provides for
123
setting variables which can be overridden with the branch config file.
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.
125
36
For ``locations.conf``, the variables from the section with the
126
37
longest matching section header are used to the exclusion of other
187
99
check_signatures = check-available
188
100
create_signatures = when-required
191
The branch location configuration file, locations.conf
192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
194
``locations.conf`` allows one to specify overriding settings for
195
a specific branch. The format is almost identical to the default section in
196
bazaar.conf with one significant change: The section header, instead of saying
197
default, will be the path to a branch that you wish to override a value
198
for. The '?' and '*' wildcards are supported::
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::
200
108
[/home/jdoe/branches/nethack]
201
109
email = Nethack Admin <nethack@nethack.com>
207
115
[http://bazaar-vcs.org/bzr/*]
208
116
check_signatures = require
210
The authentication configuration file, authentication.conf
211
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213
``authentication.conf`` allows one to specify credentials for
214
remote servers. This can be used for all the supported transports and any part
215
of bzr that requires authentication (smtp for example).
217
The syntax of the file obeys the same rules as the others except for the
218
variable policies which don't apply.
220
For more information on the possible uses of the authentication configuration
221
file see `Authentication Settings`_.
224
Common variable options
225
-----------------------
230
A comma-separated list of debugging options to turn on. The same values
231
can be used as with the -D command-line option (see `help global-options`).
118
Common Variable Options
119
=======================
239
123
The email address to use when committing a branch. Typically takes the form
242
126
email = Full Name <account@hostname.tld>
247
130
The path of the editor that you wish to use if *bzr commit* is run without
248
a commit message. This setting is trumped by the environment variable
249
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
255
The default log format to use. Standard log formats are ``long``, ``short``
256
and ``line``. Additional formats may be provided by plugins. The default
131
a commit log message. This setting is trumped by the environment variable
132
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
262
136
Defines the behavior for signatures.
302
174
branches below it.
304
176
gpg_signing_command
307
178
(Default: "gpg"). Which program should be used to sign and check revisions.
310
181
gpg_signing_command = /usr/bin/gnpg
315
(Default: "bzr"). The path to the command that should be used to run the smart
316
server for bzr. This value may only be specified in locations.conf, because:
318
- it's needed before branch.conf is accessible
319
- allowing remote branch.conf files to specify commands would be a security
322
It is overridden by the BZR_REMOTE_PATH environment variable.
327
185
(Default: "localhost"). SMTP server to use when Bazaar needs to send
328
186
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
330
188
smtp_username, smtp_password
331
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
189
----------------------------
333
190
User and password to authenticate to the SMTP server. If smtp_username
334
191
is set, and smtp_password is not, Bazaar will prompt for a password.
335
These settings are only needed if the SMTP server requires authentication
341
A mail client to use for sending merge requests.
342
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
343
will try ``xdg-email``. If either of these fails, it will fall back to
346
Supported values for specific clients:
348
:claws: Use Claws. This skips a dialog for attaching files.
349
:evolution: Use Evolution.
352
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
353
this works around some bugs that xdg-email doesn't handle.
355
Supported generic values are:
358
:editor: Use your editor to compose the merge request. This also uses
359
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
360
smtp_username and smtp_password.
361
:mapi: Use your preferred e-mail client on Windows.
362
:xdg-email: Use xdg-email to run your preferred mail program
367
The branch you intend to submit your current work to. This is automatically
368
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
369
should usually be set on a per-branch or per-location basis.
374
A publically-accessible version of this branch (implying that this version is
375
not publically-accessible). Used (and set) by ``bzr send``.
378
Branch type specific options
379
----------------------------
381
These options apply only to branches that use the ``dirstate-tags`` or
383
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
384
manually set in ``locations.conf`` or ``bazaar.conf``.
197
These options apply only to branches that use the "experimental-branch6"
198
format. They are usually set in ``.bzr/branch/branch.conf`` automatically, but
199
may be manually set in ``locations.conf`` or ``bazaar.conf``.
386
201
append_revisions_only
387
~~~~~~~~~~~~~~~~~~~~~
202
---------------------
389
203
If set to "True" then revisions can only be appended to the log, not
390
204
removed. A branch with this setting enabled can only pull from
391
205
another branch if the other branch's log is a longer version of its
392
206
own. This is normally set by ``bzr init --append-revisions-only``.
397
210
If present, the location of the default branch for pull or merge.
398
211
This option is normally set by ``pull --remember`` or ``merge
404
216
If present, the location of the default branch for push. This option
405
217
is normally set by ``push --remember``.
410
221
The location that commits should go to when acting as a checkout.
411
222
This option is normally set by ``bind``.
416
226
If set to "True", the branch should act as a checkout, and push each commit to
417
227
the bound_location. This option is normally set by ``bind``/``unbind``.
233
These options can go into bazaar.conf, branch.conf or into a branch-specific
234
configuration section in locations.conf.
236
bugzilla_<tracker_abbreviation>_url
237
-----------------------------------
238
If present, the location of the Bugzilla bug tracker referred to by
239
<tracker_abbreviation>. This option can then be used together with ``bzr commit
240
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
243
bugzilla_squid_url = http://www.squid-cache.org/bugs
245
would allow ``bzr commit --fixes squid:1234`` to mark Squid's bug 1234 as
248
trac_<tracker_abbrevation>_url
249
------------------------------
250
If present, the location of the Trac instance referred to by
251
<tracker_abbreviation>. This option can then be used together with ``bzr commit
252
--fixes`` to mark bugs in that tracker as being fixed by that commit. For
255
trac_twisted_url = http://www.twistedmatrix.com/trac
257
would allow ``bzr commit --fixes twisted:1234`` to mark Twisted's bug 1234 as
added
removed
doc/configuration.txt
