11
10
Environment variables
13
13
While most configuration is handled by configuration files, some options
14
14
which may be semi-permanent can also be controlled through the environment.
18
19
Override the email id used by Bazaar. Typical format::
20
21
"John Doe <jdoe@example.com>"
22
23
See also the ``email`` configuration value.
26
28
Override the progress display. Possible values are "none", "dots", "tty"
30
33
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
31
34
0 = Standard SIGQUIT behavior
32
35
1 = Invoke breakin debugger (default)
36
40
Override the home directory used by Bazaar.
40
45
Select a different SSH implementation.
44
50
Control whether to launch a debugger on error.
45
51
0 = Standard behavior
46
52
1 = Launch debugger
50
57
Path to the Bazaar executable to use when using the bzr+ssh protocol.
52
59
See also the ``bzr_remote_path`` configuration value
56
64
Path to the editor Bazaar should use for commit messages, etc.
60
69
The path to the plugins directory that Bazaar should use.
64
74
The path where Bazaar should look for shell plugin external commands.
67
77
Configuration files
73
83
Configuration files are located in ``$HOME/.bazaar`` and are
74
84
sometimes referred to as ``ini files``:
87
97
one of the values for a branch with a setting that is specific to you then you
88
98
can do so in ``locations.conf``.
93
103
An ini file has three types of contructs: section headers, section
94
104
variables and comments.
98
109
A comment is any line that starts with a "#" (sometimes called a "hash
99
110
mark", "pound sign" or "number sign"). Comment lines are ignored by
100
111
Bazaar when parsing ini files.
104
116
A section header is a word enclosed in brackets that starts at the begining
105
117
of a line. A typical section header looks like this::
162
174
The main configuration file, bazaar.conf
163
----------------------------------------
175
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165
177
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
166
178
section called ``[DEFAULT]``. This default section contains the default
179
191
The branch location configuration file, locations.conf
180
------------------------------------------------------
192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
182
194
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for
183
195
a specific branch. The format is almost identical to the default section in
196
208
check_signatures = require
198
210
The authentication configuration file, authentication.conf
199
----------------------------------------------------------
211
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
201
213
``$HOME/.bazaar/authentication.conf`` allows one to specify credentials for
202
214
remote servers. This can be used for all the supported transports and any part
211
223
.. _authentication configuration file documentation: authentication_conf.html
213
Common Variable Options
214
=======================
225
Common variable options
226
-----------------------
218
231
The email address to use when committing a branch. Typically takes the form
221
234
email = Full Name <account@hostname.tld>
225
239
The path of the editor that you wish to use if *bzr commit* is run without
226
240
a commit message. This setting is trumped by the environment variable
227
241
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
231
246
Defines the behavior for signatures.
269
286
branches below it.
271
288
gpg_signing_command
273
291
(Default: "gpg"). Which program should be used to sign and check revisions.
276
294
gpg_signing_command = /usr/bin/gnpg
280
299
(Default: "bzr"). The path to the command that should be used to run the smart
281
300
server for bzr. This value may only be specified in locations.conf, because:
287
306
It is overridden by the BZR_REMOTE_PATH environment variable.
291
311
(Default: "localhost"). SMTP server to use when Bazaar needs to send
292
312
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
294
314
smtp_username, smtp_password
295
----------------------------
315
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
296
317
User and password to authenticate to the SMTP server. If smtp_username
297
318
is set, and smtp_password is not, Bazaar will prompt for a password.
298
319
These settings are only needed if the SMTP server requires authentication
303
325
A mail client to use for sending merge requests.
304
326
By default, bzr will try to use ``mapi`` on Windows. On other platforms, it
305
327
will try ``xdg-email``. If either of these fails, it will fall back to
323
345
:xdg-email: Use xdg-email to run your preferred mail program
327
350
The branch you intend to submit your current work to. This is automatically
328
351
set by ``bzr send``, and is also used by the ``submit:`` revision spec. This
329
352
should usually be set on a per-branch or per-location basis.
333
357
A publically-accessible version of this branch (implying that this version is
334
358
not publically-accessible). Used (and set) by ``bzr send``.
340
364
These options apply only to branches that use the "dirstate-tags" format. They
341
365
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
342
366
manually set in ``locations.conf`` or ``bazaar.conf``.
344
368
append_revisions_only
345
---------------------
369
~~~~~~~~~~~~~~~~~~~~~
346
371
If set to "True" then revisions can only be appended to the log, not
347
372
removed. A branch with this setting enabled can only pull from
348
373
another branch if the other branch's log is a longer version of its
349
374
own. This is normally set by ``bzr init --append-revisions-only``.
353
379
If present, the location of the default branch for pull or merge.
354
380
This option is normally set by ``pull --remember`` or ``merge
359
386
If present, the location of the default branch for push. This option
360
387
is normally set by ``push --remember``.
364
392
The location that commits should go to when acting as a checkout.
365
393
This option is normally set by ``bind``.
369
398
If set to "True", the branch should act as a checkout, and push each commit to
370
399
the bound_location. This option is normally set by ``bind``/``unbind``.
added
removed
doc/en/user-guide/configuration.txt
