comparison doc/hg.1.txt @ 671:efa4a7e2f322

Move hgrc documentation out to its own man page, hgrc(5). # HG changeset patch # User Bryan O'Sullivan <bos@serpentine.com> # Node ID 5076cf1fd6a1b8eb410e5e03cb004ca6a52a30f9 # Parent 7369ec5d93f2ffd490a43970edd9adf8d2bbe269 Move hgrc documentation out to its own man page, hgrc(5). The new man page expands on the existing documentation by describing the file format and the purpose of each section and field.
author Bryan O'Sullivan <bos@serpentine.com>
date Sun, 10 Jul 2005 16:14:06 -0800
parents a287f6cd9c6b
children 1c0c413cccdd c6b912f8b5b2 8db4d406b3d3 d2422f10c136
comparison
equal deleted inserted replaced
670:4efb9b109292 671:efa4a7e2f322
492 seperated by spaces) that correspond to tagged versions of the repository 492 seperated by spaces) that correspond to tagged versions of the repository
493 contents. 493 contents.
494 494
495 $HOME/.hgrc, .hg/hgrc:: 495 $HOME/.hgrc, .hg/hgrc::
496 This file contains defaults and configuration. Values in .hg/hgrc 496 This file contains defaults and configuration. Values in .hg/hgrc
497 override those in .hgrc. 497 override those in .hgrc. See hgrc(5) for details of the contents
498 498 and format of these files.
499
500 UI OPTIONS
501 ----------
502
503 Various configuration options can be set in .hgrc:
504
505 -------------
506 [ui]
507 verbose = 0
508 username = Matt Mackall <mpm@selenic.com>
509 editor = hgeditor
510 merge = hgmerge
511 -------------
512
513
514 NAMED REPOSITORIES
515 ------------------
516
517 To give symbolic names to a repository, create a section in .hgrc
518 or .hg/hgrc containing assignments of names to paths. Example:
519
520 -----------------
521 [paths]
522 hg = http://selenic.com/hg
523 tah = http://hg.intevation.org/mercurial-tah/
524 -----------------
525
526
527 LOCAL TAGS
528 ----------
529
530 To create tags that are local to the repository and not distributed or
531 version-controlled, create an hgrc section like the following:
532
533 ----------------
534 [tags]
535 working = 2dcced388cab3677a8f543c3c47a0ad34ac9d435
536 tested = 12e0fdbc57a0be78f0e817fd1d170a3615cd35da
537 ----------------
538
539
540 HOOKS
541 -----
542
543 Mercurial supports a set of 'hook', commands that get automatically
544 executed by various actions such as starting or finishing a commit. To
545 specify a hook, simply create an hgrc section like the following:
546
547 -----------------
548 [hooks]
549 precommit = echo "this hook gets executed immediately before a commit"
550 commit = hg export $NODE | mail -s "new commit $NODE" commit-list
551 -----------------
552
553
554 NON_TRANSPARENT PROXY SUPPORT
555 -----------------------------
556
557 To access a Mercurial repository through a proxy, create a file
558 $HOME/.hgrc in the following format:
559
560 --------------
561 [http_proxy]
562 host=myproxy:8080
563 user=<username>
564 passwd=<password>
565 no=<localhost1>,<localhost2>,<localhost3>,...
566 --------------
567
568 "user" and "passwd" fields are used for authenticating proxies, "no" is a
569 comma-separated list of local host names to not proxy.
570 499
571 BUGS 500 BUGS
572 ---- 501 ----
573 Probably lots, please post them to the mailing list (See Resources below) 502 Probably lots, please post them to the mailing list (See Resources below)
574 when you find them. 503 when you find them.
575 504
505 SEE ALSO
506 --------
507 hgrc(5)
508
576 AUTHOR 509 AUTHOR
577 ------ 510 ------
578 Written by Matt Mackall <mpm@selenic.com> 511 Written by Matt Mackall <mpm@selenic.com>
579 512
580 RESOURCES 513 RESOURCES
581 --------- 514 ---------
582 http://selenic.com/mercurial[Main Web Site] 515 http://selenic.com/mercurial[Main Web Site]
516
517 http://www.serpentine.com/mercurial[Wiki site]
583 518
584 http://selenic.com/hg[Source code repository] 519 http://selenic.com/hg[Source code repository]
585 520
586 http://selenic.com/mailman/listinfo/mercurial[Mailing list] 521 http://selenic.com/mailman/listinfo/mercurial[Mailing list]
587 522