← 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

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

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 value.
 
17
See also the ``email`` configuration option.
18
18
 
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
~~~~~~~~~~~~~~~
52
54
 
53
55
Path to the Bazaar executable to use when using the bzr+ssh protocol.
54
56
 
55
 
See also the ``bzr_remote_path`` configuration value.
 
57
See also the ``bzr_remote_path`` configuration option.
56
58
 
57
59
BZR_EDITOR
58
60
~~~~~~~~~~
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
329
355
 
330
356
    debug_flags = hpss
331
357
 
 
358
or::
 
359
 
 
360
    debug_flags = hpss,evil
 
361
 
332
362
email
333
363
~~~~~
334
364
 
355
385
check_signatures
356
386
~~~~~~~~~~~~~~~~
357
387
 
358
 
Defines the behavior for signatures.
 
388
Reserved for future use.  These options will allow a policy for branches to
 
389
require signatures.
359
390
 
360
391
require
361
392
    The gnupg signature for revisions must be present and must be valid.
371
402
create_signatures
372
403
~~~~~~~~~~~~~~~~~
373
404
 
374
 
Defines the behaviour of signing revisions.
 
405
Defines the behaviour of signing revisions on commits.  By default bzr will not
 
406
sign new commits.
375
407
 
376
408
always
377
 
    Sign every new revision that is committed.
 
409
    Sign every new revision that is committed.  If the signing fails then the
 
410
    commit will not be made.
378
411
 
379
412
when-required
380
 
    (default) Sign newly committed revisions only when the branch requires
381
 
    signed revisions.
 
413
    Reserved for future use.
382
414
 
383
415
never
384
 
    Refuse to sign newly committed revisions, even if the branch
385
 
    requires signatures.
 
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``.
386
435
 
387
436
recurse
388
437
~~~~~~~
405
454
 
406
455
    gpg_signing_command = /usr/bin/gnpg
407
456
 
 
457
The specified command must accept the options "--clearsign" and "-u <email>".
 
458
 
408
459
bzr_remote_path
409
460
~~~~~~~~~~~~~~~
410
461
 
431
482
These settings are only needed if the SMTP server requires authentication
432
483
to send mail.
433
484
 
 
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
 
434
493
mail_client
435
494
~~~~~~~~~~~
436
495
 
457
516
:mapi: Use your preferred e-mail client on Windows.
458
517
:xdg-email: Use xdg-email to run your preferred mail program
459
518
 
 
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
 
460
526
submit_branch
461
527
~~~~~~~~~~~~~
462
528
 
482
548
    whether the format deprecation warning is shown on repositories that are
483
549
    using deprecated formats.
484
550
 
 
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
 
485
568
 
486
569
Branch type specific options
487
570
----------------------------
504
587
parent_location
505
588
~~~~~~~~~~~~~~~
506
589
 
507
 
If present, the location of the default branch for pull or merge.
508
 
This option is normally set by ``pull --remember`` or ``merge
 
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
509
592
--remember``.
510
593
 
511
594
push_location
512
595
~~~~~~~~~~~~~
513
596
 
514
597
If present, the location of the default branch for push.  This option
515
 
is normally set by ``push --remember``.
 
598
is normally set by the first ``push`` or ``push --remember``.
516
599
 
517
600
push_strict
518
601
~~~~~~~~~~~
545
628
If present, defines the ``--strict`` option default value for checking
546
629
uncommitted changes before sending a merge directive.
547
630
 
 
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