add document on command defaults
authorTK Soh <teekaysoh@yahoo.com>
Sat, 02 Sep 2006 20:24:53 +0800
changeset 3039 77637938d43d
parent 3038 1efd5a6df5a3
child 3053 60094899dfc9
add document on command defaults
doc/hgrc.5.txt
--- a/doc/hgrc.5.txt	Sun Sep 03 02:28:39 2006 +0200
+++ b/doc/hgrc.5.txt	Sat Sep 02 20:24:53 2006 +0800
@@ -135,6 +135,21 @@
     # them to the working dir
     **.txt = tempfile: unix2dos -n INFILE OUTFILE
 
+defaults::
+  Use the [defaults] section to define command defaults, i.e. the 
+  default options/arguments to pass to the specified commands.
+  
+  The following example makes 'hg log' run in verbose mode, and
+  'hg status' show only the modified files, by default.
+  
+    [defaults]
+    log = -v
+    status = -m
+  
+  The actual commands, instead of their aliases, must be used when 
+  defining command defaults. The command defaults will also be
+  applied to the aliases of the commands defined.
+
 email::
   Settings for extensions that send email messages.
   from;;