other versions
- jessie 1:17.3-dfsg-4+deb8u2
- jessie-backports 1:19.2.1+dfsg-2+deb9u1~bpo8+1
- stretch 1:19.2.1+dfsg-2+deb9u2
- testing 1:21.2.5+dfsg-1
- unstable 1:21.2.6+dfsg-1
- experimental 1:22.0~rc1+dfsg-1
tags(3erl) | Erlang Module Definition | tags(3erl) |
NAME¶
tags - Generate Emacs TAGS file from Erlang source filesDESCRIPTION¶
A TAGS file is used by Emacs to find function and variable definitions in any source file in large projects. This module can generate a TAGS file from Erlang source files. It recognises functions, records, and macro definitions.EXPORTS¶
file(File [, Options])
Create a TAGS file for the file File.
files(FileList [, Options])
Create a TAGS file for the files in the list FileList.
dir(Dir [, Options])
Create a TAGS file for all files in directory Dir.
dirs(DirList [, Options])
Create a TAGS file for all files in any directory in DirList.
subdir(Dir [, Options])
Descend recursively down the directory Dir and create a TAGS file
based on all files found.
subdirs(DirList [, Options])
Descend recursively down all the directories in DirList and create a
TAGS file based on all files found.
root([Options])
Create a TAGS file covering all files in the Erlang distribution.
OPTIONS¶
The functions above have an optional argument, Options. It is a list which can contain the following elements:- *
- {outfile, NameOfTAGSFile} Create a TAGS file named NameOfTAGSFile.
- *
- {outdir, NameOfDirectory} Create a file named TAGS in the directory NameOfDirectory.
EXAMPLES¶
- *
- tags:root([{outfile, "root.TAGS"}]).
This command will create a file named root.TAGS in the current directory.
The file will contain references to all Erlang source files in the Erlang
distribution.
- *
- tags:files(["foo.erl", "bar.erl",
"baz.erl"], [{outdir, "../projectdir"}]).
Here we create file named TAGS placed it in the directory
../projectdir. The file contains information about the functions,
records, and macro definitions of the three files.
SEE ALSO¶
- *
- Richard M. Stallman. GNU Emacs Manual, chapter "Editing Programs", section "Tag Tables". Free Software Foundation, 1995.
- *
- Anders Lindgren. The Erlang editing mode for Emacs. Ericsson, 1998.
tools 2.9 | Ericsson AB |