← 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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
14
14
 
15
15
  "John Doe <jdoe@example.com>"
16
16
 
17
 
See also the ``email`` configuration option.
 
17
See also the ``email`` configuration value.
18
18
 
19
19
BZR_PROGRESS_BAR
20
20
~~~~~~~~~~~~~~~~
21
21
 
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.
 
22
Override the progress display.  Possible values are "none", "dots", "tty"
25
23
 
26
24
BZR_SIGQUIT_PDB
27
25
~~~~~~~~~~~~~~~
54
52
 
55
53
Path to the Bazaar executable to use when using the bzr+ssh protocol.
56
54
 
57
 
See also the ``bzr_remote_path`` configuration option.
 
55
See also the ``bzr_remote_path`` configuration value.
58
56
 
59
57
BZR_EDITOR
60
58
~~~~~~~~~~
61
59
 
62
60
Path to the editor Bazaar should use for commit messages, etc.
63
61
 
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
 
 
77
62
BZR_PLUGIN_PATH
78
63
~~~~~~~~~~~~~~~
79
64
 
92
77
 
93
78
As for the ``PATH`` variables, if multiple directories are
94
79
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
95
 
platform specific appropriate character (':' on Unix,
 
80
platform specific appropriate character (':' on Unix/Linux/etc,
96
81
';' on windows)
97
82
 
98
83
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
181
166
The path where Bazaar should look for shell plugin external commands.
182
167
 
183
168
 
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
 
 
193
169
Configuration files
194
170
-------------------
195
171
 
196
172
Location
197
173
~~~~~~~~
198
174
 
199
 
Configuration files are located in ``$HOME/.bazaar`` on Unix and
 
175
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
200
176
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
201
177
Windows. (You can check the location for your system by using
202
178
``bzr version``.)
258
234
variable name, an equals sign and a value.  For example::
259
235
 
260
236
    email            = John Doe <jdoe@isp.com>
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}
 
237
    check_signatures = require
269
238
 
270
239
 
271
240
Variable policies
311
280
    [DEFAULT]
312
281
    email             = John Doe <jdoe@isp.com>
313
282
    editor            = /usr/bin/vim
 
283
    check_signatures  = check-available
314
284
    create_signatures = when-required
315
285
 
316
286
 
328
298
 
329
299
    [http://hypothetical.site.com/branches/devel-branch]
330
300
    create_signatures = always
 
301
    check_signatures  = always
 
302
 
 
303
    [http://bazaar-vcs.org/bzr/*]
 
304
    check_signatures  = require
331
305
 
332
306
The authentication configuration file, authentication.conf
333
307
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
355
329
 
356
330
    debug_flags = hpss
357
331
 
358
 
or::
359
 
 
360
 
    debug_flags = hpss,evil
361
 
 
362
332
email
363
333
~~~~~
364
334
 
385
355
check_signatures
386
356
~~~~~~~~~~~~~~~~
387
357
 
388
 
Reserved for future use.  These options will allow a policy for branches to
389
 
require signatures.
 
358
Defines the behavior for signatures.
390
359
 
391
360
require
392
361
    The gnupg signature for revisions must be present and must be valid.
402
371
create_signatures
403
372
~~~~~~~~~~~~~~~~~
404
373
 
405
 
Defines the behaviour of signing revisions on commits.  By default bzr will not
406
 
sign new commits.
 
374
Defines the behaviour of signing revisions.
407
375
 
408
376
always
409
 
    Sign every new revision that is committed.  If the signing fails then the
410
 
    commit will not be made.
 
377
    Sign every new revision that is committed.
411
378
 
412
379
when-required
413
 
    Reserved for future use.
 
380
    (default) Sign newly committed revisions only when the branch requires
 
381
    signed revisions.
414
382
 
415
383
never
416
 
    Reserved for future use.
417
 
 
418
 
In future it is planned that ``when-required`` will sign newly
419
 
committed revisions only when the branch requires them.  ``never`` will refuse
420
 
to sign newly committed revisions, even if the branch requires signatures.
421
 
 
422
 
dirstate.fdatasync
423
 
~~~~~~~~~~~~~~~~~~
424
 
 
425
 
If true (default), working tree metadata changes are flushed through the
426
 
OS buffers to physical disk.  This is somewhat slower, but means data
427
 
should not be lost if the machine crashes.  See also repository.fdatasync.
428
 
 
429
 
gpg_signing_key
430
 
~~~~~~~~~~~~~~~
431
 
 
432
 
The GnuPG user identity to use when signing commits.  Can be an e-mail
433
 
address, key fingerprint or full key ID.  When unset or when set to
434
 
"default" Bazaar will use the user e-mail set with ``whoami``.
 
384
    Refuse to sign newly committed revisions, even if the branch
 
385
    requires signatures.
435
386
 
436
387
recurse
437
388
~~~~~~~
454
405
 
455
406
    gpg_signing_command = /usr/bin/gnpg
456
407
 
457
 
The specified command must accept the options "--clearsign" and "-u <email>".
458
 
 
459
408
bzr_remote_path
460
409
~~~~~~~~~~~~~~~
461
410
 
482
431
These settings are only needed if the SMTP server requires authentication
483
432
to send mail.
484
433
 
485
 
locks.steal_dead
486
 
~~~~~~~~~~~~~~~~
487
 
 
488
 
If set to true, bzr will automatically break locks held by processes from
489
 
the same machine and user that are no longer alive.  Otherwise, it will
490
 
print a message and you can break the lock manually, if you are satisfied
491
 
the object is no longer in use.
492
 
 
493
434
mail_client
494
435
~~~~~~~~~~~
495
436
 
516
457
:mapi: Use your preferred e-mail client on Windows.
517
458
:xdg-email: Use xdg-email to run your preferred mail program
518
459
 
519
 
repository.fdatasync
520
 
~~~~~~~~~~~~~~~~~~~~
521
 
 
522
 
If true (default), repository changes are flushed through the OS buffers
523
 
to physical disk.  This is somewhat slower, but means data should not be
524
 
lost if the machine crashes.  See also dirstate.fdatasync.
525
 
 
526
460
submit_branch
527
461
~~~~~~~~~~~~~
528
462
 
548
482
    whether the format deprecation warning is shown on repositories that are
549
483
    using deprecated formats.
550
484
 
551
 
default_format
552
 
~~~~~~~~~~~~~~
553
 
 
554
 
A format name for the default format used when creating branches.  See ``bzr
555
 
help formats`` for possible values.
556
 
 
557
 
 
558
 
Unicode options
559
 
---------------
560
 
 
561
 
output_encoding
562
 
~~~~~~~~~~~~~~~
563
 
 
564
 
A Python unicode encoding name for text output from bzr, such as log
565
 
information.  Values include: utf8, cp850, ascii, iso-8859-1.  The default
566
 
is the terminal encoding prefered by the operating system.
567
 
 
568
485
 
569
486
Branch type specific options
570
487
----------------------------
587
504
parent_location
588
505
~~~~~~~~~~~~~~~
589
506
 
590
 
If present, the location of the default branch for pull or merge.  This option
591
 
is normally set when creating a branch, the first ``pull`` or by ``pull
 
507
If present, the location of the default branch for pull or merge.
 
508
This option is normally set by ``pull --remember`` or ``merge
592
509
--remember``.
593
510
 
594
511
push_location
595
512
~~~~~~~~~~~~~
596
513
 
597
514
If present, the location of the default branch for push.  This option
598
 
is normally set by the first ``push`` or ``push --remember``.
 
515
is normally set by ``push --remember``.
599
516
 
600
517
push_strict
601
518
~~~~~~~~~~~
628
545
If present, defines the ``--strict`` option default value for checking
629
546
uncommitted changes before sending a merge directive.
630
547
 
631
 
add.maximum_file_size
632
 
~~~~~~~~~~~~~~~~~~~~~
633
 
 
634
 
Defines the maximum file size the command line "add" operation will allow
635
 
in recursive mode, with files larger than this value being skipped. You may 
636
 
specify this value as an integer (in which case it is interpreted as bytes), 
637
 
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0 
638
 
will disable skipping.
639
 
 
640
 
External Merge Tools
641
 
--------------------
642
 
 
643
 
bzr.mergetool.<name>
644
 
~~~~~~~~~~~~~~~~~~~~
645
 
 
646
 
Defines an external merge tool called <name> with the given command-line.
647
 
Arguments containing spaces should be quoted using single or double quotes. The
648
 
executable may omit its path if it can be found on the PATH.
649
 
 
650
 
The following markers can be used in the command-line to substitute filenames
651
 
involved in the merge conflict::
652
 
 
653
 
  {base}      file.BASE
654
 
  {this}      file.THIS
655
 
  {other}     file.OTHER
656
 
  {result}    output file
657
 
  {this_temp} temp copy of file.THIS, used to overwrite output file if merge
658
 
              succeeds.
659
 
 
660
 
For example::
661
 
 
662
 
  bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
663
 
 
664
 
bzr.default_mergetool
665
 
~~~~~~~~~~~~~~~~~~~~~
666
 
 
667
 
Specifies which external merge tool (as defined above) should be selected by
668
 
default in tools such as ``bzr qconflicts``.
669
 
 
670
 
For example::
671
 
 
672
 
  bzr.default_mergetool = kdiff3