~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/en/configuration.txt

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Location of configuration file
2
 
==============================
3
 
Each user gets a pair of configurations files in $HOME/.bazaar. The first
4
 
one, named bazaar.conf, includes default configuration options. The other
5
 
file, branches.conf, contains configuration information for specific
6
 
branches.
7
 
 
8
 
General Format
9
 
==============
 
1
Configuration Settings
 
2
=======================
 
3
 
 
4
.. TODO: Should have some explanation of why you'd want things in
 
5
.. branch.conf.
 
6
 
 
7
 
 
8
Environment settings
 
9
---------------------
 
10
 
 
11
While most configuration is handled by configuration files, some options
 
12
which may be semi-permanent can also be controlled through the environment.
 
13
 
 
14
BZR_EMAIL
 
15
~~~~~~~~~
 
16
 
 
17
Override the email id used by Bazaar.  Typical format::
 
18
 
 
19
  "John Doe <jdoe@example.com>"
 
20
 
 
21
See also the ``email`` configuration value.
 
22
 
 
23
BZR_PROGRESS_BAR
 
24
~~~~~~~~~~~~~~~~
 
25
 
 
26
Override the progress display.  Possible values are "none", "dots", "tty"
 
27
 
 
28
BZR_SIGQUIT_PDB
 
29
~~~~~~~~~~~~~~~
 
30
 
 
31
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
 
32
 
 
33
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
 
34
* 1 = Invoke breakin debugger (default)
 
35
 
 
36
BZR_HOME
 
37
~~~~~~~~
 
38
 
 
39
Override the home directory used by Bazaar.
 
40
 
 
41
BZR_SSH
 
42
~~~~~~~
 
43
 
 
44
Select a different SSH implementation.
 
45
 
 
46
BZR_PDB
 
47
~~~~~~~
 
48
 
 
49
Control whether to launch a debugger on error.
 
50
 
 
51
* 0 = Standard behavior
 
52
* 1 = Launch debugger
 
53
 
 
54
BZR_REMOTE_PATH
 
55
~~~~~~~~~~~~~~~
 
56
 
 
57
Path to the Bazaar executable to use when using the bzr+ssh protocol.
 
58
 
 
59
See also the ``bzr_remote_path`` configuration value.
 
60
 
 
61
BZR_EDITOR
 
62
~~~~~~~~~~
 
63
 
 
64
Path to the editor Bazaar should use for commit messages, etc.
 
65
 
 
66
BZR_PLUGIN_PATH
 
67
~~~~~~~~~~~~~~~
 
68
 
 
69
The path to the plugins directory that Bazaar should use.
 
70
 
 
71
BZRPATH
 
72
~~~~~~~
 
73
 
 
74
The path where Bazaar should look for shell plugin external commands.
 
75
 
 
76
 
 
77
Configuration files
 
78
-------------------
 
79
 
 
80
Location
 
81
~~~~~~~~
 
82
 
 
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
 
86
``bzr version``.)
 
87
 
 
88
There are three primary configuration files in this location:
 
89
 
 
90
* ``bazaar.conf`` describes default configuration options,
 
91
 
 
92
* ``locations.conf`` describes configuration information for
 
93
  specific branch locations,
 
94
 
 
95
* ``authentication.conf`` describes credential information for
 
96
  remote servers.
 
97
 
 
98
Each branch can also contain a configuration file that sets values specific
 
99
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
 
100
branch. This file is visible to all users of a branch, if you wish to override
 
101
one of the values for a branch with a setting that is specific to you then you
 
102
can do so in ``locations.conf``.
 
103
 
 
104
General format
 
105
~~~~~~~~~~~~~~
 
106
 
10
107
An ini file has three types of contructs: section headers, section
11
108
variables and comments.
12
109
 
13
 
comment
14
 
-------
 
110
Comments
 
111
^^^^^^^^
 
112
 
15
113
A comment is any line that starts with a "#" (sometimes called a "hash
16
114
mark", "pound sign" or "number sign"). Comment lines are ignored by
17
 
Bazaar-NG when parsing ini files.
18
 
 
19
 
section header
20
 
--------------
 
115
Bazaar when parsing ini files.
 
116
 
 
117
Section headers
 
118
^^^^^^^^^^^^^^^
 
119
 
21
120
A section header is a word enclosed in brackets that starts at the begining
22
 
of a line, typical section headers look like this::
 
121
of a line.  A typical section header looks like this::
23
122
 
24
123
    [DEFAULT]
25
124
 
26
 
The only valid section header for bazaar.conf is [DEFAULT], which is case
27
 
senstive. The default section provides for setting variables which can be
28
 
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.
29
128
 
30
 
For branches.conf, the variables from the section with the longest matching
31
 
section header are used to the exclusion of other potentially valid section
32
 
headers. A section header uses the path for the branch as the section
33
 
header. Some examples include::
 
129
For ``locations.conf``, the variables from the section with the
 
130
longest matching section header are used to the exclusion of other
 
131
potentially valid section headers. A section header uses the path for
 
132
the branch as the section header. Some examples include::
34
133
 
35
134
    [http://mybranches.isp.com/~jdoe/branchdir]
36
135
    [/home/jdoe/branches/]
37
136
 
38
137
 
39
 
 
40
 
section variables
41
 
-----------------
 
138
Section variables
 
139
^^^^^^^^^^^^^^^^^
42
140
 
43
141
A section variable resides within a section. A section variable contains a
44
 
variable name, an equals sign and a value and generally takes the following
45
 
form::
 
142
variable name, an equals sign and a value.  For example::
46
143
 
47
144
    email            = John Doe <jdoe@isp.com>
48
145
    check_signatures = require
49
146
 
50
147
 
 
148
Variable policies
 
149
^^^^^^^^^^^^^^^^^
 
150
 
 
151
Variables defined in a section affect the named directory or URL plus
 
152
any locations they contain.  Policies can be used to change how a
 
153
variable value is interpreted for contained locations.  Currently
 
154
there are three policies available:
 
155
 
 
156
 none:
 
157
   the value is interpreted the same for contained locations.  This is
 
158
   the default behaviour.
 
159
 norecurse:
 
160
   the value is only used for the exact location specified by the
 
161
   section name.
 
162
 appendpath:
 
163
   for contained locations, any additional path components are
 
164
   appended to the value.
 
165
 
 
166
Policies are specified by keys with names of the form "$var:policy".
 
167
For example, to define the push location for a tree of branches, the
 
168
following could be used::
 
169
 
 
170
  [/top/location]
 
171
  push_location = sftp://example.com/location
 
172
  push_location:policy = appendpath
 
173
 
 
174
With this configuration, the push location for ``/top/location/branch1``
 
175
would be ``sftp://example.com/location/branch1``.
 
176
 
 
177
 
51
178
The main configuration file, bazaar.conf
52
 
----------------------------------------
 
179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53
180
 
54
 
The main configuration file, $HOME/.bazaar/bazaar.conf, only allows one
55
 
section called '''[DEFAULT]'''. This default section contains the default
 
181
``bazaar.conf`` only allows one
 
182
section called ``[DEFAULT]``. This default section contains the default
56
183
configuration options for all branches. The default section can be
57
 
overriden by providing a branch specific section in branches.conf.
 
184
overriden by providing a branch-specific section in ``locations.conf``.
58
185
 
59
 
A typical bazaar.conf section often looks like the following::
 
186
A typical ``bazaar.conf`` section often looks like the following::
60
187
 
61
188
    [DEFAULT]
62
189
    email             = John Doe <jdoe@isp.com>
64
191
    check_signatures  = check-available
65
192
    create_signatures = when-required
66
193
 
67
 
$HOME/.bazaar/branches.conf allows one to specify overriding settings for a
68
 
specific branch. The format is almost identical to the default section in
69
 
bazaar.conf with one significant change: The section header, instead of
70
 
saying default, will be the path to a branch that you wish to override a
71
 
value for. The ? and * wildcards are supported::
 
194
 
 
195
The branch location configuration file, locations.conf
 
196
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
197
 
 
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::
72
203
 
73
204
    [/home/jdoe/branches/nethack]
74
205
    email = Nethack Admin <nethack@nethack.com>
77
208
    create_signatures = always
78
209
    check_signatures  = always
79
210
 
80
 
    [http://bazaar-ng.org/bzr/*]
 
211
    [http://bazaar-vcs.org/bzr/*]
81
212
    check_signatures  = require
82
213
 
83
 
Common Variable options
84
 
=======================
 
214
The authentication configuration file, authentication.conf
 
215
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
216
 
 
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).
 
220
 
 
221
The syntax of the file obeys the same rules as the others except for the
 
222
variable policies which don't apply.
 
223
 
 
224
For more information on the possible uses of the authentication configuration
 
225
file see `Authentication Settings`_.
 
226
 
 
227
 
 
228
Common variable options
 
229
-----------------------
85
230
 
86
231
email
87
 
-----
 
232
~~~~~
 
233
 
88
234
The email address to use when committing a branch. Typically takes the form
89
235
of::
90
236
 
91
237
    email = Full Name <account@hostname.tld>
92
238
 
93
239
editor
94
 
------
 
240
~~~~~~
 
241
 
95
242
The path of the editor that you wish to use if *bzr commit* is run without
96
 
a commit log message. This setting is trumped by the environment variables
97
 
$BZREDITOR or $EDITOR.
 
243
a commit message. This setting is trumped by the environment variable
 
244
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
 
245
variables.
98
246
 
99
247
check_signatures
100
 
----------------
 
248
~~~~~~~~~~~~~~~~
 
249
 
101
250
Defines the behavior for signatures.
102
251
 
103
252
require
104
 
    the gnupg signature for revisions must be present and must be valid
 
253
    The gnupg signature for revisions must be present and must be valid.
105
254
 
106
255
ignore
107
 
    Do not check gnupg signatures of revisions. 
 
256
    Do not check gnupg signatures of revisions.
108
257
 
109
258
check-available
110
259
    (default) If gnupg signatures for revisions are present, check them.
111
 
    Bazaar-NG will fail if it finds a bad signature, but will not fail if
112
 
    no signature is present
 
260
    Bazaar will fail if it finds a bad signature, but will not fail if
 
261
    no signature is present.
113
262
 
114
263
create_signatures
115
 
-----------------
116
 
Defines the behaviour of signing revisions. Has three possible values:
117
 
always, never and when-requied.
 
264
~~~~~~~~~~~~~~~~~
 
265
 
 
266
Defines the behaviour of signing revisions.
118
267
 
119
268
always
120
 
    sign every new revision that is committed
 
269
    Sign every new revision that is committed.
121
270
 
122
271
when-required
123
272
    (default) Sign newly committed revisions only when the branch requires
124
 
    signed revisions
 
273
    signed revisions.
125
274
 
126
275
never
127
 
    Refuse to sign newly committed revisions, even if the branch requires signatures
 
276
    Refuse to sign newly committed revisions, even if the branch
 
277
    requires signatures.
128
278
 
129
279
recurse
130
 
-------
131
 
Only useful in branches.conf. Defines whether or not the configuration for
132
 
this section applies to subdirectories:
 
280
~~~~~~~
 
281
 
 
282
Only useful in ``locations.conf``. Defines whether or not the
 
283
configuration for this section applies to subdirectories:
133
284
 
134
285
true
135
 
    (default) This section applies to subdirectories as well
 
286
    (default) This section applies to subdirectories as well.
136
287
 
137
288
false
138
289
    This section only applies to the branch at this directory and not
139
 
    branches 
 
290
    branches below it.
140
291
 
141
292
gpg_signing_command
142
 
-------------------
 
293
~~~~~~~~~~~~~~~~~~~
 
294
 
143
295
(Default: "gpg"). Which program should be used to sign and check revisions.
144
 
example::
 
296
For example::
145
297
 
146
298
    gpg_signing_command = /usr/bin/gnpg
147
299
 
 
300
bzr_remote_path
 
301
~~~~~~~~~~~~~~~
 
302
 
 
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:
 
305
 
 
306
- it's needed before branch.conf is accessible
 
307
- allowing remote branch.conf files to specify commands would be a security
 
308
  risk
 
309
 
 
310
It is overridden by the BZR_REMOTE_PATH environment variable.
 
311
 
 
312
smtp_server
 
313
~~~~~~~~~~~
 
314
 
 
315
(Default: "localhost"). SMTP server to use when Bazaar needs to send
 
316
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
 
317
 
 
318
smtp_username, smtp_password
 
319
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
320
 
 
321
User and password to authenticate to the SMTP server. If smtp_username
 
322
is set, and smtp_password is not, Bazaar will prompt for a password.
 
323
These settings are only needed if the SMTP server requires authentication
 
324
to send mail.
 
325
 
 
326
mail_client
 
327
~~~~~~~~~~~
 
328
 
 
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
 
332
``editor``.
 
333
 
 
334
Supported values for specific clients:
 
335
 
 
336
:claws: Use Claws.  This skips a dialog for attaching files.
 
337
:evolution: Use Evolution.
 
338
:kmail: Use KMail.
 
339
:mutt: Use Mutt.
 
340
:thunderbird: Use Mozilla Thunderbird or Icedove.  For Thunderbird/Icedove 1.5,
 
341
    this works around some bugs that xdg-email doesn't handle.
 
342
 
 
343
Supported generic values are:
 
344
 
 
345
:default: See above.
 
346
:editor: Use your editor to compose the merge request.  This also uses
 
347
    your commit id, (see ``bzr whoami``), smtp_server and (optionally)
 
348
    smtp_username and smtp_password.
 
349
:mapi: Use your preferred e-mail client on Windows.
 
350
:xdg-email: Use xdg-email to run your preferred mail program
 
351
 
 
352
submit_branch
 
353
~~~~~~~~~~~~~
 
354
 
 
355
The branch you intend to submit your current work to.  This is automatically
 
356
set by ``bzr send``, and is also used by the ``submit:`` revision spec.  This
 
357
should usually be set on a per-branch or per-location basis.
 
358
 
 
359
public_branch
 
360
~~~~~~~~~~~~~
 
361
 
 
362
A publically-accessible version of this branch (implying that this version is
 
363
not publically-accessible).  Used (and set) by ``bzr send``.
 
364
 
 
365
 
 
366
Branch type specific options
 
367
----------------------------
 
368
 
 
369
These options apply only to branches that use the ``dirstate-tags`` or
 
370
later format.  They
 
371
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
 
372
manually set in ``locations.conf`` or ``bazaar.conf``.
 
373
 
 
374
append_revisions_only
 
375
~~~~~~~~~~~~~~~~~~~~~
 
376
 
 
377
If set to "True" then revisions can only be appended to the log, not
 
378
removed.  A branch with this setting enabled can only pull from
 
379
another branch if the other branch's log is a longer version of its
 
380
own.  This is normally set by ``bzr init --append-revisions-only``.
 
381
 
 
382
parent_location
 
383
~~~~~~~~~~~~~~~
 
384
 
 
385
If present, the location of the default branch for pull or merge.
 
386
This option is normally set by ``pull --remember`` or ``merge
 
387
--remember``.
 
388
 
 
389
push_location
 
390
~~~~~~~~~~~~~
 
391
 
 
392
If present, the location of the default branch for push.  This option
 
393
is normally set by ``push --remember``.
 
394
 
 
395
bound_location
 
396
~~~~~~~~~~~~~~
 
397
 
 
398
The location that commits should go to when acting as a checkout.
 
399
This option is normally set by ``bind``.
 
400
 
 
401
bound
 
402
~~~~~
 
403
 
 
404
If set to "True", the branch should act as a checkout, and push each commit to
 
405
the bound_location.  This option is normally set by ``bind``/``unbind``.