tags.3

   1 .TH TAGS 3 1996-05-30 "Ericsson Software Technology" "ERLANG MODULE DEFINITION"
   2 .SH MODULE
   3 tags \- Generate Emacs TAGS file from Erlang source files.
   4 .SH DESCRIPTION
   5 A TAGS file is used by Emacs to find function and variable definitions
   6 in any source file in a big project.  This module can generate a TAGS
   7 file from Erlang source files.  It recognises functions, records, and
   8 defines.
   9 .SH EXPORTS
  10 .TP 8
  11 .B root([Options])
  12 Create a TAGS file covering all files in the Erlang distribution.
  13 .TP 8
  14 .B file(File [, Options])
  15 Create a TAGS file for the file `File'.
  16 .TP 8
  17 .B files(FileList [, Options])
  18 Create a TAGS file for the files in the list `FileList'.
  19 .TP 8
  20 .B dir(Dir [, Options])
  21 Create a TAGS file for all files in directory `Dir'.
  22 .TP 8
  23 .B dirs(DirList [, Options])
  24 Create a TAGS file for all files in any directory in `DirList'.
  25 .TP 8
  26 .B subdir(Dir [, Options])
  27 Descend recursively down the directory `Dir' and create a TAGS file
  28 based on all files found.
  29 .TP 8
  30 .B subdirs(DirList [, Options])
  31 Descend recursively down all the directories in `DirList' and create a
  32 TAGS file based on all files found.
  33 .SH OPTIONS
  34 The functions above have an optional argument, \fBOptions\fR.  It is a
  35 list which can contain the following elements:
  36 .TP 8
  37 .B {outfile, NameOfTAGSFile}
  38 Create a TAGS file named `NameOfTAGSFile'.
  39 .TP 8
  40 .B {outdir, NameOfDirectory}
  41 Create a file named TAGS in the directory `NameOfDirectory'.
  42 .P
  43 The default behaviour is to create a file named "TAGS" in the current
  44 directory.
  45 .SH SEE ALSO
  46 GNU Emacs Manual, chapter "Editing Programs", section "Tag Tables".
  47 .P
  48 Erlang mode V2.0 for Emacs.
  49 .SH AUTHOR
  50 .nf
  51 Anders Lindgren
  52 .fi
  53
  54 .\" Local Variables:
  55 .\" mode: nroff
  56 .\" eval: (auto-fill-mode 1)
  57 .\" left-margin: 0
  58 .\" fill-column: 70
  59 .\" version-control: never
  60 .\" indent-tabs-mode: nil
  61 .\" End: