← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
1
1
Configuration Settings
2
2
=======================
3
3
 
4
 
.. Information on how to configure Bazaar.
5
 
 
6
4
.. TODO: Should have some explanation of why you'd want things in
7
5
.. branch.conf.
8
6
 
31
29
~~~~~~~~~~~~~~~
32
30
 
33
31
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
34
 
0 = Standard SIGQUIT behavior
35
 
1 = Invoke breakin debugger (default)
 
32
 
 
33
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
 
34
* 1 = Invoke breakin debugger (default)
36
35
 
37
36
BZR_HOME
38
37
~~~~~~~~
48
47
~~~~~~~
49
48
 
50
49
Control whether to launch a debugger on error.
51
 
0 = Standard behavior
52
 
1 = Launch debugger
 
50
 
 
51
* 0 = Standard behavior
 
52
* 1 = Launch debugger
53
53
 
54
54
BZR_REMOTE_PATH
55
55
~~~~~~~~~~~~~~~
56
56
 
57
57
Path to the Bazaar executable to use when using the bzr+ssh protocol.
58
58
 
59
 
See also the ``bzr_remote_path`` configuration value
 
59
See also the ``bzr_remote_path`` configuration value.
60
60
 
61
61
BZR_EDITOR
62
62
~~~~~~~~~~
80
80
Location
81
81
~~~~~~~~
82
82
 
83
 
Configuration files are located in ``$HOME/.bazaar`` and are
84
 
sometimes referred to as ``ini files``:
 
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:
85
89
 
86
90
* ``bazaar.conf`` describes default configuration options,
87
91
 
174
178
The main configuration file, bazaar.conf
175
179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
176
180
 
177
 
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
 
181
``bazaar.conf`` only allows one
178
182
section called ``[DEFAULT]``. This default section contains the default
179
183
configuration options for all branches. The default section can be
180
184
overriden by providing a branch-specific section in ``locations.conf``.
191
195
The branch location configuration file, locations.conf
192
196
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193
197
 
194
 
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for
 
198
``locations.conf`` allows one to specify overriding settings for
195
199
a specific branch. The format is almost identical to the default section in
196
200
bazaar.conf with one significant change: The section header, instead of saying
197
201
default, will be the path to a branch that you wish to override a value
210
214
The authentication configuration file, authentication.conf
211
215
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
212
216
 
213
 
``$HOME/.bazaar/authentication.conf`` allows one to specify credentials for
 
217
``authentication.conf`` allows one to specify credentials for
214
218
remote servers. This can be used for all the supported transports and any part
215
219
of bzr that requires authentication (smtp for example).
216
220
 
218
222
variable policies which don't apply.
219
223
 
220
224
For more information on the possible uses of the authentication configuration
221
 
file see the `authentication configuration file documentation`_.
 
225
file see `Authentication Settings`_.
222
226
 
223
 
.. _authentication configuration file documentation: authentication_conf.html
224
227
 
225
228
Common variable options
226
229
-----------------------
238
241
 
239
242
The path of the editor that you wish to use if *bzr commit* is run without
240
243
a commit message. This setting is trumped by the environment variable
241
 
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
 
244
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
 
245
variables.
242
246
 
243
247
check_signatures
244
248
~~~~~~~~~~~~~~~~
358
362
not publically-accessible).  Used (and set) by ``bzr send``.
359
363
 
360
364
 
361
 
Branch 6 options
362
 
----------------
 
365
Branch type specific options
 
366
----------------------------
363
367
 
364
 
These options apply only to branches that use the "dirstate-tags" format.  They
 
368
These options apply only to branches that use the ``dirstate-tags`` or
 
369
later format.  They
365
370
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
366
371
manually set in ``locations.conf`` or ``bazaar.conf``.
367
372
 
397
402
 
398
403
If set to "True", the branch should act as a checkout, and push each commit to
399
404
the bound_location.  This option is normally set by ``bind``/``unbind``.
400