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 Breezy. Typical format::
15
"John Doe <jdoe@example.com>"
17
See also the ``email`` configuration option.
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.
29
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
31
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
32
* 1 = Invoke breakin debugger (default)
37
Override the home directory used by Breezy.
42
Select a different SSH implementation.
47
Control whether to launch a debugger on error.
49
* 0 = Standard behavior
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.
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 ``brz 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
80
The path to the plugins directory that Breezy should use.
81
If not set, Breezy will search for plugins in:
83
* the user specific plugin directory (containing the ``user`` plugins),
85
* the breezy directory (containing the ``core`` plugins),
87
* the site specific plugin directory if applicable (containing
88
the ``site`` plugins).
90
If ``BRZ_PLUGIN_PATH`` is set in any fashion, it will change the
91
the way the plugin are searched.
93
As for the ``PATH`` variables, if multiple directories are
94
specified in ``BRZ_PLUGIN_PATH`` they should be separated by the
95
platform specific appropriate character (':' on Unix,
98
By default if ``BRZ_PLUGIN_PATH`` is set, it replaces searching
99
in ``user``. However it will continue to search in ``core`` and
100
``site`` unless they are explicitly removed.
102
If you need to change the order or remove one of these
103
directories, you should use special values:
105
* ``-user``, ``-core``, ``-site`` will remove the corresponding
106
path from the default values,
108
* ``+user``, ``+core``, ``+site`` will add the corresponding path
109
before the remaining default values (and also remove it from
112
Note that the special values 'user', 'core' and 'site' should be
113
used literally, they will be substituted by the corresponding,
114
platform specific, values.
116
The examples below use ':' as the separator, windows users
119
Overriding the default user plugin directory::
121
BRZ_PLUGIN_PATH='/path/to/my/other/plugins'
123
Disabling the site directory while retaining the user directory::
125
BRZ_PLUGIN_PATH='-site:+user'
127
Disabling all plugins (better achieved with --no-plugins)::
129
BRZ_PLUGIN_PATH='-user:-core:-site'
131
Overriding the default site plugin directory::
133
BRZ_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 ``BRZ_DISABLE_PLUGINS`` environment variable.
143
In that case, ``brz`` 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
BRZ_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). ``BRZ_PLUGINS_AT`` allows such directories even
160
if they don't appear in ``BRZ_PLUGIN_PATH`` .
162
Plugins specified in this environment variable takes precedence
163
over the ones in ``BRZ_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
``BRZ_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
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/
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
200
``C:\Documents and Settings\<username>\Application Data\Breezy\2.0`` on
201
Windows. (You can check the location for your system by using
204
There are three primary configuration files in this location:
206
* ``breezy.conf`` describes default configuration options,
208
* ``locations.conf`` describes configuration information for
209
specific branch locations,
211
* ``authentication.conf`` describes credential information for
214
Each branch can also contain a configuration file that sets values specific
215
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
216
branch. This file is visible to all users of a branch, if you wish to override
217
one of the values for a branch with a setting that is specific to you then you
218
can do so in ``locations.conf``.
223
An ini file has three types of contructs: section headers, section
224
options and comments.
229
A comment is any line that starts with a "#" (sometimes called a "hash
230
mark", "pound sign" or "number sign"). Comment lines are ignored by
231
Breezy when parsing ini files.
236
A section header is a word enclosed in brackets that starts at the begining
237
of a line. A typical section header looks like this::
241
The only valid section headers for breezy.conf currently are [DEFAULT] and
242
[ALIASES]. Section headers are case sensitive. The default section provides for
243
setting options which can be overridden with the branch config file.
245
For ``locations.conf``, the options from the section with the
246
longest matching section header are used to the exclusion of other
247
potentially valid section headers. A section header uses the path for
248
the branch as the section header. Some examples include::
250
[http://mybranches.isp.com/~jdoe/branchdir]
251
[/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::
260
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
275
there are three policies available:
278
the value is interpreted the same for contained locations. This is
279
the default behaviour.
281
the value is only used for the exact location specified by the
284
for contained locations, any additional path components are
285
appended to the value.
287
Policies are specified by keys with names of the form "<option_name>:policy".
288
For example, to define the push location for a tree of branches, the
289
following could be used::
292
push_location = sftp://example.com/location
293
push_location:policy = appendpath
295
With this configuration, the push location for ``/top/location/branch1``
296
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
354
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
356
``breezy.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
357
The default section contains the default
358
configuration options for all branches. The default section can be
359
overriden by providing a branch-specific section in ``locations.conf``.
361
A typical ``breezy.conf`` section often looks like the following::
364
email = John Doe <jdoe@isp.com>
365
editor = /usr/bin/vim
366
create_signatures = when-required
369
The branch location configuration file, locations.conf
370
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
372
``locations.conf`` allows one to specify overriding settings for
373
a specific branch. The format is almost identical to the default section in
374
breezy.conf with one significant change: The section header, instead of saying
375
default, will be the path to a branch that you wish to override a value
376
for. The '?' and '*' wildcards are supported::
378
[/home/jdoe/branches/nethack]
379
email = Nethack Admin <nethack@nethack.com>
381
[http://hypothetical.site.com/branches/devel-branch]
382
create_signatures = always
384
The authentication configuration file, authentication.conf
385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
387
``authentication.conf`` allows one to specify credentials for
388
remote servers. This can be used for all the supported transports and any part
389
of brz that requires authentication (smtp for example).
391
The syntax of the file obeys the same rules as the others except for the
392
option policies which don't apply.
394
For more information on the possible uses of the authentication configuration
395
file see :doc:`authentication-help`.
404
A comma-separated list of debugging options to turn on. The same values
405
can be used as with the -D command-line option (see `help global-options`).
412
debug_flags = hpss,evil
417
The email address to use when committing a branch. Typically takes the form
420
email = Full Name <account@hostname.tld>
425
The path of the editor that you wish to use if *brz commit* is run without
426
a commit message. This setting is trumped by the environment variable
427
``BRZ_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
433
The default log format to use. Standard log formats are ``long``, ``short``
434
and ``line``. Additional formats may be provided by plugins. The default
440
Reserved for future use. These options will allow a policy for branches to
444
The gnupg signature for revisions must be present and must be valid.
447
Do not check gnupg signatures of revisions.
450
(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
452
no signature is present.
457
Defines the behaviour of signing revisions on commits. By default brz will not
461
Sign every new revision that is committed. If the signing fails then the
462
commit will not be made.
465
Reserved for future use.
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``.
491
Only useful in ``locations.conf``. Defines whether or not the
492
configuration for this section applies to subdirectories:
495
(default) This section applies to subdirectories as well.
498
This section only applies to the branch at this directory and not
504
(Default: "bzr"). The path to the command that should be used to run the smart
505
server for bzr. This value may only be specified in locations.conf, because:
507
- it's needed before branch.conf is accessible
508
- allowing remote branch.conf files to specify commands would be a security
511
It is overridden by the BZR_REMOTE_PATH environment variable.
516
(Default: "localhost"). SMTP server to use when Breezy needs to send
517
email, eg. with ``merge-directive --mail-to``, or the email plugin.
519
smtp_username, smtp_password
520
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
522
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.
524
These settings are only needed if the SMTP server requires authentication
530
By default, brz 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.
538
A mail client to use for sending merge requests.
539
By default, brz will try to use ``mapi`` on Windows. On other platforms, it
540
will try ``xdg-email``. If either of these fails, it will fall back to
543
Supported values for specific clients:
545
:claws: Use Claws. This skips a dialog for attaching files.
546
:evolution: Use Evolution.
549
:thunderbird: Use Mozilla Thunderbird or Icedove. For Thunderbird/Icedove 1.5,
550
this works around some bugs that xdg-email doesn't handle.
552
Supported generic values are:
555
:editor: Use your editor to compose the merge request. This also uses
556
your commit id, (see ``brz whoami``), smtp_server and (optionally)
557
smtp_username and smtp_password.
558
:mapi: Use your preferred e-mail client on Windows.
559
:xdg-email: Use xdg-email to run your preferred mail program
564
If true (default), repository changes are flushed through the OS buffers
565
to physical disk. This is somewhat slower, but means data should not be
566
lost if the machine crashes. See also dirstate.fdatasync.
571
The branch you intend to submit your current work to. This is automatically
572
set by ``brz send``, and is also used by the ``submit:`` revision spec. This
573
should usually be set on a per-branch or per-location basis.
578
A publically-accessible version of this branch (implying that this version is
579
not publically-accessible). Used (and set) by ``brz send``.
584
A list of strings, each string represent a warning that can be emitted by
585
brz. Mentioning a warning in this list tells bzr to not emit it.
589
* ``format_deprecation``:
590
whether the format deprecation warning is shown on repositories that are
591
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 ``brz
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
Branch type specific options
616
----------------------------
618
These options apply only to branches that use the ``dirstate-tags`` or
620
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
621
manually set in ``locations.conf`` or ``breezy.conf``.
623
append_revisions_only
624
~~~~~~~~~~~~~~~~~~~~~
626
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 ``brz init --append-revisions-only``. If you set it
630
manually, use either 'True' or 'False' (case-sensitive) to maintain
631
compatibility with previous brz versions (older than 2.2).
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
643
If present, the location of the default branch for push. This option
644
is normally set by the first ``push`` or ``push --remember``.
649
If present, defines the ``--strict`` option default value for checking
650
uncommitted changes before pushing.
655
The location that commits should go to when acting as a checkout.
656
This option is normally set by ``bind``.
661
If set to "True", the branch should act as a checkout, and push each commit to
662
the bound_location. This option is normally set by ``bind``/``unbind``.
667
If present, defines the ``--strict`` option default value for checking
668
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
$ brz config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
709
$ brz config bzr.mergetool.kdiff3
710
brz: 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
$ brz 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 ``brz qconflicts``.
727
bzr.default_mergetool = kdiff3
added
removed
breezy/help_topics/en/configuration.txt
