version 1.22, 2010/10/19 16:54:15 |
version 1.23, 2010/11/03 19:39:38 |
|
|
.Nd create a tags file |
.Nd create a tags file |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm ctags |
.Nm ctags |
.Op Fl aBdFtuvwx |
.Op Fl aBdFuvwx |
.Op Fl f Ar tagsfile |
.Op Fl f Ar tagsfile |
.Ar |
.Ar |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm |
.Nm |
makes a tags file for |
makes a tags file from the specified, C Pascal, Fortran, |
.Xr ex 1 |
|
from the specified C, |
|
Pascal, Fortran, |
|
.Tn YACC , |
.Tn YACC , |
lex, and lisp sources. |
lex, and Lisp sources. |
A tags file gives the locations of specified objects in a group of files. |
A tags file gives the locations of specified objects in a group of files. |
Each line of the tags file contains the object name, the file in which it |
Each line of the tags file contains the object name, the file in which it |
is defined, and a search pattern for the object definition, separated by |
is defined, and a search pattern for the object definition, separated by |
|
|
Using the |
Using the |
.Ar tags |
.Ar tags |
file, |
file, |
|
a text editor such as |
.Xr ex 1 |
.Xr ex 1 |
|
or |
|
.Xr vi 1 |
can quickly locate these object definitions. |
can quickly locate these object definitions. |
Depending upon the options provided to |
Indexed objects include subroutines, typedefs, defines, structs, |
.Nm ctags , |
|
objects will consist of subroutines, typedefs, defines, structs, |
|
enums, and unions. |
enums, and unions. |
.Pp |
.Pp |
The options are as follows: |
The options are as follows: |
|
|
.Ar tagsfile . |
.Ar tagsfile . |
The default behaviour is to place them in a file called |
The default behaviour is to place them in a file called |
.Ar tags . |
.Ar tags . |
.It Fl t |
|
Create tags for typedefs, structs, unions, and enums. |
|
.It Fl u |
.It Fl u |
Update the specified files in the |
Update the specified files in the |
.Ar tags |
.Ar tags |
|
|
source files. |
source files. |
Files whose names end in |
Files whose names end in |
.Dq \&.l |
.Dq \&.l |
are assumed to be lisp files if their |
are assumed to be Lisp files if their |
first non-blank character is |
first non-blank character is |
.Ql \&; , |
.Ql \&; , |
.Ql \&( , |
.Ql \&( , |
|
|
though its presence is optional. |
though its presence is optional. |
.Pp |
.Pp |
The flags |
The flags |
.Op Fl BdFtuvw |
.Op Fl BdFuvw |
are extensions to that specification. |
are extensions to that specification. |
.Sh HISTORY |
.Sh HISTORY |
The |
The |