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 Bazaar. Typical format::
13
Override the email id used by Breezy. Typical format::
15
15
"John Doe <jdoe@example.com>"
17
See also the ``email`` configuration value.
17
See also the ``email`` configuration option.
22
Override the progress display. Possible values are "none", "dots", "tty"
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.
27
29
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
29
31
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
30
32
* 1 = Invoke breakin debugger (default)
35
Override the home directory used by Bazaar.
37
Override the home directory used by Breezy.
40
42
Select a different SSH implementation.
45
47
Control whether to launch a debugger on error.
53
Path to the Bazaar executable to use when using the bzr+ssh protocol.
55
See also the ``bzr_remote_path`` configuration value.
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.
60
Path to the editor Bazaar should use for commit messages, etc.
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
65
The path to the plugins directory that Bazaar should use.
66
If not set, Bazaar will search for plugins in:
80
The path to the plugins directory that Breezy should use.
81
If not set, Breezy will search for plugins in:
68
83
* the user specific plugin directory (containing the ``user`` plugins),
70
* the bzrlib directory (containing the ``core`` plugins),
85
* the breezy directory (containing the ``core`` plugins),
72
87
* the site specific plugin directory if applicable (containing
73
88
the ``site`` plugins).
78
93
As for the ``PATH`` variables, if multiple directories are
79
94
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
80
platform specific appropriate character (':' on Unix/Linux/etc,
95
platform specific appropriate character (':' on Unix,
83
98
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
160
175
Using a specific version of ``myplugin``:
161
176
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
166
The path where Bazaar should look for shell plugin external commands.
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/
169
193
Configuration files
175
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
176
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
200
``C:\Documents and Settings\<username>\Application Data\Breezy\2.0`` on
177
201
Windows. (You can check the location for your system by using
178
202
``bzr version``.)
199
223
An ini file has three types of contructs: section headers, section
200
variables and comments.
224
options and comments.
205
229
A comment is any line that starts with a "#" (sometimes called a "hash
206
230
mark", "pound sign" or "number sign"). Comment lines are ignored by
207
Bazaar when parsing ini files.
231
Breezy when parsing ini files.
217
241
The only valid section headers for bazaar.conf currently are [DEFAULT] and
218
242
[ALIASES]. Section headers are case sensitive. The default section provides for
219
setting variables which can be overridden with the branch config file.
243
setting options which can be overridden with the branch config file.
221
For ``locations.conf``, the variables from the section with the
245
For ``locations.conf``, the options from the section with the
222
246
longest matching section header are used to the exclusion of other
223
247
potentially valid section headers. A section header uses the path for
224
248
the branch as the section header. Some examples include::
227
251
[/home/jdoe/branches/]
233
A section variable resides within a section. A section variable contains a
234
variable name, an equals sign and a value. For example::
257
A section option resides within a section. A section option contains an
258
option name, an equals sign and a value. For example::
236
260
email = John Doe <jdoe@isp.com>
237
check_signatures = require
243
Variables defined in a section affect the named directory or URL plus
244
any locations they contain. Policies can be used to change how a
245
variable value is interpreted for contained locations. Currently
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
246
275
there are three policies available:
255
284
for contained locations, any additional path components are
256
285
appended to the value.
258
Policies are specified by keys with names of the form "$var:policy".
287
Policies are specified by keys with names of the form "<option_name>:policy".
259
288
For example, to define the push location for a tree of branches, the
260
289
following could be used::
266
295
With this configuration, the push location for ``/top/location/branch1``
267
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
270
353
The main configuration file, bazaar.conf
271
354
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
299
381
[http://hypothetical.site.com/branches/devel-branch]
300
382
create_signatures = always
301
check_signatures = always
303
[http://bazaar-vcs.org/bzr/*]
304
check_signatures = require
306
384
The authentication configuration file, authentication.conf
307
385
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311
389
of bzr that requires authentication (smtp for example).
313
391
The syntax of the file obeys the same rules as the others except for the
314
variable policies which don't apply.
392
option policies which don't apply.
316
394
For more information on the possible uses of the authentication configuration
317
395
file see :doc:`authentication-help`.
320
Common variable options
321
-----------------------
367
450
(default) If gnupg signatures for revisions are present, check them.
368
Bazaar will fail if it finds a bad signature, but will not fail if
451
Breezy will fail if it finds a bad signature, but will not fail if
369
452
no signature is present.
371
454
create_signatures
372
455
~~~~~~~~~~~~~~~~~
374
Defines the behaviour of signing revisions.
457
Defines the behaviour of signing revisions on commits. By default bzr will not
377
Sign every new revision that is committed.
461
Sign every new revision that is committed. If the signing fails then the
462
commit will not be made.
380
(default) Sign newly committed revisions only when the branch requires
465
Reserved for future use.
384
Refuse to sign newly committed revisions, even if the branch
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``.
423
(Default: "localhost"). SMTP server to use when Bazaar needs to send
526
(Default: "localhost"). SMTP server to use when Breezy needs to send
424
527
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
426
529
smtp_username, smtp_password
427
530
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429
532
User and password to authenticate to the SMTP server. If smtp_username
430
is set, and smtp_password is not, Bazaar will prompt for a password.
533
is set, and smtp_password is not, Breezy will prompt for a password.
431
534
These settings are only needed if the SMTP server requires authentication
540
If set to true, bzr will automatically break locks held by processes from
541
the same machine and user that are no longer alive. Otherwise, it will
542
print a message and you can break the lock manually, if you are satisfied
543
the object is no longer in use.
457
568
:mapi: Use your preferred e-mail client on Windows.
458
569
:xdg-email: Use xdg-email to run your preferred mail program
574
If true (default), repository changes are flushed through the OS buffers
575
to physical disk. This is somewhat slower, but means data should not be
576
lost if the machine crashes. See also dirstate.fdatasync.
482
600
whether the format deprecation warning is shown on repositories that are
483
601
using deprecated formats.
606
A format name for the default format used when creating branches. See ``bzr
607
help formats`` for possible values.
616
A Python unicode encoding name for text output from bzr, such as log
617
information. Values include: utf8, cp850, ascii, iso-8859-1. The default
618
is the terminal encoding prefered by the operating system.
486
621
Branch type specific options
487
622
----------------------------
507
If present, the location of the default branch for pull or merge.
508
This option is normally set by ``pull --remember`` or ``merge
642
If present, the location of the default branch for pull or merge. This option
643
is normally set when creating a branch, the first ``pull`` or by ``pull
514
649
If present, the location of the default branch for push. This option
515
is normally set by ``push --remember``.
650
is normally set by the first ``push`` or ``push --remember``.
545
680
If present, defines the ``--strict`` option default value for checking
546
681
uncommitted changes before sending a merge directive.
683
add.maximum_file_size
684
~~~~~~~~~~~~~~~~~~~~~
686
Defines the maximum file size the command line "add" operation will allow
687
in recursive mode, with files larger than this value being skipped. You may
688
specify this value as an integer (in which case it is interpreted as bytes),
689
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0
690
will disable skipping.
698
Defines an external merge tool called <name> with the given command-line.
699
Arguments containing spaces should be quoted using single or double quotes. The
700
executable may omit its path if it can be found on the PATH.
702
The following markers can be used in the command-line to substitute filenames
703
involved in the merge conflict::
709
{this_temp} temp copy of file.THIS, used to overwrite output file if merge
714
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
716
Because ``mergetool`` and ``config`` itself both use curly braces as
717
interpolation markers, trying to display the mergetool line results in the
721
$ bzr config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
722
$ bzr config bzr.mergetool.kdiff3
723
bzr: ERROR: Option base is not defined while expanding "kdiff3 {base} {this} {other} -o {result}".
725
To avoid this, ``config`` can be instructed not to try expanding variables::
727
$ bzr config --all bzr.mergetool.kdiff3
729
bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
732
bzr.default_mergetool
733
~~~~~~~~~~~~~~~~~~~~~
735
Specifies which external merge tool (as defined above) should be selected by
736
default in tools such as ``bzr qconflicts``.
740
bzr.default_mergetool = kdiff3
added
removed
breezy/help_topics/en/configuration.txt
