Make "runghc -f path-to-ghc Main.hs" work
[ghc-hetmet.git] / utils / hasktags / README
1
2 "hasktags" is a very simple Haskell program that produces ctags "tags" and etags "TAGS" files for Haskell programs.
3
4 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.
5
6 Example usage:
7
8 find -name \*.\*hs | xargs hasktags
9
10
11 This will create "tags" and "TAGS" files in the current directory describing all Haskell files in the current directory or below.
12
13
14
15 Features
16         * Includes top level functions, provided a type signature is given
17         * Includes data declarations, and constructors
18         * Includes newtypes
19         
20         - But sometimes gets things wrong or misses things out
21                 It's only a simple program
22                 
23                 
24 Using with your editor:
25
26 With NEdit
27         Load the "tags" file using File/Load Tags File.
28         Use "Ctrl-D" to search for a tag.
29
30 With XEmacs/Emacs
31         Load the "TAGS" file using "visit-tags-table"
32         Use "M-." to search for a tag.
33