← 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

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 02:16:42 UTC
  • mfrom: (5017.1.2 initialize)
  • Revision ID: pqm@pqm.ubuntu.com-20100211021642-eitum30b2e09oalf
(mbp) Add bzrlib.initialize

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
 
 
75
62
BZR_PLUGIN_PATH
76
63
~~~~~~~~~~~~~~~
77
64
 
90
77
 
91
78
As for the ``PATH`` variables, if multiple directories are
92
79
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
93
 
platform specific appropriate character (':' on Unix,
 
80
platform specific appropriate character (':' on Unix/Linux/etc,
94
81
';' on windows)
95
82
 
96
83
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
111
98
used literally, they will be substituted by the corresponding,
112
99
platform specific, values.
113
100
 
114
 
The examples below use ':' as the separator, windows users
 
101
Examples:
 
102
^^^^^^^^^
 
103
 
 
104
The examples below uses ':' as the separator, windows users
115
105
should use ';'.
116
106
 
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``
 
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
 
175
120
 
176
121
BZRPATH
177
122
~~~~~~~
179
124
The path where Bazaar should look for shell plugin external commands.
180
125
 
181
126
 
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
 
 
191
127
Configuration files
192
128
-------------------
193
129
 
194
130
Location
195
131
~~~~~~~~
196
132
 
197
 
Configuration files are located in ``$HOME/.bazaar`` on Unix and
 
133
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
198
134
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
199
135
Windows. (You can check the location for your system by using
200
136
``bzr version``.)
505
441
    using deprecated formats.
506
442
 
507
443
 
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
 
 
519
444
Branch type specific options
520
445
----------------------------
521
446
 
528
453
~~~~~~~~~~~~~~~~~~~~~
529
454
 
530
455
If set to "True" then revisions can only be appended to the log, not
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).
 
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``.
536
459
 
537
460
parent_location
538
461
~~~~~~~~~~~~~~~