[project @ 2004-07-19 11:51:16 by simonmar]

[ghc-hetmet.git] / ghc / utils / hasktags / README

diff --git a/ghc/utils/hasktags/README b/ghc/utils/hasktags/README
index ea806b3..77bac88 100644 (file)
--- a/ghc/utils/hasktags/README
+++ b/ghc/utils/hasktags/README
@@ -1,11 +1,15 @@
 
-"hasktags" is a very simple Haskell program that produces ctags TAGS files for Haskell programs.
+"hasktags" is a very simple Haskell program that produces ctags "tags" and etags "TAGS" files for Haskell programs.
 
 As such, it does essentially the same job that hstags and fptags used to do, but, both of those seem to no longer be maintained, and it seemed to be easier to write my own version rather than to get one of them to work.
 
 Example usage:
 
-find /homes/rje33/src/fptools/ghc/ -name \*.\*hs | xargs hasktags > TAGS
+find -name \*.\*hs | xargs hasktags
+
+
+This will create "tags" and "TAGS" files in the current directory describing all Haskell files in the current directory or below.
+
 
 
 Features
@@ -17,3 +21,13 @@ Features
                It's only a simple program
                
                
+Using with your editor:
+
+With NEdit
+       Load the "tags" file using File/Load Tags File.
+       Use "Ctrl-D" to search for a tag.
+
+With XEmacs/Emacs
+       Load the "TAGS" file using "visit-tags-table"
+       Use "M-." to search for a tag.
+