5
Information on how to configure Bazaar.
2
=======================
7
4
.. TODO: Should have some explanation of why you'd want things in
10
Location of configuration files
11
===============================
12
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
13
one, named ``bazaar.conf``, includes default configuration options. The other
14
file, ``locations.conf``, contains configuration information for specific
15
branch locations. These files are sometimes referred to as ``ini files``.
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
17
98
Each branch can also contain a configuration file that sets values specific
18
99
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
20
101
one of the values for a branch with a setting that is specific to you then you
21
102
can do so in ``locations.conf``.
25
107
An ini file has three types of contructs: section headers, section
26
108
variables and comments.
30
113
A comment is any line that starts with a "#" (sometimes called a "hash
31
114
mark", "pound sign" or "number sign"). Comment lines are ignored by
32
115
Bazaar when parsing ini files.
36
120
A section header is a word enclosed in brackets that starts at the begining
37
121
of a line. A typical section header looks like this::
41
The only valid section header for bazaar.conf is [DEFAULT], which is
42
case sensitive. The default section provides for setting variables
43
which can be overridden with the branch config file.
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.
45
129
For ``locations.conf``, the variables from the section with the
46
130
longest matching section header are used to the exclusion of other
107
191
check_signatures = check-available
108
192
create_signatures = when-required
110
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
111
specific branch. The format is almost identical to the default section in
112
bazaar.conf with one significant change: The section header, instead of
113
saying default, will be the path to a branch that you wish to override a
114
value for. The '?' and '*' wildcards are supported::
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::
116
204
[/home/jdoe/branches/nethack]
117
205
email = Nethack Admin <nethack@nethack.com>
123
211
[http://bazaar-vcs.org/bzr/*]
124
212
check_signatures = require
126
Common Variable Options
127
=======================
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
-----------------------
131
234
The email address to use when committing a branch. Typically takes the form
134
237
email = Full Name <account@hostname.tld>
138
242
The path of the editor that you wish to use if *bzr commit* is run without
139
243
a commit message. This setting is trumped by the environment variable
140
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
244
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
144
250
Defines the behavior for signatures.
182
290
branches below it.
184
292
gpg_signing_command
186
295
(Default: "gpg"). Which program should be used to sign and check revisions.
189
298
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.
193
315
(Default: "localhost"). SMTP server to use when Bazaar needs to send
194
316
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
196
318
smtp_username, smtp_password
197
----------------------------
319
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198
321
User and password to authenticate to the SMTP server. If smtp_username
199
322
is set, and smtp_password is not, Bazaar will prompt for a password.
200
323
These settings are only needed if the SMTP server requires authentication
207
These options apply only to branches that use the "experimental-branch6"
208
format. They are usually set in ``.bzr/branch/branch.conf`` automatically, but
209
may be manually set in ``locations.conf`` or ``bazaar.conf``.
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``.
211
373
append_revisions_only
212
---------------------
374
~~~~~~~~~~~~~~~~~~~~~
213
376
If set to "True" then revisions can only be appended to the log, not
214
377
removed. A branch with this setting enabled can only pull from
215
378
another branch if the other branch's log is a longer version of its
216
379
own. This is normally set by ``bzr init --append-revisions-only``.
220
384
If present, the location of the default branch for pull or merge.
221
385
This option is normally set by ``pull --remember`` or ``merge
226
391
If present, the location of the default branch for push. This option
227
392
is normally set by ``push --remember``.
231
397
The location that commits should go to when acting as a checkout.
232
398
This option is normally set by ``bind``.
236
403
If set to "True", the branch should act as a checkout, and push each commit to
237
404
the bound_location. This option is normally set by ``bind``/``unbind``.
added
removed
bzrlib/help_topics/en/configuration.txt
