1998 2020 Ericsson AB, All Rights Reserved Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The Initial Developer of the Original Code is Ericsson AB. tags Anders Lindgren 1 98-03-11 A tags.sgml
tags Generate Emacs TAGS file from Erlang source files

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.

 file(File [, Options]) Create a TAGSfile for the file File.

Create a TAGS file for the file File.

 files(FileList [, Options]) Create a TAGS file for the files in the listFileList.

Create a TAGS file for the files in the list FileList.

 dir(Dir [, Options]) Create a TAGS file for all files in directoryDir.

Create a TAGS file for all files in directory Dir.

 dirs(DirList [, Options]) Create a TAGS file for all files in any directory inDirList.

Create a TAGS file for all files in any directory in DirList.

 subdir(Dir [, Options]) Descend recursively down the directory Dirand create a TAGSfile based on all files found.

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 inDirListand create a TAGSfile based on all files found.

Descend recursively down all the directories in DirList and create a TAGS file based on all files found.

 root([Options]) Create a TAGSfile covering all files in the Erlang distribution.

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.

The default behaviour is to create a file named TAGS in the current directory.

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.