2
=======================
5
Information on how to configure Bazaar.
4
7
.. TODO: Should have some explanation of why you'd want things in
11
13
While most configuration is handled by configuration files, some options
12
14
which may be semi-permanent can also be controlled through the environment.
17
18
Override the email id used by Bazaar. Typical format::
19
20
"John Doe <jdoe@example.com>"
21
22
See also the ``email`` configuration value.
26
26
Override the progress display. Possible values are "none", "dots", "tty"
31
30
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)
31
0 = Standard SIGQUIT behavior
32
1 = Invoke breakin debugger (default)
39
36
Override the home directory used by Bazaar.
44
40
Select a different SSH implementation.
49
44
Control whether to launch a debugger on error.
51
* 0 = Standard behavior
57
50
Path to the Bazaar executable to use when using the bzr+ssh protocol.
59
See also the ``bzr_remote_path`` configuration value.
52
See also the ``bzr_remote_path`` configuration value
64
56
Path to the editor Bazaar should use for commit messages, etc.
69
60
The path to the plugins directory that Bazaar should use.
74
64
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
67
Location of configuration files
68
===============================
69
Each user gets a pair of configurations files in ``$HOME/.bazaar``. The first
70
one, named ``bazaar.conf``, includes default configuration options. The other
71
file, ``locations.conf``, contains configuration information for specific
72
branch locations. These files are sometimes referred to as ``ini files``.
98
74
Each branch can also contain a configuration file that sets values specific
99
75
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
101
77
one of the values for a branch with a setting that is specific to you then you
102
78
can do so in ``locations.conf``.
107
82
An ini file has three types of contructs: section headers, section
108
83
variables and comments.
113
87
A comment is any line that starts with a "#" (sometimes called a "hash
114
88
mark", "pound sign" or "number sign"). Comment lines are ignored by
115
89
Bazaar when parsing ini files.
120
93
A section header is a word enclosed in brackets that starts at the begining
121
94
of a line. A typical section header looks 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.
98
The only valid section header for bazaar.conf is [DEFAULT], which is
99
case sensitive. The default section provides for setting variables
100
which can be overridden with the branch config file.
129
102
For ``locations.conf``, the variables from the section with the
130
103
longest matching section header are used to the exclusion of other
178
151
The main configuration file, bazaar.conf
179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
152
----------------------------------------
181
``bazaar.conf`` only allows one
154
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
182
155
section called ``[DEFAULT]``. This default section contains the default
183
156
configuration options for all branches. The default section can be
184
157
overriden by providing a branch-specific section in ``locations.conf``.
191
164
check_signatures = check-available
192
165
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::
167
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for a
168
specific branch. The format is almost identical to the default section in
169
bazaar.conf with one significant change: The section header, instead of
170
saying default, will be the path to a branch that you wish to override a
171
value for. The '?' and '*' wildcards are supported::
204
173
[/home/jdoe/branches/nethack]
205
174
email = Nethack Admin <nethack@nethack.com>
211
180
[http://bazaar-vcs.org/bzr/*]
212
181
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
-----------------------
183
Common Variable Options
184
=======================
234
188
The email address to use when committing a branch. Typically takes the form
237
191
email = Full Name <account@hostname.tld>
242
195
The path of the editor that you wish to use if *bzr commit* is run without
243
196
a commit message. This setting is trumped by the environment variable
244
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
197
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
250
201
Defines the behavior for signatures.
290
239
branches below it.
292
241
gpg_signing_command
295
243
(Default: "gpg"). Which program should be used to sign and check revisions.
298
246
gpg_signing_command = /usr/bin/gnpg
303
250
(Default: "bzr"). The path to the command that should be used to run the smart
304
251
server for bzr. This value may only be specified in locations.conf, because:
310
257
It is overridden by the BZR_REMOTE_PATH environment variable.
315
261
(Default: "localhost"). SMTP server to use when Bazaar needs to send
316
262
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
318
264
smtp_username, smtp_password
319
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
265
----------------------------
321
266
User and password to authenticate to the SMTP server. If smtp_username
322
267
is set, and smtp_password is not, Bazaar will prompt for a password.
323
268
These settings are only needed if the SMTP server requires authentication
329
273
A mail client to use for sending merge requests.
330
274
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
331
275
will try ``xdg-email``. If either of these fails, it will fall back to
349
293
:xdg-email: Use xdg-email to run your preferred mail program
354
297
The branch you intend to submit your current work to. This is automatically
355
298
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
356
299
should usually be set on a per-branch or per-location basis.
361
303
A publically-accessible version of this branch (implying that this version is
362
304
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
310
These options apply only to branches that use the "dirstate-tags" format. They
370
311
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
371
312
manually set in ``locations.conf`` or ``bazaar.conf``.
373
314
append_revisions_only
374
~~~~~~~~~~~~~~~~~~~~~
315
---------------------
376
316
If set to "True" then revisions can only be appended to the log, not
377
317
removed. A branch with this setting enabled can only pull from
378
318
another branch if the other branch's log is a longer version of its
379
319
own. This is normally set by ``bzr init --append-revisions-only``.
384
323
If present, the location of the default branch for pull or merge.
385
324
This option is normally set by ``pull --remember`` or ``merge
391
329
If present, the location of the default branch for push. This option
392
330
is normally set by ``push --remember``.
397
334
The location that commits should go to when acting as a checkout.
398
335
This option is normally set by ``bind``.
403
339
If set to "True", the branch should act as a checkout, and push each commit to
404
340
the bound_location. This option is normally set by ``bind``/``unbind``.
added
removed
doc/en/user-guide/configuration.txt
