diff hgext/pager.py @ 6462:6c4e12682fb9

pager: make config info accessible with "hg help pager"

--- a/hgext/pager.py	Thu Apr 03 12:46:37 2008 +0200
+++ b/hgext/pager.py	Thu Apr 03 13:47:05 2008 +0200
@@ -10,36 +10,41 @@
 #   [extension]
 #   hgext.pager =
 #
-# To set the pager that should be used, set the application variable:
-#
-#   [pager]
-#   pager = LESS='FSRX' less
-#
-# If no pager is set, the pager extensions uses the environment
-# variable $PAGER. If neither pager.pager, nor $PAGER is set, no pager
-# is used.
-#
-# If you notice "BROKEN PIPE" error messages, you can disable them
-# by setting:
-#
-#   [pager]
-#   quiet = True
-#
-# You can disable the pager for certain commands by adding them to the
-# pager.ignore list:
-#
-#   [pager]
-#   ignore = version, help, update
-#
-# You can also enable the pager only for certain commands using pager.attend:
-#
-#   [pager]
-#   attend = log
-#
-# If pager.attend is present, pager.ignore will be ignored.
-#
-# To ignore global commands like 'hg version' or 'hg help', you have to specify them
-# in the global .hgrc
+# Run "hg help pager" to get info on configuration.
+
+'''browse command output with external pager
+
+To set the pager that should be used, set the application variable:
+
+  [pager]
+  pager = LESS='FSRX' less
+
+If no pager is set, the pager extensions uses the environment
+variable $PAGER. If neither pager.pager, nor $PAGER is set, no pager
+is used.
+
+If you notice "BROKEN PIPE" error messages, you can disable them
+by setting:
+
+  [pager]
+  quiet = True
+
+You can disable the pager for certain commands by adding them to the
+pager.ignore list:
+
+  [pager]
+  ignore = version, help, update
+
+You can also enable the pager only for certain commands using pager.attend:
+
+  [pager]
+  attend = log
+
+If pager.attend is present, pager.ignore will be ignored.
+
+To ignore global commands like "hg version" or "hg help", you have to specify
+them in the global .hgrc
+'''
 
 import sys, os, signal
 from mercurial import dispatch