contrib/chg/README
changeset 28060 726f8d6cc324
child 28454 8062869860b8
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/contrib/chg/README	Sun Jan 03 12:39:27 2016 +0900
@@ -0,0 +1,32 @@
+cHg
+===
+
+A fast client for Mercurial command server running on Unix.
+
+Install:
+
+ $ make
+ $ make install
+
+Usage:
+
+ $ chg help                 # show help of Mercurial
+ $ alias hg=chg             # replace hg command
+ $ chg --kill-chg-daemon    # terminate background server
+ $ chg --reload-chg-daemon  # reload configuration files
+
+Environment variables:
+
+Although cHg tries to update environment variables, some of them cannot be
+changed after spawning the server. The following variables are specially
+handled:
+
+ * configuration files are reloaded if HGPLAIN or HGPLAINEXCEPT changed, but
+   some behaviors won't change correctly.
+ * CHGHG or HG specifies the path to the hg executable spawned as the
+   background command server.
+
+The following variables are available for testing:
+
+ * CHGDEBUG enables debug messages.
+ * CHGSOCKNAME specifies the socket path of the background cmdserver.