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.
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``.
16
103
An ini file has three types of contructs: section headers, section
17
104
variables and comments.
21
109
A comment is any line that starts with a "#" (sometimes called a "hash
22
110
mark", "pound sign" or "number sign"). Comment lines are ignored by
23
111
Bazaar when parsing ini files.
27
116
A section header is a word enclosed in brackets that starts at the begining
28
of a line, typical section headers look like this::
117
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.
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.
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::
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::
41
130
[http://mybranches.isp.com/~jdoe/branchdir]
42
131
[/home/jdoe/branches/]
49
137
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
138
variable name, an equals sign and a value. For example::
53
140
email = John Doe <jdoe@isp.com>
54
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``.
57
174
The main configuration file, bazaar.conf
58
----------------------------------------
175
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
61
section called '''[DEFAULT]'''. This default section contains the default
177
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
178
The default section contains the default
62
179
configuration options for all branches. The default section can be
63
overriden by providing a branch specific section in locations.conf.
180
overriden by providing a branch-specific section in ``locations.conf``.
65
A typical bazaar.conf section often looks like the following::
182
A typical ``bazaar.conf`` section often looks like the following::
68
185
email = John Doe <jdoe@isp.com>
86
207
[http://bazaar-vcs.org/bzr/*]
87
208
check_signatures = require
89
Common Variable options
90
=======================
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`).
94
239
The email address to use when committing a branch. Typically takes the form
97
242
email = Full Name <account@hostname.tld>
101
247
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.
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
107
262
Defines the behavior for signatures.
110
the gnupg signature for revisions must be present and must be valid
265
The gnupg signature for revisions must be present and must be valid.
113
Do not check gnupg signatures of revisions.
268
Do not check gnupg signatures of revisions.
116
271
(default) If gnupg signatures for revisions are present, check them.
117
272
Bazaar will fail if it finds a bad signature, but will not fail if
118
no signature is present
273
no signature is present.
120
275
create_signatures
122
Defines the behaviour of signing revisions. Has three possible values:
123
always, never and when-requied.
278
Defines the behaviour of signing revisions.
126
sign every new revision that is committed
281
Sign every new revision that is committed.
129
284
(default) Sign newly committed revisions only when the branch requires
133
Refuse to sign newly committed revisions, even if the branch requires signatures
288
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:
294
Only useful in ``locations.conf``. Defines whether or not the
295
configuration for this section applies to subdirectories:
141
(default) This section applies to subdirectories as well
298
(default) This section applies to subdirectories as well.
144
301
This section only applies to the branch at this directory and not
147
304
gpg_signing_command
149
307
(Default: "gpg"). Which program should be used to sign and check revisions.
152
310
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
(Default: "localhost"). SMTP server to use when Bazaar needs to send
328
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
330
smtp_username, smtp_password
331
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
333
User and password to authenticate to the SMTP server. If smtp_username
334
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``.
386
append_revisions_only
387
~~~~~~~~~~~~~~~~~~~~~
389
If set to "True" then revisions can only be appended to the log, not
390
removed. A branch with this setting enabled can only pull from
391
another branch if the other branch's log is a longer version of its
392
own. This is normally set by ``bzr init --append-revisions-only``.
397
If present, the location of the default branch for pull or merge.
398
This option is normally set by ``pull --remember`` or ``merge
404
If present, the location of the default branch for push. This option
405
is normally set by ``push --remember``.
410
If present, defines the ``--strict`` option default value for checking
411
uncommitted changes before pushing.
416
The location that commits should go to when acting as a checkout.
417
This option is normally set by ``bind``.
422
If set to "True", the branch should act as a checkout, and push each commit to
423
the bound_location. This option is normally set by ``bind``/``unbind``.
428
If present, defines the ``--strict`` option default value for checking
429
uncommitted changes before sending a merge directive.
added
removed
bzrlib/help_topics/en/configuration.txt
