2
=======================
4
.. TODO: Should have some explanation of why you'd want things in
11
While most configuration is handled by configuration files, some options
12
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.
26
Override the progress display. Possible values are "none", "dots", "tty"
31
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
33
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
34
* 1 = Invoke breakin debugger (default)
39
Override the home directory used by Bazaar.
44
Select a different SSH implementation.
49
Control whether to launch a debugger on error.
51
* 0 = Standard behavior
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`` on Linux/Unix and
84
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
85
Windows. (You can check the location for your system by using
88
There are three primary configuration files in this location:
90
* ``bazaar.conf`` describes default configuration options,
92
* ``locations.conf`` describes configuration information for
93
specific branch locations,
95
* ``authentication.conf`` describes credential information for
98
Each branch can also contain a configuration file that sets values specific
99
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
100
branch. This file is visible to all users of a branch, if you wish to override
101
one of the values for a branch with a setting that is specific to you then you
102
can do so in ``locations.conf``.
1
Location of configuration file
2
==============================
3
Each user gets a pair of configurations files in $HOME/.bazaar. The first
4
one, named bazaar.conf, includes default configuration options. The other
5
file, branches.conf, contains configuration information for specific
107
10
An ini file has three types of contructs: section headers, section
108
11
variables and comments.
113
15
A comment is any line that starts with a "#" (sometimes called a "hash
114
16
mark", "pound sign" or "number sign"). Comment lines are ignored by
115
Bazaar when parsing ini files.
17
Bazaar-NG when parsing ini files.
120
21
A section header is a word enclosed in brackets that starts at the begining
121
of a line. A typical section header looks like this::
22
of a line, typical section headers look like this::
125
The only valid section headers for bazaar.conf currently are [DEFAULT] and
126
[ALIASES]. Section headers are case sensitive. The default section provides for
127
setting variables which can be overridden with the branch config file.
26
The only valid section header for bazaar.conf is [DEFAULT], which is case
27
senstive. The default section provides for setting variables which can be
28
overridden with the branch config file.
129
For ``locations.conf``, the variables from the section with the
130
longest matching section header are used to the exclusion of other
131
potentially valid section headers. A section header uses the path for
132
the branch as the section header. Some examples include::
30
For branches.conf, the variables from the section with the longest matching
31
section header are used to the exclusion of other potentially valid section
32
headers. A section header uses the path for the branch as the section
33
header. Some examples include::
134
35
[http://mybranches.isp.com/~jdoe/branchdir]
135
36
[/home/jdoe/branches/]
141
43
A section variable resides within a section. A section variable contains a
142
variable name, an equals sign and a value. For example::
44
variable name, an equals sign and a value and generally takes the following
144
47
email = John Doe <jdoe@isp.com>
145
48
check_signatures = require
151
Variables defined in a section affect the named directory or URL plus
152
any locations they contain. Policies can be used to change how a
153
variable value is interpreted for contained locations. Currently
154
there are three policies available:
157
the value is interpreted the same for contained locations. This is
158
the default behaviour.
160
the value is only used for the exact location specified by the
163
for contained locations, any additional path components are
164
appended to the value.
166
Policies are specified by keys with names of the form "$var:policy".
167
For example, to define the push location for a tree of branches, the
168
following could be used::
171
push_location = sftp://example.com/location
172
push_location:policy = appendpath
174
With this configuration, the push location for ``/top/location/branch1``
175
would be ``sftp://example.com/location/branch1``.
178
51
The main configuration file, bazaar.conf
179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52
----------------------------------------
181
``bazaar.conf`` only allows one
182
section called ``[DEFAULT]``. This default section contains the default
54
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
55
section called '''[DEFAULT]'''. This default section contains the default
183
56
configuration options for all branches. The default section can be
184
overriden by providing a branch-specific section in ``locations.conf``.
57
overriden by providing a branch specific section in branches.conf.
186
A typical ``bazaar.conf`` section often looks like the following::
59
A typical bazaar.conf section often looks like the following::
189
62
email = John Doe <jdoe@isp.com>
191
64
check_signatures = check-available
192
65
create_signatures = when-required
195
The branch location configuration file, locations.conf
196
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198
``locations.conf`` allows one to specify overriding settings for
199
a specific branch. The format is almost identical to the default section in
200
bazaar.conf with one significant change: The section header, instead of saying
201
default, will be the path to a branch that you wish to override a value
202
for. The '?' and '*' wildcards are supported::
67
$HOME/.bazaar/branches.conf allows one to specify overriding settings for a
68
specific branch. The format is almost identical to the default section in
69
bazaar.conf with one significant change: The section header, instead of
70
saying default, will be the path to a branch that you wish to override a
71
value for. The ? and * wildcards are supported::
204
73
[/home/jdoe/branches/nethack]
205
74
email = Nethack Admin <nethack@nethack.com>
208
77
create_signatures = always
209
78
check_signatures = always
211
[http://bazaar-vcs.org/bzr/*]
80
[http://bazaar-ng.org/bzr/*]
212
81
check_signatures = require
214
The authentication configuration file, authentication.conf
215
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
217
``authentication.conf`` allows one to specify credentials for
218
remote servers. This can be used for all the supported transports and any part
219
of bzr that requires authentication (smtp for example).
221
The syntax of the file obeys the same rules as the others except for the
222
variable policies which don't apply.
224
For more information on the possible uses of the authentication configuration
225
file see `Authentication Settings`_.
228
Common variable options
229
-----------------------
83
Common Variable options
84
=======================
234
88
The email address to use when committing a branch. Typically takes the form
237
91
email = Full Name <account@hostname.tld>
242
95
The path of the editor that you wish to use if *bzr commit* is run without
243
a commit message. This setting is trumped by the environment variable
244
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
96
a commit log message. This setting is trumped by the environment variables
97
$BZREDITOR or $EDITOR.
250
101
Defines the behavior for signatures.
253
The gnupg signature for revisions must be present and must be valid.
104
the gnupg signature for revisions must be present and must be valid
256
Do not check gnupg signatures of revisions.
107
Do not check gnupg signatures of revisions.
259
110
(default) If gnupg signatures for revisions are present, check them.
260
Bazaar will fail if it finds a bad signature, but will not fail if
261
no signature is present.
111
Bazaar-NG will fail if it finds a bad signature, but will not fail if
112
no signature is present
263
114
create_signatures
266
Defines the behaviour of signing revisions.
116
Defines the behaviour of signing revisions. Has three possible values:
117
always, never and when-requied.
269
Sign every new revision that is committed.
120
sign every new revision that is committed
272
123
(default) Sign newly committed revisions only when the branch requires
276
Refuse to sign newly committed revisions, even if the branch
127
Refuse to sign newly committed revisions, even if the branch requires signatures
282
Only useful in ``locations.conf``. Defines whether or not the
283
configuration for this section applies to subdirectories:
131
Only useful in branches.conf. Defines whether or not the configuration for
132
this section applies to subdirectories:
286
(default) This section applies to subdirectories as well.
135
(default) This section applies to subdirectories as well
289
138
This section only applies to the branch at this directory and not
292
141
gpg_signing_command
295
143
(Default: "gpg"). Which program should be used to sign and check revisions.
298
146
gpg_signing_command = /usr/bin/gnpg
303
(Default: "bzr"). The path to the command that should be used to run the smart
304
server for bzr. This value may only be specified in locations.conf, because:
306
- it's needed before branch.conf is accessible
307
- allowing remote branch.conf files to specify commands would be a security
310
It is overridden by the BZR_REMOTE_PATH environment variable.
315
(Default: "localhost"). SMTP server to use when Bazaar needs to send
316
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
318
smtp_username, smtp_password
319
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321
User and password to authenticate to the SMTP server. If smtp_username
322
is set, and smtp_password is not, Bazaar will prompt for a password.
323
These settings are only needed if the SMTP server requires authentication
329
A mail client to use for sending merge requests.
330
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
331
will try ``xdg-email``. If either of these fails, it will fall back to
334
Supported values for specific clients:
336
:evolution: Use Evolution.
339
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
340
this works around some bugs that xdg-email doesn't handle.
342
Supported generic values are:
345
:editor: Use your editor to compose the merge request. This also uses
346
your commit id, (see ``bzr whoami``), smtp_server and (optionally)
347
smtp_username and smtp_password.
348
:mapi: Use your preferred e-mail client on Windows.
349
:xdg-email: Use xdg-email to run your preferred mail program
354
The branch you intend to submit your current work to. This is automatically
355
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
356
should usually be set on a per-branch or per-location basis.
361
A publically-accessible version of this branch (implying that this version is
362
not publically-accessible). Used (and set) by ``bzr send``.
365
Branch type specific options
366
----------------------------
368
These options apply only to branches that use the ``dirstate-tags`` or
370
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
371
manually set in ``locations.conf`` or ``bazaar.conf``.
373
append_revisions_only
374
~~~~~~~~~~~~~~~~~~~~~
376
If set to "True" then revisions can only be appended to the log, not
377
removed. A branch with this setting enabled can only pull from
378
another branch if the other branch's log is a longer version of its
379
own. This is normally set by ``bzr init --append-revisions-only``.
384
If present, the location of the default branch for pull or merge.
385
This option is normally set by ``pull --remember`` or ``merge
391
If present, the location of the default branch for push. This option
392
is normally set by ``push --remember``.
397
The location that commits should go to when acting as a checkout.
398
This option is normally set by ``bind``.
403
If set to "True", the branch should act as a checkout, and push each commit to
404
the bound_location. This option is normally set by ``bind``/``unbind``.
added
removed
doc/configuration.txt
