1
Configuration reference
2
=======================
4
Information on how to configure Bazaar.
6
.. TODO: Should have some explanation of why you'd want things in
13
While most configuration is handled by configuration files, some options
14
which may be semi-permanent can also be controlled through the environment.
19
Override the email id used by Bazaar. Typical format::
21
"John Doe <jdoe@example.com>"
23
See also the ``email`` configuration value.
28
Override the progress display. Possible values are "none", "dots", "tty"
33
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
34
0 = Standard SIGQUIT behavior
35
1 = Invoke breakin debugger (default)
40
Override the home directory used by Bazaar.
45
Select a different SSH implementation.
50
Control whether to launch a debugger on error.
57
Path to the Bazaar executable to use when using the bzr+ssh protocol.
59
See also the ``bzr_remote_path`` configuration value
64
Path to the editor Bazaar should use for commit messages, etc.
69
The path to the plugins directory that Bazaar should use.
74
The path where Bazaar should look for shell plugin external commands.
83
Configuration files are located in ``$HOME/.bazaar`` and are
84
sometimes referred to as ``ini files``:
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``.
103
An ini file has three types of contructs: section headers, section
104
variables and comments.
109
A comment is any line that starts with a "#" (sometimes called a "hash
110
mark", "pound sign" or "number sign"). Comment lines are ignored by
111
Bazaar when parsing ini files.
116
A section header is a word enclosed in brackets that starts at the begining
117
of a line. A typical section header looks like this::
121
The only valid section header for bazaar.conf is [DEFAULT], which is
122
case sensitive. The default section provides for setting variables
123
which can be overridden with the branch config file.
125
For ``locations.conf``, the variables from the section with the
126
longest matching section header are used to the exclusion of other
127
potentially valid section headers. A section header uses the path for
128
the branch as the section header. Some examples include::
130
[http://mybranches.isp.com/~jdoe/branchdir]
131
[/home/jdoe/branches/]
137
A section variable resides within a section. A section variable contains a
138
variable name, an equals sign and a value. For example::
140
email = John Doe <jdoe@isp.com>
141
check_signatures = require
147
Variables defined in a section affect the named directory or URL plus
148
any locations they contain. Policies can be used to change how a
149
variable value is interpreted for contained locations. Currently
150
there are three policies available:
153
the value is interpreted the same for contained locations. This is
154
the default behaviour.
156
the value is only used for the exact location specified by the
159
for contained locations, any additional path components are
160
appended to the value.
162
Policies are specified by keys with names of the form "$var:policy".
163
For example, to define the push location for a tree of branches, the
164
following could be used::
167
push_location = sftp://example.com/location
168
push_location:policy = appendpath
170
With this configuration, the push location for ``/top/location/branch1``
171
would be ``sftp://example.com/location/branch1``.
174
The main configuration file, bazaar.conf
175
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
178
section called ``[DEFAULT]``. This default section contains the default
179
configuration options for all branches. The default section can be
180
overriden by providing a branch-specific section in ``locations.conf``.
182
A typical ``bazaar.conf`` section often looks like the following::
185
email = John Doe <jdoe@isp.com>
186
editor = /usr/bin/vim
187
check_signatures = check-available
188
create_signatures = when-required
191
The branch location configuration file, locations.conf
192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
194
``$HOME/.bazaar/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::
200
[/home/jdoe/branches/nethack]
201
email = Nethack Admin <nethack@nethack.com>
203
[http://hypothetical.site.com/branches/devel-branch]
204
create_signatures = always
205
check_signatures = always
207
[http://bazaar-vcs.org/bzr/*]
208
check_signatures = require
210
The authentication configuration file, authentication.conf
211
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213
``$HOME/.bazaar/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 the `authentication configuration file documentation`_.
223
.. _authentication configuration file documentation: authentication_conf.html
225
Common variable options
226
-----------------------
231
The email address to use when committing a branch. Typically takes the form
234
email = Full Name <account@hostname.tld>
239
The path of the editor that you wish to use if *bzr commit* is run without
240
a commit message. This setting is trumped by the environment variable
241
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
246
Defines the behavior for signatures.
249
The gnupg signature for revisions must be present and must be valid.
252
Do not check gnupg signatures of revisions.
255
(default) If gnupg signatures for revisions are present, check them.
256
Bazaar will fail if it finds a bad signature, but will not fail if
257
no signature is present.
262
Defines the behaviour of signing revisions.
265
Sign every new revision that is committed.
268
(default) Sign newly committed revisions only when the branch requires
272
Refuse to sign newly committed revisions, even if the branch
278
Only useful in ``locations.conf``. Defines whether or not the
279
configuration for this section applies to subdirectories:
282
(default) This section applies to subdirectories as well.
285
This section only applies to the branch at this directory and not
291
(Default: "gpg"). Which program should be used to sign and check revisions.
294
gpg_signing_command = /usr/bin/gnpg
299
(Default: "bzr"). The path to the command that should be used to run the smart
300
server for bzr. This value may only be specified in locations.conf, because:
302
- it's needed before branch.conf is accessible
303
- allowing remote branch.conf files to specify commands would be a security
306
It is overridden by the BZR_REMOTE_PATH environment variable.
311
(Default: "localhost"). SMTP server to use when Bazaar needs to send
312
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
314
smtp_username, smtp_password
315
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
317
User and password to authenticate to the SMTP server. If smtp_username
318
is set, and smtp_password is not, Bazaar will prompt for a password.
319
These settings are only needed if the SMTP server requires authentication
325
A mail client to use for sending merge requests.
326
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
327
will try ``xdg-email``. If either of these fails, it will fall back to
330
Supported values for specific clients:
332
:evolution: Use Evolution.
335
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
336
this works around some bugs that xdg-email doesn't handle.
338
Supported generic values are:
341
:editor: Use your editor to compose the merge request. This also uses
342
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
343
smtp_username and smtp_password.
344
:mapi: Use your preferred e-mail client on Windows.
345
:xdg-email: Use xdg-email to run your preferred mail program
350
The branch you intend to submit your current work to. This is automatically
351
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
352
should usually be set on a per-branch or per-location basis.
357
A publically-accessible version of this branch (implying that this version is
358
not publically-accessible). Used (and set) by ``bzr send``.
364
These options apply only to branches that use the "dirstate-tags" format. They
365
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
366
manually set in ``locations.conf`` or ``bazaar.conf``.
368
append_revisions_only
369
~~~~~~~~~~~~~~~~~~~~~
371
If set to "True" then revisions can only be appended to the log, not
372
removed. A branch with this setting enabled can only pull from
373
another branch if the other branch's log is a longer version of its
374
own. This is normally set by ``bzr init --append-revisions-only``.
379
If present, the location of the default branch for pull or merge.
380
This option is normally set by ``pull --remember`` or ``merge
386
If present, the location of the default branch for push. This option
387
is normally set by ``push --remember``.
392
The location that commits should go to when acting as a checkout.
393
This option is normally set by ``bind``.
398
If set to "True", the branch should act as a checkout, and push each commit to
399
the bound_location. This option is normally set by ``bind``/``unbind``.
added
removed
doc/en/user-guide/configuration.txt
