Mercurial > hg-stable
changeset 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 | 4efb9b109292 |
| children | dbe0ce2ae196 |
| files | .hgignore doc/Makefile doc/hg.1.txt doc/hgrc.5.txt |
| diffstat | 4 files changed, 147 insertions(+), 84 deletions(-) [+] |
line wrap: on
line diff
--- a/.hgignore Sun Jul 10 16:13:39 2005 -0800 +++ b/.hgignore Sun Jul 10 16:14:06 2005 -0800 @@ -5,6 +5,7 @@ .*pyc build/.* dist/ +doc/.*\.[0-9] MANIFEST$ .pc/ patches/
--- a/doc/Makefile Sun Jul 10 16:13:39 2005 -0800 +++ b/doc/Makefile Sun Jul 10 16:14:06 2005 -0800 @@ -1,7 +1,6 @@ - -SOURCES=$(wildcard *.1.txt) -MAN=$(SOURCES:%.1.txt=%.1) -HTML=$(SOURCES:%.1.txt=%.1.html) +SOURCES=$(wildcard *.[0-9].txt) +MAN=$(SOURCES:%.txt=%) +HTML=$(SOURCES:%.txt=%.html) all: man @@ -9,14 +8,14 @@ html: $(HTML) -%.1: %.1.xml - xmlto man $*.1.xml +%: %.xml + xmlto man $*.xml -%.1.xml: %.1.txt - asciidoc -d manpage -b docbook $*.1.txt +%.xml: %.txt + asciidoc -d manpage -b docbook $*.txt -%.1.html: %.1.txt - asciidoc -b html $*.1.txt +%.html: %.txt + asciidoc -b html $*.txt clean: - $(RM) $(MAN) $(MAN:%.1=%.1.xml) $(MAN:%.1=%.1.html) + $(RM) $(MAN) $(MAN:%=%.xml) $(MAN:%=%.html)
--- a/doc/hg.1.txt Sun Jul 10 16:13:39 2005 -0800 +++ b/doc/hg.1.txt Sun Jul 10 16:14:06 2005 -0800 @@ -494,85 +494,18 @@ $HOME/.hgrc, .hg/hgrc:: This file contains defaults and configuration. Values in .hg/hgrc - override those in .hgrc. - - -UI OPTIONS ----------- - -Various configuration options can be set in .hgrc: - -------------- -[ui] -verbose = 0 -username = Matt Mackall <mpm@selenic.com> -editor = hgeditor -merge = hgmerge -------------- - - -NAMED REPOSITORIES ------------------- - -To give symbolic names to a repository, create a section in .hgrc -or .hg/hgrc containing assignments of names to paths. Example: - ------------------ -[paths] -hg = http://selenic.com/hg -tah = http://hg.intevation.org/mercurial-tah/ ------------------ - - -LOCAL TAGS ----------- - -To create tags that are local to the repository and not distributed or -version-controlled, create an hgrc section like the following: - ----------------- -[tags] -working = 2dcced388cab3677a8f543c3c47a0ad34ac9d435 -tested = 12e0fdbc57a0be78f0e817fd1d170a3615cd35da ----------------- - - -HOOKS ------ - -Mercurial supports a set of 'hook', commands that get automatically -executed by various actions such as starting or finishing a commit. To -specify a hook, simply create an hgrc section like the following: - ------------------ -[hooks] -precommit = echo "this hook gets executed immediately before a commit" -commit = hg export $NODE | mail -s "new commit $NODE" commit-list ------------------ - - -NON_TRANSPARENT PROXY SUPPORT ------------------------------ - -To access a Mercurial repository through a proxy, create a file -$HOME/.hgrc in the following format: - --------------- -[http_proxy] -host=myproxy:8080 -user=<username> -passwd=<password> -no=<localhost1>,<localhost2>,<localhost3>,... --------------- - -"user" and "passwd" fields are used for authenticating proxies, "no" is a -comma-separated list of local host names to not proxy. + override those in .hgrc. See hgrc(5) for details of the contents + and format of these files. BUGS ---- Probably lots, please post them to the mailing list (See Resources below) when you find them. +SEE ALSO +-------- +hgrc(5) + AUTHOR ------ Written by Matt Mackall <mpm@selenic.com> @@ -581,6 +514,8 @@ --------- http://selenic.com/mercurial[Main Web Site] +http://www.serpentine.com/mercurial[Wiki site] + http://selenic.com/hg[Source code repository] http://selenic.com/mailman/listinfo/mercurial[Mailing list]
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/hgrc.5.txt Sun Jul 10 16:14:06 2005 -0800 @@ -0,0 +1,128 @@ +HGRC(5) +======= +Bryan O'Sullivan <bos@serpentine.com> + +NAME +---- +hgrc - configuration files for Mercurial + +SYNOPSIS +-------- + +The Mercurial system uses a set of configuration files to control +aspects of its behaviour. + +FILES +----- + +Mercurial reads configuration data from two files: + +$HOME/.hgrc:: + Global configuration options that apply to all Mercurial commands, + no matter where they are run. + +<repo>/.hg/hgrc:: + Per-repository configuration options that only apply in a + particular repository. This file is not version-controlled, and + will not get transferred during a "clone" operation. Values in + this file override global values. + +SYNTAX +------ + +A configuration file consists of sections, led by a "[section]" header +and followed by "name: value" entries; "name=value" is also accepted. + + [spam] + eggs=ham + green= + eggs + +Each line contains one entry. If the lines that follow are indented, +they are treated as continuations of that entry. + +Leading whitespace is removed from values. Empty lines are skipped. + +The optional values can contain format strings which refer to other +values in the same section, or values in a special DEFAULT section. + +Lines beginning with "#" or ";" are ignored and may be used to provide +comments. + +SECTIONS +-------- + +This section describes the different sections that may appear in a +Mercurial "hgrc" file, the purpose of each section, its possible +keys, and their possible values. + +hooks:: + Commands that get automatically executed by various actions such as + starting or finishing a commit. + precommit;; + Run before starting a commit. Exit status 0 allows the commit to + proceed. Non-zero status will cause the commit to fail. + commit;; + Run after a changeset has been created. Passed the ID of the newly + created changeset. + +http_proxy:: + Used to access web-based Mercurial repositories through a HTTP + proxy. + host;; + Host name and (optional) port of the proxy server, for example + "myproxy:8000". + user;; + Optional. User name to authenticate with at the proxy server. + passwd;; + Optional. Password to authenticate with at the proxy server. + no;; + Optional. Comma-separated list of host names that should bypass + the proxy. + +paths:: + Assigns symbolic names to repositories. The left side is the + symbolic name, and the right gives the directory or URL that is the + location of the repository. + +tags:: + Tags that are local to a repository and not distributed or version + controlled. The left side is the tag name, and the right is the + ID of the changeset to identify. + +ui:: + User interface controls. + debug;; + Print debugging information. True or False. Default is True. + editor;; + The editor to use during a commit. Default is "vi". + merge;; + The conflict resolution program to use during a manual merge. + Default is "hgeditor". + quiet;; + Reduce the amount of output printed. True or False. Default is + False. + username;; + The committer of a changeset created when running "commit". + Typically a person's name and email address, e.g. "Fred Widget + <fred@example.com>". Default is username@hostname. + verbose;; + Increase the amount of output printed. True or False. Default is + False. + +AUTHOR +------ +Bryan O'Sullivan <bos@serpentine.com>. + +Mercurial was written by Matt Mackall <mpm@selenic.com>. + +SEE ALSO +-------- +hg(1) + +COPYING +------- +This manual page is copyright 2005 Bryan O'Sullivan. +Mercurial is copyright 2005 Matt Mackall. +Free use of this software is granted under the terms of the GNU General +Public License (GPL).