Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.
In the following statement, the phrase ``this text'' refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]
Copyright (c) 1980 Regents of the University of California.
Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved.
/usr/bin/ctags [-aBFtuvwx] [-f tagsfile] file...
/usr/xpg4/bin/ctags [-aBFuvwx] [-f tagsfile] file...
Normally, ctags places the tag descriptions in a file called tags; this may be overridden with the -f option.
Files with names ending in .c or .h are assumed to be either C or C++ source files and are searched for C/C++ routine and macro definitions. Files with names ending in .cc, .C, or .cxx are assumed to be C++ source files. Files with names ending in .y are assumed to be yacc source files. Files with names ending in .l are assumed to be lex files. Others are first examined to see if they contain any Pascal or FORTRAN routine definitions; if not, they are processed again looking for C definitions.
The tag main is treated specially in C or C++ programs. The tag formed is created by prepending M to file, with a trailing .c, .cc, .C, or .cxx removed, if any, and leading path name components also removed. This makes use of ctags practical in directories with more than one program.
Appends output to an existing tags file.
Uses backward searching patterns (?.\|.\|.\|?).
Places the tag descriptions in a file called tagsfile instead of tags.
Uses forward searching patterns (/.\|.\|.\|/) (default).
Updates the specified files in tags, that is, all references to them are deleted, and the new values are appended to the file. Beware: this option is implemented in a way that is rather slow; it is usually faster to simply rebuild the tags file.
Produces on the standard output an index listing the function name, file name, and page number (assuming 64 line pages). Since the output will be sorted into lexicographic order, it may be desired to run the output through sort -f.
Suppresses warning diagnostics.
Produces a list of object names, the line number and file name on which each is defined, as well as the text of that line and prints this on the standard output. This is a simple index which can be printed out as an off-line readable function index.
Files with basenames ending with the .c suffix are treated as C-language source code.
Files with basenames ending with the .h suffix are treated as C-language source code.
Files with basenames ending with the .f suffix are treated as FORTRAN-language source code.
Using ctags with the -v option produces entries in an order which may not always be appropriate for vgrind. To produce results in alphabetical order, you may want to run the output through sort -f.
example% ctags -v filename.c filename.h | sort -f \|>\| index example% vgrind -x index
Example 2 Building a tags file
To build a tags file for C sources in a directory hierarchy rooted at sourcedir, first create an empty tags file, and then run find(1)
example% cd sourcedir ; rm -f tags ; touch tags example% find . \e( -name SCCS -prune -name \e\e '*.c' -o -name '*.h' \e) -exec ctags -u {} \e;
Notice that spaces must be entered exactly as shown.
Successful completion.
An error occurred.
output tags file
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
The method of deciding whether to look for C or Pascal and FORTRAN functions is a hack.
The ctags utility does not know about #ifdefs.
The ctags utility should know about Pascal types. Relies on the input being well formed to detect typedefs. Use of -tx shows only the last line of typedefs.