From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/tools/doc/src/tags.xml | 147 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 lib/tools/doc/src/tags.xml (limited to 'lib/tools/doc/src/tags.xml') diff --git a/lib/tools/doc/src/tags.xml b/lib/tools/doc/src/tags.xml new file mode 100644 index 0000000000..5e1da25acf --- /dev/null +++ b/lib/tools/doc/src/tags.xml @@ -0,0 +1,147 @@ + + + + +
+ + 1998 + 2007 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights 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. + +
+ + -- cgit v1.2.3