7
7
While most configuration is handled by configuration files, some options
8
8
which may be semi-permanent can also be controlled through the environment.
13
Override the email id used by Breezy. Typical format::
13
Override the email id used by Bazaar. Typical format::
15
15
"John Doe <jdoe@example.com>"
17
See also the ``email`` configuration option.
17
See also the ``email`` configuration value.
22
Override the progress display. Possible values are "none" or "text". If
23
the value is "none" then no progress bar is displayed. The value "text" draws
24
the ordinary command line progress bar.
22
Override the progress display. Possible values are "none", "dots", "tty"
29
27
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
55
Path to the Bazaar or Breezy executable to use when using the bzr+ssh protocol.
57
See also the ``bzr_remote_path`` configuration option.
53
Path to the Bazaar executable to use when using the bzr+ssh protocol.
55
See also the ``bzr_remote_path`` configuration value.
62
Path to the editor Breezy should use for commit messages, etc.
67
Location of the Breezy log file. You can check the current location by
68
running ``bzr version``.
70
The log file contains debug information that is useful for diagnosing or
71
reporting problems with Breezy.
73
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
60
Path to the editor Bazaar should use for commit messages, etc.
80
The path to the plugins directory that Breezy should use.
81
If not set, Breezy will search for plugins in:
65
The path to the plugins directory that Bazaar should use.
66
If not set, Bazaar will search for plugins in:
83
68
* the user specific plugin directory (containing the ``user`` plugins),
85
* the breezy directory (containing the ``core`` plugins),
70
* the bzrlib directory (containing the ``core`` plugins),
87
72
* the site specific plugin directory if applicable (containing
88
73
the ``site`` plugins).
113
98
used literally, they will be substituted by the corresponding,
114
99
platform specific, values.
116
The examples below use ':' as the separator, windows users
104
The examples below uses ':' as the separator, windows users
119
Overriding the default user plugin directory::
121
BZR_PLUGIN_PATH='/path/to/my/other/plugins'
123
Disabling the site directory while retaining the user directory::
125
BZR_PLUGIN_PATH='-site:+user'
127
Disabling all plugins (better achieved with --no-plugins)::
129
BZR_PLUGIN_PATH='-user:-core:-site'
131
Overriding the default site plugin directory::
133
BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
138
Under special circumstances (mostly when trying to diagnose a
139
bug), it's better to disable a plugin (or several) rather than
140
uninstalling them completely. Such plugins can be specified in
141
the ``BZR_DISABLE_PLUGINS`` environment variable.
143
In that case, ``bzr`` will stop loading the specified plugins and
144
will raise an import error if they are explicitly imported (by
145
another plugin that depends on them for example).
147
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
149
BZR_DISABLE_PLUGINS='myplugin:yourplugin'
154
When adding a new feature or working on a bug in a plugin,
155
developers often need to use a specific version of a given
156
plugin. Since python requires that the directory containing the
157
code is named like the plugin itself this make it impossible to
158
use arbitrary directory names (using a two-level directory scheme
159
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
160
if they don't appear in ``BZR_PLUGIN_PATH`` .
162
Plugins specified in this environment variable takes precedence
163
over the ones in ``BZR_PLUGIN_PATH``.
165
The variable specified a list of ``plugin_name@plugin path``,
166
``plugin_name`` being the name of the plugin as it appears in
167
python module paths, ``plugin_path`` being the path to the
168
directory containing the plugin code itself
169
(i.e. ``plugins/myplugin`` not ``plugins``). Use ':' as the list
170
separator, use ';' on windows.
175
Using a specific version of ``myplugin``:
176
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
107
Overriding the default user plugin directory:
108
``BZR_PLUGIN_PATH='/path/to/my/other/plugins'``
110
Disabling the site directory while retaining the user directory:
111
``BZR_PLUGIN_PATH='-site:+user'``
113
Disabling all plugins (better achieved with --no-plugins):
114
``BZR_PLUGIN_PATH='-user:-core:-site'``
116
Overriding the default site plugin directory:
117
``BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user``
181
The path where Breezy should look for shell plugin external commands.
184
http_proxy, https_proxy
185
~~~~~~~~~~~~~~~~~~~~~~~
187
Specifies the network proxy for outgoing connections, for example::
189
http_proxy=http://proxy.example.com:3128/
190
https_proxy=http://proxy.example.com:3128/
124
The path where Bazaar should look for shell plugin external commands.
193
127
Configuration files
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
200
``C:\Documents and Settings\<username>\Application Data\Breezy\2.0`` on
133
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
134
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
201
135
Windows. (You can check the location for your system by using
202
136
``bzr version``.)
204
138
There are three primary configuration files in this location:
206
* ``breezy.conf`` describes default configuration options,
140
* ``bazaar.conf`` describes default configuration options,
208
142
* ``locations.conf`` describes configuration information for
209
143
specific branch locations,
241
The only valid section headers for breezy.conf currently are [DEFAULT] and
175
The only valid section headers for bazaar.conf currently are [DEFAULT] and
242
176
[ALIASES]. Section headers are case sensitive. The default section provides for
243
setting options which can be overridden with the branch config file.
177
setting variables which can be overridden with the branch config file.
245
For ``locations.conf``, the options from the section with the
179
For ``locations.conf``, the variables from the section with the
246
180
longest matching section header are used to the exclusion of other
247
181
potentially valid section headers. A section header uses the path for
248
182
the branch as the section header. Some examples include::
251
185
[/home/jdoe/branches/]
257
A section option resides within a section. A section option contains an
258
option name, an equals sign and a value. For example::
191
A section variable resides within a section. A section variable contains a
192
variable name, an equals sign and a value. For example::
260
194
email = John Doe <jdoe@isp.com>
261
gpg_signing_key = Amy Pond <amy@example.com>
263
A option can reference other options by enclosing them in curly brackets::
265
my_branch_name = feature_x
266
my_server = bzr+ssh://example.com
267
push_location = {my_server}/project/{my_branch_name}
272
Options defined in a section affect the named directory or URL plus
273
any locations they contain. Policies can be used to change how an
274
option value is interpreted for contained locations. Currently
195
check_signatures = require
201
Variables defined in a section affect the named directory or URL plus
202
any locations they contain. Policies can be used to change how a
203
variable value is interpreted for contained locations. Currently
275
204
there are three policies available:
295
224
With this configuration, the push location for ``/top/location/branch1``
296
225
would be ``sftp://example.com/location/branch1``.
298
Section local options
299
^^^^^^^^^^^^^^^^^^^^^
301
Some options are defined automatically inside a given section and can be
302
refered to in this section only.
304
For example, the ``appendpath`` policy can be used like this::
306
[/home/vila/src/bzr/bugs]
307
mypush = lp:~vila/bzr
308
mypush:policy=appendpath
310
Using ``relpath`` to achieve the same result is done like this::
312
[/home/vila/src/bzr/bugs]
313
mypush = lp:~vila/bzr/{relpath}
315
In both cases, when used in a directory like
316
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
319
lp:~vila/bzr/832013-expand-in-stack
321
Another such option is ``basename`` which can be used like this::
324
mypush = lp:~vila/bzr/{basename}
326
When used in a directory like
327
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
330
lp:~vila/bzr/832013-expand-in-stack
332
Note that ``basename`` here refers to the base name of ``relpath`` which
333
itself is defined as the relative path between the section name and the
336
Another such option is ``branchname``, which refers to the name of a colocated
337
branch. For non-colocated branches, it behaves like basename. It can be used
340
[/home/vila/src/bzr/bugs]
341
mypush = lp:~vila/bzr/{branchname}
343
When used with a colocated branch named ``832013-expand-in-stack``, we'll get::
346
lp:~vila/bzr/832013-expand-in-stack
348
When an option is local to a Section, it cannot be referred to from option
349
values in any other section from the same ``Store`` nor from any other
353
The main configuration file, breezy.conf
228
The main configuration file, bazaar.conf
354
229
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
356
``breezy.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
231
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
357
232
The default section contains the default
358
233
configuration options for all branches. The default section can be
359
234
overriden by providing a branch-specific section in ``locations.conf``.
361
A typical ``breezy.conf`` section often looks like the following::
236
A typical ``bazaar.conf`` section often looks like the following::
364
239
email = John Doe <jdoe@isp.com>
365
240
editor = /usr/bin/vim
241
check_signatures = check-available
366
242
create_signatures = when-required
450
325
(default) If gnupg signatures for revisions are present, check them.
451
Breezy will fail if it finds a bad signature, but will not fail if
326
Bazaar will fail if it finds a bad signature, but will not fail if
452
327
no signature is present.
454
329
create_signatures
455
330
~~~~~~~~~~~~~~~~~
457
Defines the behaviour of signing revisions on commits. By default bzr will not
332
Defines the behaviour of signing revisions.
461
Sign every new revision that is committed. If the signing fails then the
462
commit will not be made.
335
Sign every new revision that is committed.
465
Reserved for future use.
338
(default) Sign newly committed revisions only when the branch requires
468
Reserved for future use.
470
In future it is planned that ``when-required`` will sign newly
471
committed revisions only when the branch requires them. ``never`` will refuse
472
to sign newly committed revisions, even if the branch requires signatures.
477
If true (default), working tree metadata changes are flushed through the
478
OS buffers to physical disk. This is somewhat slower, but means data
479
should not be lost if the machine crashes. See also repository.fdatasync.
484
The GnuPG user identity to use when signing commits. Can be an e-mail
485
address, key fingerprint or full key ID. When unset or when set to
486
"default" Breezy will use the user e-mail set with ``whoami``.
342
Refuse to sign newly committed revisions, even if the branch
516
(Default: "localhost"). SMTP server to use when Breezy needs to send
381
(Default: "localhost"). SMTP server to use when Bazaar needs to send
517
382
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
519
384
smtp_username, smtp_password
520
385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
522
387
User and password to authenticate to the SMTP server. If smtp_username
523
is set, and smtp_password is not, Breezy will prompt for a password.
388
is set, and smtp_password is not, Bazaar will prompt for a password.
524
389
These settings are only needed if the SMTP server requires authentication
530
By default, bzr will automatically break locks held by processes from
531
the same machine and user that are no longer alive. If disabled, it will
532
print a message and you can break the lock manually, if you are satisfied
533
the object is no longer in use.
590
440
whether the format deprecation warning is shown on repositories that are
591
441
using deprecated formats.
593
* ``insecure_permissions``:
594
whether a warning is shown if ``authentication.conf`` can be read
600
A format name for the default format used when creating branches. See ``bzr
601
help formats`` for possible values.
610
A Python unicode encoding name for text output from bzr, such as log
611
information. Values include: utf8, cp850, ascii, iso-8859-1. The default
612
is the terminal encoding prefered by the operating system.
615
444
Branch type specific options
616
445
----------------------------
618
447
These options apply only to branches that use the ``dirstate-tags`` or
619
448
later format. They
620
449
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
621
manually set in ``locations.conf`` or ``breezy.conf``.
450
manually set in ``locations.conf`` or ``bazaar.conf``.
623
452
append_revisions_only
624
453
~~~~~~~~~~~~~~~~~~~~~
626
455
If set to "True" then revisions can only be appended to the log, not
627
removed. A branch with this setting enabled can only pull from another
628
branch if the other branch's log is a longer version of its own. This is
629
normally set by ``bzr init --append-revisions-only``. If you set it
630
manually, use either 'True' or 'False' (case-sensitive) to maintain
631
compatibility with previous bzr versions (older than 2.2).
456
removed. A branch with this setting enabled can only pull from
457
another branch if the other branch's log is a longer version of its
458
own. This is normally set by ``bzr init --append-revisions-only``.
636
If present, the location of the default branch for pull or merge. This option
637
is normally set when creating a branch, the first ``pull`` or by ``pull
463
If present, the location of the default branch for pull or merge.
464
This option is normally set by ``pull --remember`` or ``merge
643
470
If present, the location of the default branch for push. This option
644
is normally set by the first ``push`` or ``push --remember``.
471
is normally set by ``push --remember``.
667
501
If present, defines the ``--strict`` option default value for checking
668
502
uncommitted changes before sending a merge directive.
670
add.maximum_file_size
671
~~~~~~~~~~~~~~~~~~~~~
673
Defines the maximum file size the command line "add" operation will allow
674
in recursive mode, with files larger than this value being skipped. You may
675
specify this value as an integer (in which case it is interpreted as bytes),
676
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0
677
will disable skipping.
685
Defines an external merge tool called <name> with the given command-line.
686
Arguments containing spaces should be quoted using single or double quotes. The
687
executable may omit its path if it can be found on the PATH.
689
The following markers can be used in the command-line to substitute filenames
690
involved in the merge conflict::
696
{this_temp} temp copy of file.THIS, used to overwrite output file if merge
701
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
703
Because ``mergetool`` and ``config`` itself both use curly braces as
704
interpolation markers, trying to display the mergetool line results in the
708
$ bzr config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
709
$ bzr config bzr.mergetool.kdiff3
710
bzr: ERROR: Option base is not defined while expanding "kdiff3 {base} {this} {other} -o {result}".
712
To avoid this, ``config`` can be instructed not to try expanding variables::
714
$ bzr config --all bzr.mergetool.kdiff3
716
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
719
bzr.default_mergetool
720
~~~~~~~~~~~~~~~~~~~~~
722
Specifies which external merge tool (as defined above) should be selected by
723
default in tools such as ``bzr qconflicts``.
727
bzr.default_mergetool = kdiff3