/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: Jelmer Vernooij
  • Date: 2011-07-23 16:33:38 UTC
  • mto: This revision was merged to the branch mainline in revision 6045.
  • Revision ID: jelmer@samba.org-20110723163338-mjox55g52kt3u922
Add get_transport_from_url and get_transport_from_path functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
BZR_PROGRESS_BAR
20
20
~~~~~~~~~~~~~~~~
21
21
 
22
 
Override the progress display.  Possible values are "none", "dots", "tty"
 
22
Override the progress display.  Possible values are "none" or "text".  If
 
23
the value is "none" then no progress bar is displayed.  The value "text" draws
 
24
the ordinary command line progress bar.
23
25
 
24
26
BZR_SIGQUIT_PDB
25
27
~~~~~~~~~~~~~~~
59
61
 
60
62
Path to the editor Bazaar should use for commit messages, etc.
61
63
 
 
64
BZR_LOG
 
65
~~~~~~~
 
66
 
 
67
Location of the Bazaar log file. You can check the current location by
 
68
running ``bzr version``.
 
69
 
 
70
The log file contains debug information that is useful for diagnosing or
 
71
reporting problems with Bazaar.
 
72
 
 
73
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
 
74
will disable logging.
 
75
 
 
76
 
62
77
BZR_PLUGIN_PATH
63
78
~~~~~~~~~~~~~~~
64
79
 
77
92
 
78
93
As for the ``PATH`` variables, if multiple directories are
79
94
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
80
 
platform specific appropriate character (':' on Unix/Linux/etc,
 
95
platform specific appropriate character (':' on Unix,
81
96
';' on windows)
82
97
 
83
98
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
166
181
The path where Bazaar should look for shell plugin external commands.
167
182
 
168
183
 
 
184
http_proxy, https_proxy
 
185
~~~~~~~~~~~~~~~~~~~~~~~
 
186
 
 
187
Specifies the network proxy for outgoing connections, for example::
 
188
 
 
189
  http_proxy=http://proxy.example.com:3128/ 
 
190
  https_proxy=http://proxy.example.com:3128/
 
191
 
 
192
 
169
193
Configuration files
170
194
-------------------
171
195
 
172
196
Location
173
197
~~~~~~~~
174
198
 
175
 
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
 
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
176
200
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
177
201
Windows. (You can check the location for your system by using
178
202
``bzr version``.)
234
258
variable name, an equals sign and a value.  For example::
235
259
 
236
260
    email            = John Doe <jdoe@isp.com>
237
 
    check_signatures = require
 
261
    gpg_signing_key  = Amy Pond <amy@example.com>
 
262
 
 
263
A variable can reference other variables **in the same configuration file** by
 
264
enclosing them in curly brackets::
 
265
 
 
266
    my_branch_name = feature_x
 
267
    my_server      = bzr+ssh://example.com
 
268
    push_location   = {my_server}/project/{my_branch_name}
238
269
 
239
270
 
240
271
Variable policies
280
311
    [DEFAULT]
281
312
    email             = John Doe <jdoe@isp.com>
282
313
    editor            = /usr/bin/vim
283
 
    check_signatures  = check-available
284
314
    create_signatures = when-required
285
315
 
286
316
 
298
328
 
299
329
    [http://hypothetical.site.com/branches/devel-branch]
300
330
    create_signatures = always
301
 
    check_signatures  = always
302
 
 
303
 
    [http://bazaar-vcs.org/bzr/*]
304
 
    check_signatures  = require
305
331
 
306
332
The authentication configuration file, authentication.conf
307
333
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
355
381
check_signatures
356
382
~~~~~~~~~~~~~~~~
357
383
 
358
 
Defines the behavior for signatures.
 
384
Reserved for future use.  These options will allow a policy for branches to
 
385
require signatures.
359
386
 
360
387
require
361
388
    The gnupg signature for revisions must be present and must be valid.
371
398
create_signatures
372
399
~~~~~~~~~~~~~~~~~
373
400
 
374
 
Defines the behaviour of signing revisions.
 
401
Defines the behaviour of signing revisions on commits.  By default bzr will not
 
402
sign new commits.
375
403
 
376
404
always
377
 
    Sign every new revision that is committed.
 
405
    Sign every new revision that is committed.  If the signing fails then the
 
406
    commit will not be made.
378
407
 
379
408
when-required
380
 
    (default) Sign newly committed revisions only when the branch requires
381
 
    signed revisions.
 
409
    Reserved for future use.
382
410
 
383
411
never
384
 
    Refuse to sign newly committed revisions, even if the branch
385
 
    requires signatures.
 
412
    Reserved for future use.
 
413
 
 
414
In future it is planned that ``when-required`` will sign newly
 
415
committed revisions only when the branch requires them.  ``never`` will refuse
 
416
to sign newly committed revisions, even if the branch requires signatures.
 
417
 
 
418
gpg_signing_key
 
419
~~~~~~~~~~~
 
420
 
 
421
The GnuPG user identity to use when signing commits.  Can be an e-mail
 
422
address, key fingerprint or full key ID.  When unset or when set to
 
423
"default" Bazaar will use the user e-mail set with ``whoami``.
386
424
 
387
425
recurse
388
426
~~~~~~~
405
443
 
406
444
    gpg_signing_command = /usr/bin/gnpg
407
445
 
 
446
The specified command must accept the options "--clearsign" and "-u <email>".
 
447
 
408
448
bzr_remote_path
409
449
~~~~~~~~~~~~~~~
410
450
 
431
471
These settings are only needed if the SMTP server requires authentication
432
472
to send mail.
433
473
 
 
474
locks.steal_dead
 
475
~~~~~~~~~~~~~~~~
 
476
 
 
477
If set to true, bzr will automatically break locks held by processes from
 
478
the same machine and user that are no longer alive.  Otherwise, it will
 
479
print a message and you can break the lock manually, if you are satisfied
 
480
the object is no longer in use.
 
481
 
434
482
mail_client
435
483
~~~~~~~~~~~
436
484
 
482
530
    whether the format deprecation warning is shown on repositories that are
483
531
    using deprecated formats.
484
532
 
 
533
default_format
 
534
~~~~~~~~~~~~~~
 
535
 
 
536
A format name for the default format used when creating branches.  See ``bzr
 
537
help formats`` for possible values.
 
538
 
 
539
 
 
540
Unicode options
 
541
---------------
 
542
 
 
543
output_encoding
 
544
~~~~~~~~~~~~~~~
 
545
 
 
546
A Python unicode encoding name for text output from bzr, such as log
 
547
information.  Values include: utf8, cp850, ascii, iso-8859-1.  The default
 
548
is the terminal encoding prefered by the operating system.
 
549
 
485
550
 
486
551
Branch type specific options
487
552
----------------------------
504
569
parent_location
505
570
~~~~~~~~~~~~~~~
506
571
 
507
 
If present, the location of the default branch for pull or merge.
508
 
This option is normally set by ``pull --remember`` or ``merge
 
572
If present, the location of the default branch for pull or merge.  This option
 
573
is normally set when creating a branch, the first ``pull`` or by ``pull
509
574
--remember``.
510
575
 
511
576
push_location
512
577
~~~~~~~~~~~~~
513
578
 
514
579
If present, the location of the default branch for push.  This option
515
 
is normally set by ``push --remember``.
 
580
is normally set by the first ``push`` or ``push --remember``.
516
581
 
517
582
push_strict
518
583
~~~~~~~~~~~
545
610
If present, defines the ``--strict`` option default value for checking
546
611
uncommitted changes before sending a merge directive.
547
612
 
 
613
 
 
614
External Merge Tools
 
615
--------------------
 
616
 
 
617
bzr.mergetool.<name>
 
618
~~~~~~~~~~~~~~~~~~~~
 
619
 
 
620
Defines an external merge tool called <name> with the given command-line.
 
621
Arguments containing spaces should be quoted using single or double quotes. The
 
622
executable may omit its path if it can be found on the PATH.
 
623
 
 
624
The following markers can be used in the command-line to substitute filenames
 
625
involved in the merge conflict::
 
626
 
 
627
  {base}      file.BASE
 
628
  {this}      file.THIS
 
629
  {other}     file.OTHER
 
630
  {result}    output file
 
631
  {this_temp} temp copy of file.THIS, used to overwrite output file if merge
 
632
              succeeds.
 
633
 
 
634
For example::
 
635
 
 
636
  bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
 
637
 
 
638
bzr.default_mergetool
 
639
~~~~~~~~~~~~~~~~~~~~~
 
640
 
 
641
Specifies which external merge tool (as defined above) should be selected by
 
642
default in tools such as ``bzr qconflicts``.
 
643
 
 
644
For example::
 
645
 
 
646
  bzr.default_mergetool = kdiff3