tags(3)

tags3

Module

tags - Generate Emacs TAGS file from Erlang source files.

Overview

A TAGS file is used by Emacs to find function and variable definitions in any source file in a big project. This module can generate a TAGS file from Erlang source files. It recognises functions, records, and defines.

Exports

root([Options])

Create a TAGS file covering all files in the Erlang distribution.

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.

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.

Releases

Unchanged in 2 releases since Debian 2.2 (Potato).

  1. 2.2–3.0

Author

Anders Lindgren

From erlang-mode 2.3-2 in Debian 3.0 (Woody). Parsed by carta from the page's man source.