← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

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

  • Committer: Martin Pool
  • Date: 2010-08-18 04:26:39 UTC
  • mfrom: (129.1.8 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100818042639-mjoxtngyjwiu05fo
* PPA rebuild for lucid.
* PPA rebuild for karmic.
* PPA rebuild onto jaunty.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
59
59
 
60
60
Path to the editor Bazaar should use for commit messages, etc.
61
61
 
 
62
BZR_LOG
 
63
~~~~~~~
 
64
 
 
65
Location of the Bazaar log file. You can check the current location by
 
66
running ``bzr version``.
 
67
 
 
68
The log file contains debug information that is useful for diagnosing or
 
69
reporting problems with Bazaar.
 
70
 
 
71
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
 
72
will disable logging.
 
73
 
 
74
 
62
75
BZR_PLUGIN_PATH
63
76
~~~~~~~~~~~~~~~
64
77
 
77
90
 
78
91
As for the ``PATH`` variables, if multiple directories are
79
92
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
80
 
platform specific appropriate character (':' on Unix/Linux/etc,
 
93
platform specific appropriate character (':' on Unix,
81
94
';' on windows)
82
95
 
83
96
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
98
111
used literally, they will be substituted by the corresponding,
99
112
platform specific, values.
100
113
 
101
 
Examples:
102
 
^^^^^^^^^
103
 
 
104
 
The examples below uses ':' as the separator, windows users
 
114
The examples below use ':' as the separator, windows users
105
115
should use ';'.
106
116
 
107
 
Overriding the default user plugin directory:
108
 
``BZR_PLUGIN_PATH='/path/to/my/other/plugins'``
109
 
 
110
 
Disabling the site directory while retaining the user directory:
111
 
``BZR_PLUGIN_PATH='-site:+user'``
112
 
 
113
 
Disabling all plugins (better achieved with --no-plugins):
114
 
``BZR_PLUGIN_PATH='-user:-core:-site'``
115
 
 
116
 
Overriding the default site plugin directory:
117
 
``BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user``
118
 
 
119
 
 
 
117
Overriding the default user plugin directory::
 
118
 
 
119
  BZR_PLUGIN_PATH='/path/to/my/other/plugins'
 
120
 
 
121
Disabling the site directory while retaining the user directory::
 
122
 
 
123
  BZR_PLUGIN_PATH='-site:+user'
 
124
 
 
125
Disabling all plugins (better achieved with --no-plugins)::
 
126
 
 
127
  BZR_PLUGIN_PATH='-user:-core:-site'
 
128
 
 
129
Overriding the default site plugin directory::
 
130
 
 
131
  BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
 
132
 
 
133
BZR_DISABLE_PLUGINS
 
134
~~~~~~~~~~~~~~~~~~~
 
135
 
 
136
Under special circumstances (mostly when trying to diagnose a
 
137
bug), it's better to disable a plugin (or several) rather than
 
138
uninstalling them completely. Such plugins can be specified in
 
139
the ``BZR_DISABLE_PLUGINS`` environment variable.
 
140
 
 
141
In that case, ``bzr`` will stop loading the specified plugins and
 
142
will raise an import error if they are explicitly imported (by
 
143
another plugin that depends on them for example).
 
144
 
 
145
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
 
146
 
 
147
  BZR_DISABLE_PLUGINS='myplugin:yourplugin'
 
148
 
 
149
BZR_PLUGINS_AT
 
150
~~~~~~~~~~~~~~
 
151
 
 
152
When adding a new feature or working on a bug in a plugin,
 
153
developers often need to use a specific version of a given
 
154
plugin. Since python requires that the directory containing the
 
155
code is named like the plugin itself this make it impossible to
 
156
use arbitrary directory names (using a two-level directory scheme
 
157
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
 
158
if they don't appear in ``BZR_PLUGIN_PATH`` .
 
159
 
 
160
Plugins specified in this environment variable takes precedence
 
161
over the ones in ``BZR_PLUGIN_PATH``.
 
162
 
 
163
The variable specified a list of ``plugin_name@plugin path``,
 
164
``plugin_name`` being the name of the plugin as it appears in
 
165
python module paths, ``plugin_path`` being the path to the
 
166
directory containing the plugin code itself
 
167
(i.e. ``plugins/myplugin`` not ``plugins``).  Use ':' as the list
 
168
separator, use ';' on windows.
 
169
 
 
170
Example:
 
171
~~~~~~~~
 
172
 
 
173
Using a specific version of ``myplugin``:
 
174
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
120
175
 
121
176
BZRPATH
122
177
~~~~~~~
124
179
The path where Bazaar should look for shell plugin external commands.
125
180
 
126
181
 
 
182
http_proxy, https_proxy
 
183
~~~~~~~~~~~~~~~~~~~~~~~
 
184
 
 
185
Specifies the network proxy for outgoing connections, for example::
 
186
 
 
187
  http_proxy=http://proxy.example.com:3128/ 
 
188
  https_proxy=http://proxy.example.com:3128/
 
189
 
 
190
 
127
191
Configuration files
128
192
-------------------
129
193
 
130
194
Location
131
195
~~~~~~~~
132
196
 
133
 
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
 
197
Configuration files are located in ``$HOME/.bazaar`` on Unix and
134
198
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
135
199
Windows. (You can check the location for your system by using
136
200
``bzr version``.)
441
505
    using deprecated formats.
442
506
 
443
507
 
 
508
Unicode options
 
509
---------------
 
510
 
 
511
output_encoding
 
512
~~~~~~~~~~~~~~~
 
513
 
 
514
A Python unicode encoding name for text output from bzr, such as log
 
515
information.  Values include: utf8, cp850, ascii, iso-8859-1.  The default
 
516
is the terminal encoding prefered by the operating system.
 
517
 
 
518
 
444
519
Branch type specific options
445
520
----------------------------
446
521
 
453
528
~~~~~~~~~~~~~~~~~~~~~
454
529
 
455
530
If set to "True" then revisions can only be appended to the log, not
456
 
removed.  A branch with this setting enabled can only pull from
457
 
another branch if the other branch's log is a longer version of its
458
 
own.  This is normally set by ``bzr init --append-revisions-only``.
 
531
removed.  A branch with this setting enabled can only pull from another
 
532
branch if the other branch's log is a longer version of its own.  This is
 
533
normally set by ``bzr init --append-revisions-only``. If you set it
 
534
manually, use either 'True' or 'False' (case-sensitive) to maintain
 
535
compatibility with previous bzr versions (older than 2.2).
459
536
 
460
537
parent_location
461
538
~~~~~~~~~~~~~~~