]> code.delx.au - gnu-emacs/blobdiff - etc/etags.1
(isearch-next-buffer-function, TeX-master): Add defvars.
[gnu-emacs] / etc / etags.1
index e1846a09e17b3774b22647c0ebb3a5c147e68301..0c0e12bb6cf37953bcff197d366d9bb133be79df 100644 (file)
@@ -1,4 +1,5 @@
-.\" Copyright (c) 1992, 2001 Free Software Foundation
+.\" Copyright (C) 1992, 2001, 2002, 2003, 2004,
+.\"   2005 Free Software Foundation, Inc.
 .\" See section COPYING for conditions for redistribution
 .TH etags 1 "23nov2001" "GNU Tools" "GNU Tools"
 .de BP
@@ -49,8 +50,8 @@ understood by
 format understood by
 .BR vi ( 1 )\c
 \&.  Both forms of the program understand
-the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang,
-LaTeX, Emacs Lisp/Common Lisp, makefiles, Pascal, Perl, PHP, Postscript,
+the syntax of C, Objective C, C++, Java, Fortran, Ada, Cobol, Erlang, HTML,
+LaTeX, Emacs Lisp/Common Lisp, Lua, makefile, Pascal, Perl, PHP, Postscript,
 Python, Prolog, Scheme and
 most assembler\-like syntaxes.
 Both forms read the files specified on the command line, and write a tag
@@ -58,7 +59,9 @@ table (defaults: \fBTAGS\fP for \fBetags\fP, \fBtags\fP for
 \fBctags\fP) in the current working directory.
 Files specified with relative file names will be recorded in the tag
 table with file names relative to the directory where the tag table
-resides.  Files specified with absolute file names will be recorded
+resides.  If the tag table is in /dev, however, the file names are made
+relative to the working directory.  Files specified with absolute file
+names will be recorded
 with absolute file names.  Files generated from a source file\-\-like
 a C file generated from a source Cweb file\-\-will be recorded with
 the name of the source file.
@@ -176,13 +179,20 @@ at once, rather than line by line, and the matching sequence can match
 multiple lines; and \fIs\fP, which implies \fIm\fP and means that the
 dot character in \fItagregexp\fP matches the newline char as well.
 .br
-cthe optional \fB{\fP\fIlanguage\fP\fB}\fP means that the tag should be
+The separator, which is \fB/\fP in the examples, can be any character
+different from space, tab, braces and \fB@\fP.  If the separator
+character is needed inside the regular expression, it must be quoted
+by preceding it with \fB\\\fP.
+.br
+The optional \fB{\fP\fIlanguage\fP\fB}\fP prefix means that the tag
+should be
 created only for files of language \fIlanguage\fP, and ignored
 otherwise.  This is particularly useful when storing many predefined
 regexps in a file.
 .br
-In its second form, \fIregexfile\fP is the name of a file containing
-regexps, one per line.  Lines beginning with a space or tab are assumed
+In its second form, \fIregexfile\fP is the name of a file that contains
+a number of arguments to the \fI\-\-regex\=\fP option,
+one per line.  Lines beginning with a space or tab are assumed
 to be comments, and ignored.
 
 .br
@@ -229,12 +239,12 @@ Don't do any more regexp matching on the following files.  May be
 freely intermixed with filenames and the \fB\-\-regex\fP option.
 .TP
 .B \-t, \-\-typedefs
-Record typedefs in C code as tags.  Since this is the default behaviour
+Record typedefs in C code as tags.  Since this is the default behavior
 of \fBetags\fP, only \fBctags\fP accepts this option.
 .TP
 .B \-T, \-\-typedefs\-and\-c++
 Generate tag entries for typedefs, struct, enum, and union tags, and
-C++ member functions.  Since this is the default behaviour
+C++ member functions.  Since this is the default behavior
 of \fBetags\fP, only \fBctags\fP accepts this option.
 .TP
 .B \-u, \-\-update
@@ -259,7 +269,8 @@ Instead of generating a tag file, write a cross reference (in
 \fBcxref\fP format) to standard output.  Only \fBctags\fP accepts this option.
 .TP
 .B \-h, \-H, \-\-help
-Print usage information.
+Print usage information.  Followed by one or more \-\-language=LANG
+prints detailed information about how tags are created for LANG.
 .TP
 .B \-V, \-\-version
 Print the current version of the program (same as the version of the
@@ -278,7 +289,7 @@ Stallman.
 Copyright
 .if t \(co
 .if n (c)
-1999, 2001 Free Software Foundation, Inc.
+1999, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
 .PP
 Permission is granted to make and distribute verbatim copies of this
 document provided the copyright notice and this permission notice are
@@ -293,3 +304,5 @@ Permission is granted to copy and distribute translations of this
 document into another language, under the above conditions for
 modified versions, except that this permission notice may be stated
 in a translation approved by the Free Software Foundation.
+
+.\" arch-tag: 9534977f-af78-42f0-991d-1df6b6c05573