diff doc/hgrc.5.txt @ 8655:21688b8a594b

Move alias into core
author Brendan Cully <brendan@kublai.com>
date Sat, 30 May 2009 11:32:23 -0700
parents 493d23d923ea
children 72b95e3a0cc9
line wrap: on
line diff
--- a/doc/hgrc.5.txt	Sat May 30 19:37:01 2009 +0200
+++ b/doc/hgrc.5.txt	Sat May 30 11:32:23 2009 -0700
@@ -100,6 +100,29 @@
 Mercurial "hgrc" file, the purpose of each section, its possible
 keys, and their possible values.
 
+[[alias]]
+alias::
+ Defines command aliases.
+  Aliases allow you to define your own commands in terms of other
+  commands (or aliases), optionally including arguments.
++
+Alias definitions consist of lines of the form:
++
+    <alias> = <command> [<argument]...
++
+For example, this definition:
++
+    latest = log --limit 5
++
+creates a new command `latest` that shows only the five most recent
+changesets. You can define subsequent aliases using earlier ones:
++
+    stable5 = latest -b stable
++
+*Note*: It is possible to create aliases with the same names as
+existing commands, which will then override the original
+definitions. This is almost always a bad idea!
+
 [[auth]]
 auth::
   Authentication credentials for HTTP authentication.