1
Configuration reference
2
#######################
4
Information on how to configure Bazaar.
6
.. TODO: Should have some explanation of why you'd want things in
12
While most configuration is handled by configuration files, some options
13
which may be semi-permanent can also be controlled through the environment.
17
Override the email id used by Bazaar. Typical format::
19
"John Doe <jdoe@example.com>"
21
See also the ``email`` configuration value.
25
Override the progress display. Possible values are "none", "dots", "tty"
29
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
30
0 = Standard SIGQUIT behavior
31
1 = Invoke breakin debugger (default)
35
Override the home directory used by Bazaar.
39
Select a different SSH implementation.
43
Control whether to launch a debugger on error.
49
Path to the Bazaar executable to use when using the bzr+ssh protocol.
51
See also the ``bzr_remote_path`` configuration value
55
Path to the editor Bazaar should use for commit messages, etc.
59
The path to the plugins directory that Bazaar should use.
63
The path where Bazaar should look for shell plugin external commands.
72
Configuration files are located in ``$HOME/.bazaar`` and are
73
sometimes referred to as ``ini files``:
75
* ``bazaar.conf`` describes default configuration options,
77
* ``locations.conf`` describes configuration information for
78
specific branch locations,
80
* ``authentication.conf`` describes credential information for
83
Each branch can also contain a configuration file that sets values specific
84
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
85
branch. This file is visible to all users of a branch, if you wish to override
86
one of the values for a branch with a setting that is specific to you then you
87
can do so in ``locations.conf``.
92
An ini file has three types of contructs: section headers, section
93
variables and comments.
97
A comment is any line that starts with a "#" (sometimes called a "hash
98
mark", "pound sign" or "number sign"). Comment lines are ignored by
99
Bazaar when parsing ini files.
103
A section header is a word enclosed in brackets that starts at the begining
104
of a line. A typical section header looks like this::
108
The only valid section header for bazaar.conf is [DEFAULT], which is
109
case sensitive. The default section provides for setting variables
110
which can be overridden with the branch config file.
112
For ``locations.conf``, the variables from the section with the
113
longest matching section header are used to the exclusion of other
114
potentially valid section headers. A section header uses the path for
115
the branch as the section header. Some examples include::
117
[http://mybranches.isp.com/~jdoe/branchdir]
118
[/home/jdoe/branches/]
124
A section variable resides within a section. A section variable contains a
125
variable name, an equals sign and a value. For example::
127
email = John Doe <jdoe@isp.com>
128
check_signatures = require
134
Variables defined in a section affect the named directory or URL plus
135
any locations they contain. Policies can be used to change how a
136
variable value is interpreted for contained locations. Currently
137
there are three policies available:
140
the value is interpreted the same for contained locations. This is
141
the default behaviour.
143
the value is only used for the exact location specified by the
146
for contained locations, any additional path components are
147
appended to the value.
149
Policies are specified by keys with names of the form "$var:policy".
150
For example, to define the push location for a tree of branches, the
151
following could be used::
154
push_location = sftp://example.com/location
155
push_location:policy = appendpath
157
With this configuration, the push location for ``/top/location/branch1``
158
would be ``sftp://example.com/location/branch1``.
161
The main configuration file, bazaar.conf
162
----------------------------------------
164
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
165
section called ``[DEFAULT]``. This default section contains the default
166
configuration options for all branches. The default section can be
167
overriden by providing a branch-specific section in ``locations.conf``.
169
A typical ``bazaar.conf`` section often looks like the following::
172
email = John Doe <jdoe@isp.com>
173
editor = /usr/bin/vim
174
check_signatures = check-available
175
create_signatures = when-required
178
The branch location configuration file, locations.conf
179
------------------------------------------------------
181
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for
182
a specific branch. The format is almost identical to the default section in
183
bazaar.conf with one significant change: The section header, instead of saying
184
default, will be the path to a branch that you wish to override a value
185
for. The '?' and '*' wildcards are supported::
187
[/home/jdoe/branches/nethack]
188
email = Nethack Admin <nethack@nethack.com>
190
[http://hypothetical.site.com/branches/devel-branch]
191
create_signatures = always
192
check_signatures = always
194
[http://bazaar-vcs.org/bzr/*]
195
check_signatures = require
197
The authentication configuration file, authentication.conf
198
----------------------------------------------------------
200
``$HOME/.bazaar/authentication.conf`` allows one to specify credentials for
201
remote servers. This can be used for all the supported transports and any part
202
of bzr that requires authentication (smtp for example).
204
The syntax of the file obeys the same rules as the others except for the
205
variable policies which don't apply.
207
For more information on the possible uses of the authentication configuration
208
file see the `authentication configuration file documentation`_.
210
.. _authentication configuration file documentation: authentication_conf.html
212
Common variable options
213
=======================
217
The email address to use when committing a branch. Typically takes the form
220
email = Full Name <account@hostname.tld>
224
The path of the editor that you wish to use if *bzr commit* is run without
225
a commit message. This setting is trumped by the environment variable
226
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
230
Defines the behavior for signatures.
233
The gnupg signature for revisions must be present and must be valid.
236
Do not check gnupg signatures of revisions.
239
(default) If gnupg signatures for revisions are present, check them.
240
Bazaar will fail if it finds a bad signature, but will not fail if
241
no signature is present.
245
Defines the behaviour of signing revisions.
248
Sign every new revision that is committed.
251
(default) Sign newly committed revisions only when the branch requires
255
Refuse to sign newly committed revisions, even if the branch
260
Only useful in ``locations.conf``. Defines whether or not the
261
configuration for this section applies to subdirectories:
264
(default) This section applies to subdirectories as well.
267
This section only applies to the branch at this directory and not
272
(Default: "gpg"). Which program should be used to sign and check revisions.
275
gpg_signing_command = /usr/bin/gnpg
279
(Default: "bzr"). The path to the command that should be used to run the smart
280
server for bzr. This value may only be specified in locations.conf, because:
282
- it's needed before branch.conf is accessible
283
- allowing remote branch.conf files to specify commands would be a security
286
It is overridden by the BZR_REMOTE_PATH environment variable.
290
(Default: "localhost"). SMTP server to use when Bazaar needs to send
291
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
293
smtp_username, smtp_password
294
----------------------------
295
User and password to authenticate to the SMTP server. If smtp_username
296
is set, and smtp_password is not, Bazaar will prompt for a password.
297
These settings are only needed if the SMTP server requires authentication
302
A mail client to use for sending merge requests.
303
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
304
will try ``xdg-email``. If either of these fails, it will fall back to
307
Supported values for specific clients:
309
:evolution: Use Evolution.
312
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
313
this works around some bugs that xdg-email doesn't handle.
315
Supported generic values are:
318
:editor: Use your editor to compose the merge request. This also uses
319
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
320
smtp_username and smtp_password.
321
:mapi: Use your preferred e-mail client on Windows.
322
:xdg-email: Use xdg-email to run your preferred mail program
326
The branch you intend to submit your current work to. This is automatically
327
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
328
should usually be set on a per-branch or per-location basis.
332
A publically-accessible version of this branch (implying that this version is
333
not publically-accessible). Used (and set) by ``bzr send``.
339
These options apply only to branches that use the "dirstate-tags" format. They
340
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
341
manually set in ``locations.conf`` or ``bazaar.conf``.
343
append_revisions_only
344
---------------------
345
If set to "True" then revisions can only be appended to the log, not
346
removed. A branch with this setting enabled can only pull from
347
another branch if the other branch's log is a longer version of its
348
own. This is normally set by ``bzr init --append-revisions-only``.
352
If present, the location of the default branch for pull or merge.
353
This option is normally set by ``pull --remember`` or ``merge
358
If present, the location of the default branch for push. This option
359
is normally set by ``push --remember``.
363
The location that commits should go to when acting as a checkout.
364
This option is normally set by ``bind``.
368
If set to "True", the branch should act as a checkout, and push each commit to
369
the bound_location. This option is normally set by ``bind``/``unbind``.
added
removed
doc/en/user-guide/configuration.txt
