Commit | Line | Data |
---|---|---|
8bf57e52 BJ |
1 | .TH CTAGS 1 8/9/79 |
2 | .UC | |
3 | .SH NAME | |
4 | ctags \- maintain a tags file for a C program | |
5 | .SH SYNOPSIS | |
6 | .B ctags | |
7 | [ | |
8 | .B \-auw | |
9 | ] | |
10 | name ... | |
11 | .SH DESCRIPTION | |
12 | .I Ctags | |
13 | makes a tags file for | |
14 | .IR ex (1) | |
15 | from the specified C programs. | |
16 | A tags file gives the locations of specified objects (in this case | |
17 | functions) in a group of files. | |
18 | Each line of the tags file contains the function name, | |
19 | the file in which it is defined, and a scanning pattern used to find | |
20 | the function definition. These are given in separate fields on the line, | |
21 | separated by blanks or tabs. | |
22 | .PP | |
23 | The | |
24 | .B \-a | |
25 | option causes the output to be appended to the tags file | |
26 | instead of rewriting it. | |
27 | .PP | |
28 | The | |
29 | .B \-u | |
30 | option causes the specified files to be | |
31 | .I updated | |
32 | in tags, that is, all references to them are deleted, | |
33 | and the new values are appended to the file. | |
34 | This option implies the | |
35 | .B \-a | |
36 | option. | |
37 | .PP | |
38 | The | |
39 | .B \-w | |
40 | option suppresses warning diagnostics. | |
41 | .PP | |
42 | The tag | |
43 | .I main | |
44 | is treated specially. | |
45 | The tag formed is created by prepending | |
46 | .I M | |
47 | to the name of the file, with a trailing .c removed, if | |
48 | any, and leading pathname components also removed. | |
49 | This makes use of ctags practical in directories with | |
50 | more than one program. | |
51 | .SH FILES | |
52 | .DT | |
53 | tags output tags file | |
54 | .SH SEE ALSO | |
55 | ex(1), vi(1) | |
56 | .SH BUGS | |
57 | In a directory with only one | |
58 | .I main, | |
59 | the tag | |
60 | .I main | |
61 | will still not be created. |