Mercurial > hg
comparison mercurial/help/config.txt @ 16140:dbf64594a3c3
help: sort hgrc related "Sections" chapters alphabetically
author | Michal Sznajder <michalsznajder@gmail.com> |
---|---|
date | Sat, 18 Feb 2012 14:27:57 +0100 |
parents | 461a59e2765a |
children | 6097ede2be4d |
comparison
equal
deleted
inserted
replaced
16139:461a59e2765a | 16140:dbf64594a3c3 |
---|---|
487 mq = | 487 mq = |
488 # (this extension will get loaded from the file specified) | 488 # (this extension will get loaded from the file specified) |
489 myfeature = ~/.hgext/myfeature.py | 489 myfeature = ~/.hgext/myfeature.py |
490 | 490 |
491 | 491 |
492 ``hostfingerprints`` | |
493 """""""""""""""""""" | |
494 | |
495 Fingerprints of the certificates of known HTTPS servers. | |
496 A HTTPS connection to a server with a fingerprint configured here will | |
497 only succeed if the servers certificate matches the fingerprint. | |
498 This is very similar to how ssh known hosts works. | |
499 The fingerprint is the SHA-1 hash value of the DER encoded certificate. | |
500 The CA chain and web.cacerts is not used for servers with a fingerprint. | |
501 | |
502 For example:: | |
503 | |
504 [hostfingerprints] | |
505 hg.intevation.org = 38:76:52:7c:87:26:9a:8f:4a:f8:d3:de:08:45:3b:ea:d6:4b:ee:cc | |
506 | |
507 This feature is only supported when using Python 2.6 or later. | |
508 | |
509 | |
510 ``format`` | 492 ``format`` |
511 """""""""" | 493 """""""""" |
512 | 494 |
513 ``usestore`` | 495 ``usestore`` |
514 Enable or disable the "store" repository format which improves | 496 Enable or disable the "store" repository format which improves |
559 ``width`` | 541 ``width`` |
560 Set branch edges width in pixels. | 542 Set branch edges width in pixels. |
561 | 543 |
562 ``color`` | 544 ``color`` |
563 Set branch edges color in hexadecimal RGB notation. | 545 Set branch edges color in hexadecimal RGB notation. |
564 | |
565 ``merge-patterns`` | |
566 """""""""""""""""" | |
567 | |
568 This section specifies merge tools to associate with particular file | |
569 patterns. Tools matched here will take precedence over the default | |
570 merge tool. Patterns are globs by default, rooted at the repository | |
571 root. | |
572 | |
573 Example:: | |
574 | |
575 [merge-patterns] | |
576 **.c = kdiff3 | |
577 **.jpg = myimgmerge | |
578 | |
579 ``merge-tools`` | |
580 """"""""""""""" | |
581 | |
582 This section configures external merge tools to use for file-level | |
583 merges. | |
584 | |
585 Example ``~/.hgrc``:: | |
586 | |
587 [merge-tools] | |
588 # Override stock tool location | |
589 kdiff3.executable = ~/bin/kdiff3 | |
590 # Specify command line | |
591 kdiff3.args = $base $local $other -o $output | |
592 # Give higher priority | |
593 kdiff3.priority = 1 | |
594 | |
595 # Define new tool | |
596 myHtmlTool.args = -m $local $other $base $output | |
597 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge | |
598 myHtmlTool.priority = 1 | |
599 | |
600 Supported arguments: | |
601 | |
602 ``priority`` | |
603 The priority in which to evaluate this tool. | |
604 Default: 0. | |
605 | |
606 ``executable`` | |
607 Either just the name of the executable or its pathname. On Windows, | |
608 the path can use environment variables with ${ProgramFiles} syntax. | |
609 Default: the tool name. | |
610 | |
611 ``args`` | |
612 The arguments to pass to the tool executable. You can refer to the | |
613 files being merged as well as the output file through these | |
614 variables: ``$base``, ``$local``, ``$other``, ``$output``. | |
615 Default: ``$local $base $other`` | |
616 | |
617 ``premerge`` | |
618 Attempt to run internal non-interactive 3-way merge tool before | |
619 launching external tool. Options are ``true``, ``false``, or ``keep`` | |
620 to leave markers in the file if the premerge fails. | |
621 Default: True | |
622 | |
623 ``binary`` | |
624 This tool can merge binary files. Defaults to False, unless tool | |
625 was selected by file pattern match. | |
626 | |
627 ``symlink`` | |
628 This tool can merge symlinks. Defaults to False, even if tool was | |
629 selected by file pattern match. | |
630 | |
631 ``check`` | |
632 A list of merge success-checking options: | |
633 | |
634 ``changed`` | |
635 Ask whether merge was successful when the merged file shows no changes. | |
636 ``conflicts`` | |
637 Check whether there are conflicts even though the tool reported success. | |
638 ``prompt`` | |
639 Always prompt for merge success, regardless of success reported by tool. | |
640 | |
641 ``checkchanged`` | |
642 True is equivalent to ``check = changed``. | |
643 Default: False | |
644 | |
645 ``checkconflicts`` | |
646 True is equivalent to ``check = conflicts``. | |
647 Default: False | |
648 | |
649 ``fixeol`` | |
650 Attempt to fix up EOL changes caused by the merge tool. | |
651 Default: False | |
652 | |
653 ``gui`` | |
654 This tool requires a graphical interface to run. Default: False | |
655 | |
656 ``regkey`` | |
657 Windows registry key which describes install location of this | |
658 tool. Mercurial will search for this key first under | |
659 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. | |
660 Default: None | |
661 | |
662 ``regkeyalt`` | |
663 An alternate Windows registry key to try if the first key is not | |
664 found. The alternate key uses the same ``regname`` and ``regappend`` | |
665 semantics of the primary key. The most common use for this key | |
666 is to search for 32bit applications on 64bit operating systems. | |
667 Default: None | |
668 | |
669 ``regname`` | |
670 Name of value to read from specified registry key. Defaults to the | |
671 unnamed (default) value. | |
672 | |
673 ``regappend`` | |
674 String to append to the value read from the registry, typically | |
675 the executable name of the tool. | |
676 Default: None | |
677 | |
678 | 546 |
679 ``hooks`` | 547 ``hooks`` |
680 """"""""" | 548 """"""""" |
681 | 549 |
682 Commands or Python functions that get automatically executed by | 550 Commands or Python functions that get automatically executed by |
853 | 721 |
854 If a Python hook returns a "true" value or raises an exception, this | 722 If a Python hook returns a "true" value or raises an exception, this |
855 is treated as a failure. | 723 is treated as a failure. |
856 | 724 |
857 | 725 |
726 ``hostfingerprints`` | |
727 """""""""""""""""""" | |
728 | |
729 Fingerprints of the certificates of known HTTPS servers. | |
730 A HTTPS connection to a server with a fingerprint configured here will | |
731 only succeed if the servers certificate matches the fingerprint. | |
732 This is very similar to how ssh known hosts works. | |
733 The fingerprint is the SHA-1 hash value of the DER encoded certificate. | |
734 The CA chain and web.cacerts is not used for servers with a fingerprint. | |
735 | |
736 For example:: | |
737 | |
738 [hostfingerprints] | |
739 hg.intevation.org = 38:76:52:7c:87:26:9a:8f:4a:f8:d3:de:08:45:3b:ea:d6:4b:ee:cc | |
740 | |
741 This feature is only supported when using Python 2.6 or later. | |
742 | |
743 | |
858 ``http_proxy`` | 744 ``http_proxy`` |
859 """""""""""""" | 745 """""""""""""" |
860 | 746 |
861 Used to access web-based Mercurial repositories through a HTTP | 747 Used to access web-based Mercurial repositories through a HTTP |
862 proxy. | 748 proxy. |
877 | 763 |
878 ``always`` | 764 ``always`` |
879 Optional. Always use the proxy, even for localhost and any entries | 765 Optional. Always use the proxy, even for localhost and any entries |
880 in ``http_proxy.no``. True or False. Default: False. | 766 in ``http_proxy.no``. True or False. Default: False. |
881 | 767 |
882 ``smtp`` | 768 ``merge-patterns`` |
883 """""""" | 769 """""""""""""""""" |
884 | 770 |
885 Configuration for extensions that need to send email messages. | 771 This section specifies merge tools to associate with particular file |
886 | 772 patterns. Tools matched here will take precedence over the default |
887 ``host`` | 773 merge tool. Patterns are globs by default, rooted at the repository |
888 Host name of mail server, e.g. "mail.example.com". | 774 root. |
889 | 775 |
890 ``port`` | 776 Example:: |
891 Optional. Port to connect to on mail server. Default: 25. | 777 |
892 | 778 [merge-patterns] |
893 ``tls`` | 779 **.c = kdiff3 |
894 Optional. Method to enable TLS when connecting to mail server: starttls, | 780 **.jpg = myimgmerge |
895 smtps or none. Default: none. | 781 |
896 | 782 ``merge-tools`` |
897 ``username`` | 783 """"""""""""""" |
898 Optional. User name for authenticating with the SMTP server. | 784 |
899 Default: none. | 785 This section configures external merge tools to use for file-level |
900 | 786 merges. |
901 ``password`` | 787 |
902 Optional. Password for authenticating with the SMTP server. If not | 788 Example ``~/.hgrc``:: |
903 specified, interactive sessions will prompt the user for a | 789 |
904 password; non-interactive sessions will fail. Default: none. | 790 [merge-tools] |
905 | 791 # Override stock tool location |
906 ``local_hostname`` | 792 kdiff3.executable = ~/bin/kdiff3 |
907 Optional. It's the hostname that the sender can use to identify | 793 # Specify command line |
908 itself to the MTA. | 794 kdiff3.args = $base $local $other -o $output |
795 # Give higher priority | |
796 kdiff3.priority = 1 | |
797 | |
798 # Define new tool | |
799 myHtmlTool.args = -m $local $other $base $output | |
800 myHtmlTool.regkey = Software\FooSoftware\HtmlMerge | |
801 myHtmlTool.priority = 1 | |
802 | |
803 Supported arguments: | |
804 | |
805 ``priority`` | |
806 The priority in which to evaluate this tool. | |
807 Default: 0. | |
808 | |
809 ``executable`` | |
810 Either just the name of the executable or its pathname. On Windows, | |
811 the path can use environment variables with ${ProgramFiles} syntax. | |
812 Default: the tool name. | |
813 | |
814 ``args`` | |
815 The arguments to pass to the tool executable. You can refer to the | |
816 files being merged as well as the output file through these | |
817 variables: ``$base``, ``$local``, ``$other``, ``$output``. | |
818 Default: ``$local $base $other`` | |
819 | |
820 ``premerge`` | |
821 Attempt to run internal non-interactive 3-way merge tool before | |
822 launching external tool. Options are ``true``, ``false``, or ``keep`` | |
823 to leave markers in the file if the premerge fails. | |
824 Default: True | |
825 | |
826 ``binary`` | |
827 This tool can merge binary files. Defaults to False, unless tool | |
828 was selected by file pattern match. | |
829 | |
830 ``symlink`` | |
831 This tool can merge symlinks. Defaults to False, even if tool was | |
832 selected by file pattern match. | |
833 | |
834 ``check`` | |
835 A list of merge success-checking options: | |
836 | |
837 ``changed`` | |
838 Ask whether merge was successful when the merged file shows no changes. | |
839 ``conflicts`` | |
840 Check whether there are conflicts even though the tool reported success. | |
841 ``prompt`` | |
842 Always prompt for merge success, regardless of success reported by tool. | |
843 | |
844 ``checkchanged`` | |
845 True is equivalent to ``check = changed``. | |
846 Default: False | |
847 | |
848 ``checkconflicts`` | |
849 True is equivalent to ``check = conflicts``. | |
850 Default: False | |
851 | |
852 ``fixeol`` | |
853 Attempt to fix up EOL changes caused by the merge tool. | |
854 Default: False | |
855 | |
856 ``gui`` | |
857 This tool requires a graphical interface to run. Default: False | |
858 | |
859 ``regkey`` | |
860 Windows registry key which describes install location of this | |
861 tool. Mercurial will search for this key first under | |
862 ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``. | |
863 Default: None | |
864 | |
865 ``regkeyalt`` | |
866 An alternate Windows registry key to try if the first key is not | |
867 found. The alternate key uses the same ``regname`` and ``regappend`` | |
868 semantics of the primary key. The most common use for this key | |
869 is to search for 32bit applications on 64bit operating systems. | |
870 Default: None | |
871 | |
872 ``regname`` | |
873 Name of value to read from specified registry key. Defaults to the | |
874 unnamed (default) value. | |
875 | |
876 ``regappend`` | |
877 String to append to the value read from the registry, typically | |
878 the executable name of the tool. | |
879 Default: None | |
909 | 880 |
910 | 881 |
911 ``patch`` | 882 ``patch`` |
912 """"""""" | 883 """"""""" |
913 | 884 |
1010 | 981 |
1011 ``validate`` | 982 ``validate`` |
1012 Whether to validate the completeness of pushed changesets by | 983 Whether to validate the completeness of pushed changesets by |
1013 checking that all new file revisions specified in manifests are | 984 checking that all new file revisions specified in manifests are |
1014 present. Default is False. | 985 present. Default is False. |
986 | |
987 ``smtp`` | |
988 """""""" | |
989 | |
990 Configuration for extensions that need to send email messages. | |
991 | |
992 ``host`` | |
993 Host name of mail server, e.g. "mail.example.com". | |
994 | |
995 ``port`` | |
996 Optional. Port to connect to on mail server. Default: 25. | |
997 | |
998 ``tls`` | |
999 Optional. Method to enable TLS when connecting to mail server: starttls, | |
1000 smtps or none. Default: none. | |
1001 | |
1002 ``username`` | |
1003 Optional. User name for authenticating with the SMTP server. | |
1004 Default: none. | |
1005 | |
1006 ``password`` | |
1007 Optional. Password for authenticating with the SMTP server. If not | |
1008 specified, interactive sessions will prompt the user for a | |
1009 password; non-interactive sessions will fail. Default: none. | |
1010 | |
1011 ``local_hostname`` | |
1012 Optional. It's the hostname that the sender can use to identify | |
1013 itself to the MTA. | |
1014 | |
1015 | 1015 |
1016 ``subpaths`` | 1016 ``subpaths`` |
1017 """""""""""" | 1017 """""""""""" |
1018 | 1018 |
1019 Defines subrepositories source locations rewriting rules of the form:: | 1019 Defines subrepositories source locations rewriting rules of the form:: |