Erlang -- tags

User's Guide
Reference Manual
Release Notes
PDF
Top

Tools
Reference Manual
Version 2.8.4

Expand All
Contract All

Table of Contents

- cover
  - Top of manual page
  - analyse/0
  - analyse/1
  - analyse/2
  - analyse/1
  - analyse/1
  - analyse/2
  - analyse/3
  - analyse/2
  - analyse_to_file/0
  - analyse_to_file/1
  - analyse_to_file/2
  - analyse_to_file/1
  - async_analyse_to_file/1
  - async_analyse_to_file/2
  - async_analyse_to_file/3
  - async_analyse_to_file/2
  - compile/1
  - compile/2
  - compile_beam/1
  - compile_beam_directory/0
  - compile_beam_directory/1
  - compile_directory/0
  - compile_directory/1
  - compile_directory/2
  - compile_module/1
  - compile_module/2
  - export/1
  - export/2
  - flush/1
  - import/1
  - imported/0
  - imported_modules/0
  - is_compiled/1
  - modules/0
  - reset/0
  - reset/1
  - start/0
  - start/1
  - stop/0
  - stop/1
  - which_nodes/0
- cprof
  - Top of manual page
  - analyse/0
  - analyse/1
  - analyse/1
  - analyse/2
  - pause/0
  - pause/1
  - pause/2
  - pause/3
  - restart/0
  - restart/1
  - restart/2
  - restart/3
  - start/0
  - start/1
  - start/2
  - start/3
  - stop/0
  - stop/1
  - stop/2
  - stop/3
- eprof
  - Top of manual page
  - analyze/0
  - analyze/1
  - analyze/2
  - log/1
  - profile/1
  - profile/2
  - profile/1
  - profile/2
  - profile/3
  - profile/4
  - profile/5
  - profile/6
  - start/0
  - start_profiling/1
  - start_profiling/2
  - start_profiling/3
  - stop/0
  - stop_profiling/0
- erlang.el
- fprof
  - Top of manual page
  - analyse/0
  - analyse/1
  - analyse/2
  - analyse/1
  - analyse/1
  - apply/2
  - apply/3
  - apply/3
  - apply/4
  - profile/0
  - profile/1
  - profile/2
  - profile/1
  - profile/1
  - start/0
  - stop/0
  - stop/1
  - trace/1
  - trace/2
  - trace/1
  - trace/2
  - trace/1
  - trace/2
  - trace/1
- instrument
  - Top of manual page
  - allocator_descr/2
  - block_header_size/1
  - class_descr/2
  - descr/1
  - holes/1
  - mem_limits/1
  - memory_data/0
  - memory_status/1
  - read_memory_data/1
  - read_memory_status/1
  - sort/1
  - store_memory_data/1
  - store_memory_status/1
  - sum_blocks/1
  - type_descr/2
  - type_no_range/1
- lcnt
  - Top of manual page
  - apply/1
  - apply/2
  - apply/3
  - clear/0
  - clear/1
  - collect/0
  - collect/1
  - conflicts/0
  - conflicts/1
  - information/0
  - inspect/1
  - inspect/2
  - load/1
  - locations/0
  - locations/1
  - pid/2
  - pid/3
  - port/1
  - port/2
  - rt_clear/0
  - rt_clear/1
  - rt_collect/0
  - rt_collect/1
  - rt_opt/2
  - rt_opt/1
  - save/1
  - start/0
  - stop/0
  - swap_pid_keys/0
- make
  - Top of manual page
  - all/0
  - all/1
  - files/1
  - files/2
- tags
  - Top of manual page
  - dir/1
  - dirs/1
  - file/1
  - files/1
  - root/1
  - subdir/1
  - subdirs/1
- xref
  - Top of manual page
  - add_application/2
  - add_directory/2
  - add_module/2
  - add_release/2
  - analyze/2
  - d/1
  - forget/1
  - forget/2
  - format_error/1
  - get_default/1
  - get_default/2
  - get_library_path/1
  - info/1
  - info/2
  - info/3
  - m/1
  - m/1
  - q/2
  - remove_application/2
  - remove_module/2
  - remove_release/2
  - replace_application/3
  - replace_module/3
  - set_default/3
  - set_default/2
  - set_library_path/2
  - start/2
  - start/1
  - stop/1
  - update/1
  - variables/1

# tags

### MODULE

tags

### MODULE SUMMARY

Generate Emacs TAGS file from Erlang source files

### DESCRIPTION

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.

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.