← 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
~~~~~~~~~~
256
258
variable name, an equals sign and a value.  For example::
257
259
 
258
260
    email            = John Doe <jdoe@isp.com>
259
 
    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}
260
269
 
261
270
 
262
271
Variable policies
302
311
    [DEFAULT]
303
312
    email             = John Doe <jdoe@isp.com>
304
313
    editor            = /usr/bin/vim
305
 
    check_signatures  = check-available
306
314
    create_signatures = when-required
307
315
 
308
316
 
320
328
 
321
329
    [http://hypothetical.site.com/branches/devel-branch]
322
330
    create_signatures = always
323
 
    check_signatures  = always
324
 
 
325
 
    [http://bazaar-vcs.org/bzr/*]
326
 
    check_signatures  = require
327
331
 
328
332
The authentication configuration file, authentication.conf
329
333
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
351
355
 
352
356
    debug_flags = hpss
353
357
 
 
358
or::
 
359
 
 
360
    debug_flags = hpss,evil
 
361
 
354
362
email
355
363
~~~~~
356
364
 
377
385
check_signatures
378
386
~~~~~~~~~~~~~~~~
379
387
 
380
 
Defines the behavior for signatures.
 
388
Reserved for future use.  These options will allow a policy for branches to
 
389
require signatures.
381
390
 
382
391
require
383
392
    The gnupg signature for revisions must be present and must be valid.
393
402
create_signatures
394
403
~~~~~~~~~~~~~~~~~
395
404
 
396
 
Defines the behaviour of signing revisions.
 
405
Defines the behaviour of signing revisions on commits.  By default bzr will not
 
406
sign new commits.
397
407
 
398
408
always
399
 
    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.
400
411
 
401
412
when-required
402
 
    (default) Sign newly committed revisions only when the branch requires
403
 
    signed revisions.
 
413
    Reserved for future use.
404
414
 
405
415
never
406
 
    Refuse to sign newly committed revisions, even if the branch
407
 
    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``.
408
435
 
409
436
recurse
410
437
~~~~~~~
427
454
 
428
455
    gpg_signing_command = /usr/bin/gnpg
429
456
 
 
457
The specified command must accept the options "--clearsign" and "-u <email>".
 
458
 
430
459
bzr_remote_path
431
460
~~~~~~~~~~~~~~~
432
461
 
453
482
These settings are only needed if the SMTP server requires authentication
454
483
to send mail.
455
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
 
456
493
mail_client
457
494
~~~~~~~~~~~
458
495
 
479
516
:mapi: Use your preferred e-mail client on Windows.
480
517
:xdg-email: Use xdg-email to run your preferred mail program
481
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
 
482
526
submit_branch
483
527
~~~~~~~~~~~~~
484
528
 
504
548
    whether the format deprecation warning is shown on repositories that are
505
549
    using deprecated formats.
506
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
 
507
557
 
508
558
Unicode options
509
559
---------------
537
587
parent_location
538
588
~~~~~~~~~~~~~~~
539
589
 
540
 
If present, the location of the default branch for pull or merge.
541
 
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
542
592
--remember``.
543
593
 
544
594
push_location
545
595
~~~~~~~~~~~~~
546
596
 
547
597
If present, the location of the default branch for push.  This option
548
 
is normally set by ``push --remember``.
 
598
is normally set by the first ``push`` or ``push --remember``.
549
599
 
550
600
push_strict
551
601
~~~~~~~~~~~
578
628
If present, defines the ``--strict`` option default value for checking
579
629
uncommitted changes before sending a merge directive.
580
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