/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-08-15 12:37:25 UTC
  • mto: (5268.8.2 switch-colocated)
  • mto: This revision was merged to the branch mainline in revision 6079.
  • Revision ID: jelmer@samba.org-20110815123725-lbhuwfc67cs23ef0
Fix URL for transport tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
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
dirstate.fdatasync
 
419
~~~~~~~~~~~~~~~~~~
 
420
 
 
421
If true (default), working tree metadata changes are flushed through the
 
422
OS buffers to physical disk.  This is somewhat slower, but means data
 
423
should not be lost if the machine crashes.  See also repository.fdatasync.
 
424
 
 
425
gpg_signing_key
 
426
~~~~~~~~~~~
 
427
 
 
428
The GnuPG user identity to use when signing commits.  Can be an e-mail
 
429
address, key fingerprint or full key ID.  When unset or when set to
 
430
"default" Bazaar will use the user e-mail set with ``whoami``.
386
431
 
387
432
recurse
388
433
~~~~~~~
405
450
 
406
451
    gpg_signing_command = /usr/bin/gnpg
407
452
 
 
453
The specified command must accept the options "--clearsign" and "-u <email>".
 
454
 
408
455
bzr_remote_path
409
456
~~~~~~~~~~~~~~~
410
457
 
431
478
These settings are only needed if the SMTP server requires authentication
432
479
to send mail.
433
480
 
 
481
locks.steal_dead
 
482
~~~~~~~~~~~~~~~~
 
483
 
 
484
If set to true, bzr will automatically break locks held by processes from
 
485
the same machine and user that are no longer alive.  Otherwise, it will
 
486
print a message and you can break the lock manually, if you are satisfied
 
487
the object is no longer in use.
 
488
 
434
489
mail_client
435
490
~~~~~~~~~~~
436
491
 
457
512
:mapi: Use your preferred e-mail client on Windows.
458
513
:xdg-email: Use xdg-email to run your preferred mail program
459
514
 
 
515
repository.fdatasync
 
516
~~~~~~~~~~~~~~~~~~~~
 
517
 
 
518
If true (default), repository changes are flushed through the OS buffers
 
519
to physical disk.  This is somewhat slower, but means data should not be
 
520
lost if the machine crashes.  See also dirstate.fdatasync.
 
521
 
460
522
submit_branch
461
523
~~~~~~~~~~~~~
462
524
 
482
544
    whether the format deprecation warning is shown on repositories that are
483
545
    using deprecated formats.
484
546
 
 
547
default_format
 
548
~~~~~~~~~~~~~~
 
549
 
 
550
A format name for the default format used when creating branches.  See ``bzr
 
551
help formats`` for possible values.
 
552
 
 
553
 
 
554
Unicode options
 
555
---------------
 
556
 
 
557
output_encoding
 
558
~~~~~~~~~~~~~~~
 
559
 
 
560
A Python unicode encoding name for text output from bzr, such as log
 
561
information.  Values include: utf8, cp850, ascii, iso-8859-1.  The default
 
562
is the terminal encoding prefered by the operating system.
 
563
 
485
564
 
486
565
Branch type specific options
487
566
----------------------------
504
583
parent_location
505
584
~~~~~~~~~~~~~~~
506
585
 
507
 
If present, the location of the default branch for pull or merge.
508
 
This option is normally set by ``pull --remember`` or ``merge
 
586
If present, the location of the default branch for pull or merge.  This option
 
587
is normally set when creating a branch, the first ``pull`` or by ``pull
509
588
--remember``.
510
589
 
511
590
push_location
512
591
~~~~~~~~~~~~~
513
592
 
514
593
If present, the location of the default branch for push.  This option
515
 
is normally set by ``push --remember``.
 
594
is normally set by the first ``push`` or ``push --remember``.
516
595
 
517
596
push_strict
518
597
~~~~~~~~~~~
545
624
If present, defines the ``--strict`` option default value for checking
546
625
uncommitted changes before sending a merge directive.
547
626
 
 
627
 
 
628
External Merge Tools
 
629
--------------------
 
630
 
 
631
bzr.mergetool.<name>
 
632
~~~~~~~~~~~~~~~~~~~~
 
633
 
 
634
Defines an external merge tool called <name> with the given command-line.
 
635
Arguments containing spaces should be quoted using single or double quotes. The
 
636
executable may omit its path if it can be found on the PATH.
 
637
 
 
638
The following markers can be used in the command-line to substitute filenames
 
639
involved in the merge conflict::
 
640
 
 
641
  {base}      file.BASE
 
642
  {this}      file.THIS
 
643
  {other}     file.OTHER
 
644
  {result}    output file
 
645
  {this_temp} temp copy of file.THIS, used to overwrite output file if merge
 
646
              succeeds.
 
647
 
 
648
For example::
 
649
 
 
650
  bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
 
651
 
 
652
bzr.default_mergetool
 
653
~~~~~~~~~~~~~~~~~~~~~
 
654
 
 
655
Specifies which external merge tool (as defined above) should be selected by
 
656
default in tools such as ``bzr qconflicts``.
 
657
 
 
658
For example::
 
659
 
 
660
  bzr.default_mergetool = kdiff3