File: ctags.html

package info (click to toggle)
exuberant-ctags 1%3A5.2.2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 1,060 kB
  • ctags: 2,074
  • sloc: ansic: 14,358; makefile: 150; sh: 59
file content (1933 lines) | stat: -rw-r--r-- 59,100 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
Content-type: text/html

<HTML><HEAD><TITLE>Manpage of CTAGS</TITLE>
</HEAD><BODY>
<H1>CTAGS</H1>
Section: User Commands  (1)<BR>Updated: Version 5.2.2<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>

<P>
<P>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

ctags - Generate tag files for source code
<P>
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<DL COMPACT>
<DT><B>ctags</B> [<B>options</B>] [<I>file(s)</I>]<DD>
<DT><B>etags</B> [<B>options</B>] [<I>file(s)</I>]<DD>
<P>
<P>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

The <B>ctags</B> and <B>etags</B> programs (hereinafter collectively referred to
as <B>ctags</B>, except where distinguished) generate an index (or &quot;tag&quot;) file
for a variety of language objects found in <I>file(s)</I>.
This tag file allows these items to be quickly and easily located by a text
editor or other utility. A &quot;tag&quot; signifies a language object for which an
index entry is available (or, alternatively, the index entry created for that
object).
<P>
Alternatively, <B>ctags</B> can generate a cross reference file which lists, in
human readable form, information about the various source objects found in a
set of language files.
<P>
Tag index files are supported by numerous editors, which allow the user to
locate the object associated with a name appearing in a source file and jump
to the file and line which defines the name. Those known about at the time of
this release are:
<P>
<DL COMPACT><DT><DD>
<B><A HREF="http://localhost/cgi-bin/man/man2html?1+Vi">Vi</A></B>(1) and its derivatives (e.g. Elvis, Vim, Vile, Lemmy),
<B>CRiSP</B>,
<B>Emacs</B>,
<B>FTE</B> (Folding Text Editor),
<B>JED</B>,
<B>NEdit</B> (Nirvana Edit),
<B>TSE</B> (The SemWare Editor),
<B>X2</B>,
<B>Zeus</B>
</DL>

<P>
<B>Ctags</B> is capable of generating different kinds of tags for each of many
different languages. For a complete list of supported languages, the names
by which they are recognized, and the kinds of tags which are generated for
each, see <B>TAG KINDS</B>, below.
<P>
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>SOURCE FILES</H2>

<P>
Unless the <B>--language-force</B> option is specified, the language of each
source file is automatically selected based upon a mapping of file names to
languages. On platforms which support it, if the name of a file is not mapped
to a language and the file is executable, the first line of the file is
checked to see if the file is a &quot;#!&quot; script for a recognized language. File
names are mapped to languages according to the following default mappings
(which may be overridden with the <B>--langmap</B> option):
<P>

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><B>Assembler</B>

<DD>
*.asm *.s *.S
<DT><B>ASP</B>

<DD>
*.asp *.asa
<DT><B>Awk</B>

<DD>
*.awk
<DT><B>C</B>

<DD>
*.c
<DT><B>C++</B>

<DD>
*.C *.c++ *.cc *.cpp *.cxx *.h *.H *.hh *.hpp *.hxx *.h++
<DT><B>BETA</B>

<DD>
*.bet
<DT><B>COBOL</B>

<DD>
*.cob *.COB
<DT><B>Eiffel</B>

<DD>
*.e
<DT><B>Fortran</B>

<DD>
*.f *.for *.ftn *.f77 *.f90 *.f95 *.F *.FOR *.FTN *.F77 *.F90 *.F95
<DT><B>Java</B>

<DD>
*.java
<DT><B>Lisp</B>

<DD>
*.cl *.clisp *.el *.l *.lisp *.lsp *.ml
<DT><B>Lua</B>

<DD>
*.lua
<DT><B>Make</B>

<DD>
*.mak [Mm]akefile*
<DT><B>Pascal</B>

<DD>
*.p *.pas
<DT><B>Perl</B>

<DD>
*.pl *.pm *.perl
<DT><B>PHP</B>

<DD>
*.php *.php3 *.phtml
<DT><B>Python</B>

<DD>
*.py *.python
<DT><B>REXX</B>

<DD>
*.cmd *.rexx *.rx
<DT><B>Ruby</B>

<DD>
*.rb
<DT><B>Scheme</B>

<DD>
*.sch *.scheme *.scm *.sm *.SCM *.SM
<DT><B>Shell scripts (Bourne/Korn/Z)</B>

<DD>
*.sh *.SH *.bsh *.bash *.ksh *.zsh
<DT><B>S-Lang</B>

<DD>
*.sl
<DT><B>Tcl</B>

<DD>
*.tcl *.wish
<DT><B>Vim</B>

<DD>
*.vim
<DT><B>YACC/Bison</B>

<DD>
*.y

</DL>
</DL>

<P>
By default, all other files names are ignored. This permits running
<B>ctags</B> on all files in either a single directory (e.g. &quot;ctags *&quot;), or all
files in an entire source directory tree (e.g. &quot;ctags -R&quot;), since only those
files whose names are mapped to languages will be scanned.
<P>
The reason that .h extensions are mapped to C++ files rather than C files
is because it is common to use .h extensions in C++, and no harm results in
treating them as C++ files.
<P>
<P>
<A NAME="lbAF">&nbsp;</A>
<H2>OPTIONS</H2>

<P>
Despite the wealth of available options, defaults are set so that <B>ctags</B>
is most commonly executed without any options (e.g. &quot;ctags *&quot;, or &quot;ctags -R&quot;),
which will create a tag file in the current directory for all recognized
source files. The options described below are provided merely to allow custom
tailoring to meet special needs.
<P>
Note that spaces separating the single-letter options from their parameters
are optional.
<P>
Note also that the boolean parameters to the long form options (those
beginning with &quot;--&quot; and that take a &quot;<I>[=yes</I>|<I>no]</I>&quot; parameter) may
be omitted, in which case &quot;<B>=</B><I>yes</I>&quot; is implied. (e.g. <B>--sort</B>
is equivalent to <B>--sort</B>=<I>yes</I>). Note further that &quot;=<I>1</I>&quot; and
&quot;=<I>on</I>&quot; are considered synonyms for &quot;=<I>yes</I>&quot;, and that &quot;=<I>0</I>&quot;
and &quot;=<I>off</I>&quot; are considered synonyms for &quot;=<I>no</I>&quot;.
<P>
Some options are either ignored or useful only when used while running in
etags mode (see <B>-e</B> option). Such options will be noted.
<P>
Most options may appear anywhere on the command line, affecting only those
files which follow the option. A few options, however, must appear before the
first file name and will be noted as such.
<P>
Options taking language names will accept those names in either upper or lower
case. See <B>TAG KINDS</B> for a complete list of the built-in language names.
<P>
<DL COMPACT>
<DT><B>-a</B>

<DD>
Equivalent to <B>--append</B>.
<P>
<DT><B>-B</B>

<DD>
Use backward searching patterns (e.g. ?pattern?). [Ignored in etags mode]
<P>
<DT><B>-e</B>

<DD>
Enable etags mode, which will create a tag file for use with the Emacs editor.
Alternatively, if <B>ctags</B> is invoked by a name containing the string
&quot;etags&quot; (either by renaming, or creating a link to, the executable), etags
mode will be enabled. This option must appear before the first file name.
<P>
<DT><B>-f</B><I> tagfile</I>

<DD>
Use the name specified by <I>tagfile</I> for the tag file (default is &quot;tags&quot;,
or &quot;TAGS&quot; when running in etags mode). If <I>tagfile</I> is specified as
&quot;-&quot;, then the tag file is written to standard output instead. <B>Ctags</B>
will stubbornly refuse to take orders if <I>tagfile</I> exists and its first
line contains something other than a valid tags line. This will save your neck
if you mistakenly type &quot;ctags -f *.c&quot;, which would otherwise overwrite your
first C file with the tags generated by the rest! It will also refuse to
accept a multicharacter file name which begins with a '-' (dash) character,
since this most likely means that you left out the tag file name and this
option tried to grab the next option as the file name. If you really want to
name your output tag file &quot;-ugly&quot;, specify it as &quot;./-ugly&quot;. This option must
appear before the first file name. If this option is specified more than once,
only the last will apply.
<P>
<DT><B>-F</B>

<DD>
Use forward searching patterns (e.g. /pattern/) (default).
[Ignored in etags mode]
<P>
<DT><B>-h</B><I> list</I>

<DD>
Specifies a list of file extensions, separated by periods, which are to be
interpreted as include (or header) files. To indicate files having no
extension, use a period not followed by a non-period character (e.g. &quot;.&quot;,
&quot;..x&quot;, &quot;.x.&quot;). This option only affects how the scoping of a particular kinds
of tags is interpreted (i.e. whether or not they are considered as globally
visible or visible only within the file in which they are defined); it does
not map the extension to any particular language. Any tag which is located in
a non-include file and cannot be seen (e.g. linked to) from another file is
considered to have file-limited (e.g. static) scope. No kind of tag appearing
in an include file will be considered to have file-limited scope. If the first
character in the list is a plus sign, then the extensions in the list will be
appended to the current list; otherwise, the list will replace the current
list. See, also, the <B>--file-scope</B> option. The default list is
&quot;.h.H.hh.hpp.hxx.h++.inc.def&quot;. To restore the default list, specify <B>-h</B>
<I>default</I>. Note that if an extension supplied to this option is not
already mapped to a particular language (see <B>SOURCE FILES</B>, above), you
will also need to use either the <B>--langmap</B> or <B>--language-force</B>
option.
<P>
<DT><B>-I</B><I> tokenlist</I>

<DD>
Specifies a list of tokens which are to be specially handled while parsing C
and C++ source files. This option is specifically provided to handle special
cases arising through the use of preprocessor macros. When the tokens listed
are simple tokens, these tokens will be ignored during parsing of the source
files. If a token is suffixed with a '+' character, <B>ctags</B> will also
ignore any parenthesis-enclosed argument list which may immediately follow the
token in the source files. If two tokens are separated with the '=' character,
the first token is replaced by the second token for parsing purposes. The list
of tokens may be supplied directly on the command line or read in from a
separate file. If the first character of <I>tokenlist</I> is '@', '.' or a
pathname separator ('/' or '\'), or the first two characters specify a drive
letter (e.g. &quot;C:&quot;), the parameter <I>tokenlist</I> will be interpreted as a
filename from which to read a list of tokens, one per input line.
Otherwise, <I>tokenlist</I> is a list of tokens (or token pairs) to be
specially handled, each delimited by a either a comma or by white space (in
which case the list should be quoted to keep the entire list as one command
line argument). Multiple <B>-I</B> options may be supplied. To clear the list
of ignore tokens, supply a single dash (&quot;-&quot;) for <I>tokenlist</I>.
<P>
This feature is useful when preprocessor macros are used in such a way that
they cause syntactic confusion due to their presence. Indeed, this is the best
way of working around a number of problems caused by the presence of
syntax-busting macros in source files (see <B>BUGS</B>, below). Some examples
will illustrate this point.
<P>
<DL COMPACT><DT><DD>
int foo ARGDECL4(void *, ptr, long int, nbytes)
</DL>

<P>
<DT><DD>
In the above example, the macro &quot;ARGDECL4&quot; would be mistakenly interpreted to
be the name of the function instead of the correct name of &quot;foo&quot;. Specifying
<B>-I</B> <I>ARGDECL4</I> results in the correct behavior.
<P>
<DL COMPACT><DT><DD>
/* creates an RCS version string in module */
<BR>

MODULE_VERSION(&quot;$Revision: 1.10 $&quot;)
</DL>

<P>
<DT><DD>
In the above example the macro invocation looks too much like a function
definition because it is not followed by a semicolon (indeed, it could even be
followed by a global variable definition that would look much like a K&amp;R style
function parameter declaration). In fact, this seeming function definition
could possibly even cause the rest of the file to be skipped over while trying
to complete the definition. Specifying <B>-I</B> <I>MODULE_VERSION+</I> would
avoid such a problem.
<P>
<DL COMPACT><DT><DD>
CLASS Example {
<BR>

<BR>&nbsp;&nbsp;&nbsp;&nbsp;//&nbsp;your&nbsp;content&nbsp;here
<BR>

};
</DL>

<P>
<DT><DD>
The example above uses &quot;CLASS&quot; as a preprocessor macro which expands to
something different for each platform. For instance CLASS may be defined as
&quot;class __declspec(dllexport)&quot; on Win32 platforms and simply &quot;class&quot; on UNIX.
Normally, the absence of the C++ keyword &quot;class&quot; would cause the source file
to be incorrectly parsed. Correct behavior can be restored by specifying
<B>-I</B> <I>CLASS=class</I>.
<P>
<DT><B>-L</B><I> file</I>

<DD>
Read from <I>file</I> a list of file names for which tags should be generated.
If <I>file</I> is specified as &quot;-&quot;, then file names are read from standard
input. File names read using this option are processed following file names
appearing on the command line. Options all also accepted in this input. If
this option is specified more than once, only the last will apply. <B>Note:</B>
<I>file</I> is read in line-oriented mode, where a new line is the only
delimiter and spaces are considered significant, in order that file names
containing spaces may be supplied; this can affect how options are parsed if
included in the input.
<P>
<DT><B>-n</B>

<DD>
Equivalent to <B>--excmd</B>=<I>number</I>.
<P>
<DT><B>-N</B>

<DD>
Equivalent to <B>--excmd</B>=<I>pattern</I>.
<P>
<DT><B>-o</B><I> tagfile</I>

<DD>
Equivalent to <B>-f</B> <I>tagfile</I>.
<P>
<DT><B>-R</B>

<DD>
Equivalent to <B>--recurse</B>.
<P>
<DT><B>-u</B>

<DD>
Equivalent to <B>--sort</B>=<I>no</I> (i.e. &quot;unsorted&quot;).
<P>
<DT><B>-V</B>

<DD>
Equivalent to <B>--verbose</B>.
<P>
<DT><B>-w</B>

<DD>
This option is silently ignored for backwards compatibility with the ctags
of SVR4 Unix.
<P>
<DT><B>-x</B>

<DD>
Print a tabular, human-readable cross reference (xref) file to standard output
instead of generating a tag file. The information contained in the output
includes: the tag name; the kind of tag; the line number, file name, and
source line (with extra white space condensed) of the file which defines the
tag. No tag file is written and all options affecting tag file output will be
ignored. Example applications for this feature are generating a listing of all
functions located in a source file (e.g. <B>ctags -x --c-types</B>=<I>f</I>
<I>file</I>), or generating a list of all externally visible global variables
located in a source file (e.g. <B>ctags -x --c-types</B>=<I>v</I>
<B>--file-scope</B>=<I>no file</I>). This option must appear before the first
file name.
<P>
<DT><B>--append</B>[=<I>yes</I>|<I>no</I>]<DD>
Indicates whether tags generated from the specified files should be appended
to those already present in the tag file or should replace them. This option
is off by default. This option must appear before the first file name.
[Ignored in etags mode]
<P>
<DT><B>--etags-include</B>=<I>file</I><DD>
Include a reference to <I>file</I> in the tag file. This option may be
specified as many times as desired. This supports Emacs' capability to use a
tag file which &quot;includes&quot; other tag files. [Used only in etags mode]
<P>
<DT><B>--exclude</B>=[<I>pattern</I>]<DD>
Add <I>pattern</I> to a list of excluded files and directories. This option
may be specified as many times as desired. For each file name considered by
<B>ctags</B>, each <I>pattern</I> specified using this option will be compared
against both the complete path (e.g. some/path/base.ext) and the base name
(e.g. base.ext) of the file, thus allowing patterns which match a given file
name irrespective of its path, or match only a specific path. If appropriate
support is available from the runtime library of your C compiler, then
<I>pattern</I> may contain the usual shell wildcards (not regular expressions)
common on Unix (be sure to quote the option parameter to protect the wildcards
from being expanded by the shell before being passed to <B>ctags</B>; also be
aware that wildcards can match the slash character, '/'). You can determine if
shell wildcards are available on your platfom by examining the output of the
<B>--version</B> option, which will include &quot;+wildcards&quot; in the compiled
feature list; otherwise, <I>pattern</I> is matched against file names using a
simple textual comparison.
<P>
If <I>pattern</I> begins with the character '@', then the rest of the string
is interpreted as a file name from which to read exclusion patterns, one per
line. If <I>pattern</I> is empty, the list of excluded patterns is cleared.
Note that at program startup, the default exclude list contains &quot;EIFGEN&quot;,
&quot;SCCS&quot;, &quot;RCS&quot;, and &quot;CVS&quot;, which are names of directories for which it is
generally not desirable to descend while processing the <B>--recurse</B>
option.
<P>
<DT><B>--excmd</B>=<I>type</I><DD>
Determines the type of EX command used to locate tags in the source file.
[Ignored in etags mode]
<P>
The valid values for <I>type</I> (either the entire word or the first letter is
accepted) are:
<P>
<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><I>number</I>

<DD>
Use only line numbers in the tag file for locating tags. This has four
advantages:

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT>1.<DD>
Significantly reduces the size of the resulting tag file.
<DT>2.<DD>
Eliminates failures to find tags because the line defining the tag has
changed, causing the pattern match to fail (note that some editors, such as
<B>vim</B>, are able to recover in many such instances).
<DT>3.<DD>
Eliminates finding identical matching, but incorrect, source lines (see
<B>BUGS</B>, below).
<DT>4.<DD>
Retains separate entries in the tag file for lines which are identical in
content. In <I>pattern</I> mode, duplicate entries are dropped because the
search patterns they generate are identical, making the duplicate entries
useless.
</DL>
</DL>


<P>
<DT><DD>
However, this option has one significant drawback: changes to the source files
can cause the line numbers recorded in the tag file to no longer correspond
to the lines in the source file, causing jumps to some tags to miss the target
definition by one or more lines. Basically, this option is best used when the
source code to which it is applied is not subject to change. Selecting this
option type causes the following options to be ignored: <B>-BF</B>.
<P>
<DT><I>pattern</I>

<DD>
Use only search patterns for all tags, rather than the line numbers usually
used for macro definitions. This has the advantage of not referencing obsolete
line numbers when lines have been added or removed since the tag file was
generated.
<P>
<DT><I>mixed</I>

<DD>
In this mode, patterns are generally used with a few exceptions. For C, line
numbers are used for macro definition tags. This was the default format
generated by the original <B>ctags</B> and is, therefore, retained as the
default for this option. For Fortran, line numbers are used for common blocks
because their corresponding source lines are generally identical, making
pattern searches useless for finding all matches.
</DL>
</DL>

<P>
<DT><B>--extra</B>=<I>[+|-]flags</I><DD>
Specifies whether to include extra tag entries for certain kinds of
information. The parameter <I>flags</I> is a set of one-letter flags, each
representing one kind of extra tag entry to include in the tag file. If
<I>flags</I> is preceded by by either the '+' or '-' character, the effect of
each flag is added to, or removed from, those currently enabled; otherwise the
flags replace any current settings. The meaning of each flag is as follows:
<P>
</DL>
<P>

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><I>f</I>

<DD>
Include an entry for the base file name of every source file (e.g.
&quot;example.c&quot;), which addresses the first line of the file.
<DT><I>q</I>

<DD>
Include an extra class-qualified tag entry for each tag which is a member
of a class (for languages for which this information is extracted; currently
C++, Eiffel, and Java). The actual form of the qualified tag depends upon the
language from which the tag was derived (using a form that is most natural for
how qualified calls are specified in the language). For C++, it is in the form
&quot;class::member&quot;; for Eiffel and Java, it is in the form &quot;class.member&quot;. This
may allow easier location of a specific tags when multiple occurrances of a
tag name occur in the tag file. Note, however, that this could potentially
more than double the size of the tag file.
</DL>
</DL>

<P>
<DL COMPACT>
<DT><B>--fields</B>=<I>[+|-]flags</I><DD>
Specifies the available extension fields which are to be included in the
entries of the tag file (see <B>TAG FILE FORMAT</B>, below, for more
information). The parameter <I>flags</I> is a set of one-letter flags, each
representing one type of extension field to include, with the following
meanings (disabled by default unless indicated):
<P>
</DL>
<P>


<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><I>a</I>

<DD>
Access (or export) of class members
<DT><I>f</I>

<DD>
File-restricted scoping [enabled]
<DT><I>i</I>

<DD>
Inheritance information
<DT><I>k</I>

<DD>
Kind of tag as a single letter [enabled]
<DT><I>K</I>

<DD>
Kind of tag as full name
<DT><I>l</I>

<DD>
Language of source file containing tag
<DT><I>m</I>

<DD>
Implementation information
<DT><I>n</I>

<DD>
Line number of tag definintion
<DT><I>s</I>

<DD>
Scope of tag definition [enabled]
<DT><I>z</I>

<DD>
Include the &quot;kind:&quot; key in kind field

</DL>
</DL>

<P>
<DL COMPACT><DT><DD>
Each letter or group of letters may be preceded by either '+' to add it to the
default set, or '-' to exclude it. In the absence of any preceding '+' or '-'
sign, only those kinds explicitly listed in <I>flags</I> will be included in
the output (i.e. overriding the default set). This option is ignored if the
option <B>--format</B>=<I>1</I> has been specified.
</DL>

<P>
<DL COMPACT>
<DT><B>--file-scope</B>[=<I>yes</I>|<I>no</I>]<DD>
Indicates whether tags scoped only for a single file (i.e. tags which cannot
be seen outside of the file in which they are defined, such as &quot;static&quot; tags)
should be included in the output. See, also, the <B>-h</B> option. This option
is enabled by default.
<P>
<DT><B>--filter</B>[=<I>yes</I>|<I>no</I>]<DD>
Causes <B>ctags</B> to behave as a filter, reading source file names from
standard input and printing their tags to standard output on a file-by-file
basis. If <B>--sorted</B> is enabled, tags are sorted only within the source
file in which they are defined. File names are read from standard output in
line-oriented input mode (see note for <B>-L</B> option) and only after file
names listed on the command line or from any file supplied using the <B>-L</B>
option. When this option is enabled, the options <B>-f</B>, <B>-o</B>,
and <B>--totals</B> are ignored. This option is quite esoteric and is disabled
by default. This option must appear before the first file name.
<P>
<DT><B>--filter-terminator</B>=<I>string</I><DD>
Specifies a string to print to standard output following the tags for each
file name parsed when the <B>--filter</B> option is enabled. This may permit an
application reading the output of ctags to determine when the output for each
file is finished. Note that if the file name read is a directory and
<B>--recurse</B> is enabled, this string will be printed only one once at the
end of all tags found for by descending the directory. This string will always
be separated from the last tag line for the file by its terminating newline.
This option is quite esoteric and is empty by default. This option must appear
before the first file name.
<P>
<DT><B>--format</B>=<I>level</I><DD>
Change the format of the output tag file. Currently the only valid values for
<I>level</I> are <I>1</I> or <I>2</I>. Level 1 specifies the original tag file
format and level 2 specifies a new extended format containing extension fields
(but in a manner which retains backward compatibility with original
<B><A HREF="http://localhost/cgi-bin/man/man2html?1+vi">vi</A></B>(1) implementations). The default level is 2. This option must appear
before the first file name. [Ignored in etags mode]
<P>
<DT><B>--help</B>

<DD>
Prints to standard output a detailed usage description.
<P>
<DT><B>--if0</B>[=<I>yes</I>|<I>no</I>]<DD>
Indicates a preference as to whether code within an &quot;#if 0&quot; branch of a
preprocessor conditional should be examined for non-macro tags (macro tags are
always included). Because the intent of this construct is to disable code, the
default value of this options is <I>no</I>. Note that this indicates a
preference only and does not guarantee skipping code within an &quot;#if 0&quot; branch,
since the fall-back algorithm used to generate tags when preprocessor
conditionals are too complex follows all branches of a conditional. This
option is disabled by default.
<P>
<DT><B>--&lt;LANG&gt;-types</B>=<I>[+|-]kinds</I><DD>
Specifies a list of language-specific kinds of tags (or kinds) to include in
the output file for a particular language, where <B>&lt;LANG&gt;</B> is one of the
built-in language names (see <B>TAG KINDS</B>, below, for a complete list). The
parameter <I>kinds</I> is a group of one-letter flags designating kinds of tags
(particular to the language) to either include or exclude from the output. The
specific sets of flags recognized for each language, their meanings and
defaults is described in <B>TAG KINDS</B>, below. Each letter or group of
letters may be preceded by either '+' to add it to the default set, or '-' to
exclude it. In the absence of any preceding '+' or '-' sign, only those kinds
explicitly listed in <I>kinds</I> will be included in the output (i.e.
overriding the default for the specified language).
<P>
As an example for the C language, in order to add prototypes and external
variable declarations to the default set of tag kinds, but exclude macros,
use <B>--c-types</B>=<I>+px-d</I>; to include only tags for functions, use
<B>--c-types</B>=<I>f</I>.
<P>
<DT><B>--langdef</B>=<I>name</I><DD>
Defines a new user-defined language, <I>name</I>, to be parsed with regular
expressions. Once defined, <I>name</I> may be used in other options taking
language names. The typical use of this option is to first define the
language, then map file names to it using <I>--langmap</I>, then specify
regular expressions using <I>--regex-&lt;LANG&gt;</I> to define how its tags are
found.
<P>
<DT><B>--langmap</B>=<I>map[,map[...]]</I><DD>
Controls how file names are mapped to languages (see <B>SOURCE FILES</B>,
above). Each comma-separated <I>map</I> consists of the language name (either
a built-in or user-defined language), a colon, and a list of file extensions
and/or file name patterns. A file extension is specified by preceding the
extension with a period (e.g. &quot;.c&quot;). A file name pattern is specified by
enclosing the pattern in parentheses (e.g. &quot;([Mm]akefile)&quot;). If appropriate
support is available from the runtime library of your C compiler, then the
file name pattern may contain the usual shell wildcards common on Unix (be
sure to quote the option parameter to protect the wildcards from being
expanded by the shell before being passed to <B>ctags</B>). You can determine
if shell wildcards are available on your platfom by examining the output of
the <B>--version</B> option, which will include &quot;+wildcards&quot; in the compiled
feature list; otherwise, the file name patterns are matched against file names
using a simple textual comparison.
<P>
If the first character in a map is a plus sign, then the extensions and file
name patterns in that map will be appended to the current map for that
language; otherwise, the map will replace the current map. For example, to
specify that only files with extensions of .c and .x are to be treated as C
language files, use &quot;<B>--langmap</B>=<I>c:.c.x</I>&quot;; to also add files with
extensions of .j as Java language files, specify
&quot;<B>--langmap</B>=<I>c:.c.x,java:+.j</I>&quot;. To map makefiles (.e.g files
named either &quot;Makefile&quot;, &quot;makefile&quot;, or having the extension &quot;.mak&quot;) to a
language called &quot;make&quot;, specify &quot;<B>--langmap</B>=<I>make:([Mm]akefile).mak</I>&quot;.
To map files having no extension, specify a period not followed by a
non-period character (e.g. &quot;.&quot;, &quot;..x&quot;, &quot;.x.&quot;). To clear the mapping for a
particular language (thus inhibiting automatic generation of tags for that
language), specify an empty extension list (e.g.
&quot;<B>--langmap</B>=<I>fortran:</I>&quot;). To restore the default language mappings
for all a particular language, supply the keyword &quot;default&quot; for the mapping.
To specify restore the default language mappings for all languages, specify
&quot;<B>--langmap</B>=<I>default</I>&quot;. Note that file extensions are tested before
file name patterns when inferring the language of a file.
<P>
<DT><B>--language-force</B>=<I>language</I><DD>
By default, <B>ctags</B> automatically selects the language of a source file,
ignoring those files whose language cannot be determined (see
<B>SOURCE FILES</B>, above). This option forces the specified <I>language</I>
(either built-in or user-defined) to be used for every supplied file instead
of automatically selecting the language based upon its extension. In addition,
the special value <I>auto</I> indicates that the language should be
automatically selected (which effectively disables this option).
<P>
<DT><B>--languages</B>=<I>[+|-]list</I><DD>
Specifies the languages for which tag generation is enabled, with <I>list</I>
containing a comma-separated list of language names (either built-in or
user-defined). If the first language of <I>list</I> is not preceded by either a

languages in <I>list</I>. Until a '-' is encountered, each language in the list
will be added to the current list. As either the '+' or '-' is encountered in
the list, the languages following it are added or removed from the current
list, respectively. Thus, it becomes simple to replace the current list with a
new one, or to add or remove languages from the current list. The actual list
of files for which tags will be generated depends upon the language extension
mapping in effect (see the <B>--langmap</B> option). Note that all languages,
including user-defined languages are enabled unless explicitly disabled using
this option. Language names included in <I>list</I> may be any built-in
language or one previously defined with <B>--langdef</B>. The default is &quot;all&quot;,
which is also accepted as a valid argument. See <B>TAG KINDS</B> for a complete
list of the built-in language names.
<P>
<DT><B>--license</B><DD>
Prints a summary of the software license to standard output.
<P>
<DT><B>--line-directives</B>[=<I>yes</I>|<I>no</I>]<DD>
Specifies whether &quot;#line&quot; directives should be recognized. These are present
in the output of preprocessors and contain the line number, and possibly the
file name, of the original source file(s) from which the preprocessor output
file was generated. When enabled, this option will cause <B>ctags</B> to
generate tag entries marked with the file names and line numbers of their
locations original source file(s), instead of their actual locations in the
preprocessor output. The actual file names placed into the tag file will have
the same leading path components as the preprocessor output file, since it is
assumed that the original source files are located relative to the
preprocessor output file (unless, of course, the #line directive specifies an
absolute path). This option is off by default. <B>Note:</B> This option is
generally only useful when used together with the <B>--excmd</B>=<I>number</I>
(<B>-n</B>) option. Also, you may have to use either the <B>--langmap</B> or
<B>--language-force</B> option if the extension of the preprocessor output file
is not known to <B>ctags</B>.
<P>
<DT><B>--links</B>[=<I>yes</I>|<I>no</I>]<DD>
Indicates whether symbolic links (if supported) should be followed. When
disabled, symbolic links are ignored. This option is on by default.
<P>
<DT><B>--options</B>=<I>file</I><DD>
Read additional options from <I>file</I>.
<P>
<DT><B>--recurse</B>[=<I>yes</I>|<I>no</I>]<DD>
Recurse into directories encountered in the list of supplied files. If the
list of supplied files is empty and no file list is specified with the
<B>-L</B> option, then the current directory (i.e. &quot;.&quot;) is assumed. Symbolic
links are followed. If you don't like these behaviors, either explicitly
specify the files or pipe the output of <B><A HREF="http://localhost/cgi-bin/man/man2html?1+find">find</A></B>(1) into <B>ctags -L-</B>
instead. <B>Note:</B> This option is not supported on all platforms at present.
It is available if the output of the <B>--help</B> option includes this option.
See, also, the <B>--exclude</B> to limit recursion.
<P>
<DT><B>--regex-&lt;LANG&gt;</B>=<I>/regexp/replacement/[kind-spec/][flags]</I><DD>
The <I>/regexp/replacement/</I> pair define a regular expression replacement
pattern, similar in style to <B>sed</B> substitution commands, with which to
generate tags from source files mapped to the named language, <B>&lt;LANG&gt;</B>,
(either a built-in or user-defined language). The regular expression,
<I>regexp</I>, defines an extended regular expression (roughly that used by
<B><A HREF="http://localhost/cgi-bin/man/man2html?1+egrep">egrep</A></B>(1)), which is used to locate a single source line containing a tag
and may specify tab characters using \t. When a matching line is found, a tag
will be generated for the name defined by <I>replacement</I>, which generally
will contain the special back-references \1 through \9 to refer to matching
sub-expression groups within <I>regexp</I>. The '/' separator characters shown
in the parameter to the option can actually be replaced by any character. Note
that whichever separator character is used will have to be escaped with a
backslash ('\') character wherever it is used in the parameter as something
other than a separator. The regular expression defined by this option is added
to the current list of regular expressions for the specified language unless
the parameter is omitted, in which case the current list is cleared.
<P>
Unless modified by <I>flags</I>, <I>regexp</I> is interpreted as a Posix
extended regular expression. The <I>replacement</I> should expand for all
matching lines to a non-empty string of characters, or a warning message will
be reported. An optional kind specifier for tags matching <I>regexp</I> may
follow <I>replacement</I>, which will determine what kind of tag is reported in
the &quot;kind&quot; extension field (see <B>TAG FILE FORMAT</B>, below). The
<I>kind-spec</I> is expected to be in the form of a single letter, a comma, and
a name followed by a separator, which specify the short and long forms of the
kind value. If <I>kind-spec</I> is omitted, it defaults to &quot;<I>r,regex</I>&quot;.
Finally, <I>flags</I> are one or more single-letter characters having the
following effect upon the interpretation of <I>regexp</I>:
<P>
</DL>
<P>

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT><I>b</I>

<DD>
The pattern is interpreted as a Posix basic regular expression.
<DT><I>e</I>

<DD>
The pattern is interpreted as a Posix extended regular expression (default).
<DT><I>i</I>

<DD>
The regular expression is to be applied in a case-insensitive manner.
</DL>
</DL>

<P>
<DL COMPACT><DT><DD>
Note that this option is available only if <B>ctags</B> was compiled with
support for regular expressions, which depends upon your platform. You can
determine if support for regular expressions is compiled in by examining the
output of the <B>--version</B> option, which will include &quot;+regex&quot; in the
compiled feature list.
<P>
For more information on the regular expressionss used by <B>ctags</B>, see
either the <B>regex(5,7)</B> man page, or the GNU info documentation for regex
(e.g. &quot;info regex&quot;).
</DL>

<P>
<DL COMPACT>
<DT><B>--sort</B>[=<I>yes</I>|<I>no</I>]<DD>
Indicates whether the tag file should be sorted on the tag name (default is
<I>yes</I>). Note that the original <B><A HREF="http://localhost/cgi-bin/man/man2html?1+vi">vi</A></B>(1) requires sorted tags. This
option is on by default. This option must appear before the first file name.
[Ignored in etags mode]
<P>
<DT><B>--tag-relative</B>[=<I>yes</I>|<I>no</I>]<DD>
Indicates that the file paths recorded in the tag file should be relative to
the directory containing the tag file, rather than relative to the current
directory, unless the files supplied on the command line are specified with
absolute paths. This option must appear before the first file name. The
default is <I>yes</I> when running in etags mode (see the <B>-e</B>
option), <I>no</I> otherwise.
<P>
<DT><B>--totals</B>[=<I>yes</I>|<I>no</I>]<DD>
Prints statistics about the source files read and the tag file written during
the current invocation of <B>ctags</B>. This option is off by default.
This option must appear before the first file name.
<P>
<DT><B>--verbose</B>[=<I>yes</I>|<I>no</I>]<DD>
Enable verbose mode. This prints out information on option processing and a
brief message describing what action is being taken for each file considered
by <B>ctags</B>. Normally, <B>ctags</B> does not read command line arguments
until after options are read from the configuration files (see <B>FILES</B>,
below) and the <B>CTAGS</B> environment variable. However, if this option is
the first argument on the command line, it will take effect before any options
are read from these sources. The default is <I>no</I>.
<P>
<DT><B>--version</B><DD>
Prints a version identifier for <B>ctags</B> to standard output. This is
guaranteed to always contain the string &quot;Exuberant Ctags&quot;.
<P>
<P>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>TAG KINDS</H2>

Each type (or kind) of tag recorded in the tag file is indicated by a
one-letter flag, which is also used to filter the tags placed into the output
through use of the <B>--&lt;LANG&gt;-type</B> option. The flags corresponding to each
tag kind for each langauge are described below. Note that some languages
and/or tag kinds may be implemented using regular expressions and may not be
available if regex support is not compiled into <B>ctags</B> (see the
<B>--regex-&lt;LANG&gt;</B> option). Kinds are enabled by default
except where noted (with &quot;[off]&quot;).
<P>
<DL COMPACT>
<DT>Asm<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>d</I>

<DD>
defines
<DT><I>l</I>

<DD>
labels
<DT><I>m</I>

<DD>
macros
</DL>
</DL>



<P>
<DT>ASP<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
<DT><I>s</I>

<DD>
subroutines
</DL>
</DL>



<P>
<DT>Awk<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
</DL>
</DL>



<P>
<DT>BETA<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
fragment definitions
<DT><I>p</I>

<DD>
all patterns [off]
<DT><I>s</I>

<DD>
slots (fragment uses)
<DT><I>v</I>

<DD>
patterns (only virtual or rebound patterns are recorded)
</DL>
</DL>



<P>
<DT>C and C++<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>c</I>

<DD>
classes
<DT><I>d</I>

<DD>
macro definitions (and #undef names)
<DT><I>e</I>

<DD>
enumerators
<DT><I>f</I>

<DD>
function definitions
<DT><I>g</I>

<DD>
enumeration names
<DT><I>m</I>

<DD>
class, struct, or union members
<DT><I>n</I>

<DD>
namespaces
<DT><I>p</I>

<DD>
function prototypes and declarations [off]
<DT><I>s</I>

<DD>
structure names
<DT><I>t</I>

<DD>
typedefs
<DT><I>u</I>

<DD>
union names
<DT><I>v</I>

<DD>
variable definitions
<DT><I>x</I>

<DD>
extern and forward variable declarations [off]
</DL>
</DL>


<P>
<DT>Cobol<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>p</I>

<DD>
paragraphs
</DL>
</DL>



<P>
<DT>Eiffel<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>c</I>

<DD>
classes
<DT><I>f</I>

<DD>
features
<DT><I>l</I>

<DD>
local entities [off]
</DL>
</DL>



<P>
<DT>Fortran<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>b</I>

<DD>
block data
<DT><I>c</I>

<DD>
common blocks
<DT><I>e</I>

<DD>
entry points
<DT><I>f</I>

<DD>
functions
<DT><I>i</I>

<DD>
interfaces
<DT><I>k</I>

<DD>
type components
<DT><I>l</I>

<DD>
labels
<DT><I>L</I>

<DD>
local and common block variables [off]
<DT><I>m</I>

<DD>
modules
<DT><I>n</I>

<DD>
namelists
<DT><I>p</I>

<DD>
programs
<DT><I>s</I>

<DD>
subroutines
<DT><I>t</I>

<DD>
derived types
<DT><I>v</I>

<DD>
module variables
</DL>
</DL>



<P>
<DT>Java<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>c</I>

<DD>
classes
<DT><I>f</I>

<DD>
fields
<DT><I>i</I>

<DD>
interfaces
<DT><I>m</I>

<DD>
methods
<DT><I>p</I>

<DD>
packages
</DL>
</DL>



<P>
<DT>Lisp<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
</DL>
</DL>



<P>
<DT>Lua<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
</DL>
</DL>



<P>
<DT>Make<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>m</I>

<DD>
macros
</DL>
</DL>



<P>
<DT>Pascal<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
<DT><I>p</I>

<DD>
procedures
</DL>
</DL>



<P>
<DT>Perl<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>p</I>

<DD>
packages
<DT><I>s</I>

<DD>
subroutines
</DL>
</DL>



<P>
<DT>PHP<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>c</I>

<DD>
classes
<DT><I>f</I>

<DD>
functions
</DL>
</DL>



<P>
<DT>Python<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>c</I>

<DD>
classes
<DT><I>f</I>

<DD>
functions
</DL>
</DL>



<P>
<DT>REXX<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>s</I>

<DD>
subroutines
</DL>
</DL>



<P>
<DT>Ruby<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>c</I>

<DD>
classes
<DT><I>f</I>

<DD>
functions
<DT><I>m</I>

<DD>
mixins
</DL>
</DL>



<P>
<DT>Scheme<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
<DT><I>s</I>

<DD>
sets
</DL>
</DL>



<P>
<DT>Sh (Bourne, Korn, Z)<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
</DL>
</DL>



<P>
<DT>SLang<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
<DT><I>n</I>

<DD>
namespaces
</DL>
</DL>



<P>
<DT>Tcl<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>p</I>

<DD>
procedures
</DL>
</DL>



<P>
<DT>Vim<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>f</I>

<DD>
functions
</DL>
</DL>



<P>
<DT>YACC<DD>
<DL COMPACT><DT><DD>

<DL COMPACT>
<DT><I>l</I>

<DD>
labels
</DL>
</DL>



<P>
<P>
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>OPERATIONAL DETAILS</H2>

<P>
As <B>ctags</B> considers each file name in turn, it tries to determine the
language of the file by applying the following three tests in order: if the
file extension has been mapped to a language, if the file name matches a shell
pattern mapped to a language, and finally if the file is executable and its
first line specifies an interpreter using the Unix-style &quot;#!&quot; specification
(if supported on the platform). If a language was identified, the file is
opened and then the appropriate language parser is called to operate on the
currently open file. The parser parses through the file and adds an entry to
the tag file for each language object it is written to handle. See
<B>TAG FILE FORMAT</B>, below, for details on these entries.
<P>
This implementation of <B>ctags</B> imposes no formatting requirements on C
code as do legacy implementations. Older implementations of ctags tended to
rely upon certain formatting assumptions in order to help it resolve coding
dilemmas caused by preprocessor conditionals.
<P>
In general, <B>ctags</B> tries to be smart about conditional preprocessor
directives. If a preprocessor conditional is encountered within a statement
which defines a tag, <B>ctags</B> follows only the first branch of that
conditional (except in the special case of &quot;#if 0&quot;, in which case it follows
only the last branch). The reason for this is that failing to pursue only one
branch can result in ambiguous syntax, as in the following example:
<P>
<DL COMPACT><DT><DD>
#ifdef TWO_ALTERNATIVES
<BR>

struct {
<BR>

#else
<BR>

union {
<BR>

#endif
<DL COMPACT><DT><DD>
short a;
<BR>

long b;
</DL>

}
</DL>

<P>
Both branches cannot be followed, or braces become unbalanced and <B>ctags</B>
would be unable to make sense of the syntax.
<P>
If the application of this heuristic fails to properly parse a file,
generally due to complicated and inconsistent pairing within the conditionals,
<B>ctags</B> will retry the file using a different heuristic which does not
selectively follow conditional preprocessor branches, but instead falls back
to relying upon a closing brace (&quot;}&quot;) in column 1 as indicating the end of a
block once any brace imbalance results from following a #if conditional branch.
<P>
<B>Ctags</B> will also try to specially handle arguments lists enclosed in
double sets of parentheses in order to accept the following conditional
construct:
<P>
<DL COMPACT><DT><DD>
extern void foo __ARGS((int one, char two));
</DL>

<P>
Any name immediately preceding the &quot;((&quot; will be automatically ignored and
the previous name will be used.
<P>
C++ operator definitions are specially handled. In order for consistency with
all types of operators (overloaded and conversion), the operator name in the
tag file will always be preceded by the string &quot;operator &quot; (i.e. even if the
actual operator definition was written as &quot;operator&lt;&lt;&quot;).
<P>
After creating or appending to the tag file, it is sorted by the tag name,
removing identical tag lines.
<P>
<P>
<A NAME="lbAI">&nbsp;</A>
<H2>TAG FILE FORMAT</H2>

<P>
When not running in etags mode, each entry in the tag file consists of a
separate line, each looking like this in the most general case:
<P>
<DL COMPACT><DT><DD>
tag_name&lt;TAB&gt;file_name&lt;TAB&gt;ex_cmd;&quot;&lt;TAB&gt;extension_fields
</DL>

<P>
The fields and separators of these lines are specified as follows:
<P>

<DL COMPACT><DT><DD>
<DL COMPACT>
<DT>1.<DD>
tag name
<DT>2.<DD>
single tab character
<DT>3.<DD>
name of the file in which the object associated with the tag is located
<DT>4.<DD>
single tab character
<DT>5.<DD>
EX command used to locate the tag within the file; generally a search pattern
(either /pattern/ or ?pattern?) or line number (see <B>--excmd</B>). Tag file
format 2 (see <B>--format</B>) extends this EX command under certain
circumstances to include a set of extension fields (described below) embedded
in an EX comment immediately appended to the EX command, which leaves it
backwards compatible with original <B><A HREF="http://localhost/cgi-bin/man/man2html?1+vi">vi</A></B>(1) implementations.
</DL>
</DL>


<P>
A few special tags are written into the tag file for internal purposes. These
tags are composed in such a way that they always sort to the top of the file.
Therefore, the first two characters of these tags are used a magic number to
detect a tag file for purposes of determining whether a valid tag file is
being overwritten rather than a source file.
<P>
Note that the name of each source file will be recorded in the tag file
exactly as it appears on the command line. Therefore, if the path you
specified on the command line was relative to the current directory, then it
will be recorded in that same manner in the tag file. See, however, the
<B>--tag-relative</B> option for how this behavior can be modified.
<P>
Extension fields are tab-separated key-value pairs appended to the end of the
EX command as a comment, as described above. These key value pairs appear in
the general form &quot;<I>key</I>:<I>value</I>&quot;. Their presence in the lines of the
tag file are controlled by the <B>--fields</B> option. The possible keys and
the meaning of their values are as follows:
<P>
<DL COMPACT>
<DT><I>access</I>

<DD>
Indicates the visibility of this class member, where <I>value</I> is specific
to the language.
<P>
<DT><I>file</I>

<DD>
Indicates that the tag has file-limited visibility. This key has no
corresponding value.
<P>
<DT><I>kind</I>

<DD>
Indicates the type, or kind, of tag. Its value is either one of the
corresponding one-letter flags described under the various
<B>--&lt;LANG&gt;-types</B> options above, or a full name. It is permitted (and is,
in fact, the default) for the key portion of this field to be omitted. The
optional behaviors are controlled with the <B>--fields</B> option.
<P>
<DT><I>implementation</I>

<DD>
When present, this indicates a limited implementation (abstract vs. concrete)
of a routine or class, where <I>value</I> is specific to the language
(&quot;virtual&quot; or &quot;pure virtual&quot; for C++; &quot;abstract&quot; for Java).
<P>
<DT><I>inherits</I>

<DD>
When present, <I>value</I>. is a comma-separated list of classes from which
this class is derived (i.e. inherits from).
<P>
</DL>
<P>

In addition, information on the scope of the tag definition may be available,
with the key portion equal to some language-dependent construct name and its
value the name declared for that construct in the program. This scope entry
indicates the scope in which the tag was found. For example, a tag generated
for a C structure member would have a scope looking like &quot;struct:myStruct&quot;.
<P>
<P>
<A NAME="lbAJ">&nbsp;</A>
<H2>HOW TO USE WITH VI</H2>

Vi will, by default, expect a tag file by the name &quot;tags&quot; in the current
directory. Once the tag file is built, the following commands exercise the tag
indexing feature:
<DL COMPACT>
<DT><B>vi -t tag</B>

<DD>
Start vi and position the cursor at the file and line where &quot;tag&quot; is defined.
<DT><B>:ta tag</B>

<DD>
Find a tag.
<DT><B>Ctrl-]</B>

<DD>
Find the tag under the cursor.
<DT><B>Ctrl-T</B>

<DD>
Return to previous location before jump to tag (not widely implemented).
<P>
<P>
</DL>
<A NAME="lbAK">&nbsp;</A>
<H2>HOW TO USE WITH GNU EMACS</H2>

Emacs will, by default, expect a tag file by the name &quot;TAGS&quot; in the current
directory. Once the tag file is built, the following commands exercise the
tag indexing feature:
<DL COMPACT>
<DT><B>M-x visit-tags-table &lt;RET&gt; FILE &lt;RET&gt;</B>

<DD>
Select the tag file, &quot;FILE&quot;, to use.
<DT><B>M-. [TAG] &lt;RET&gt;</B>

<DD>
Find the first definition of TAG. The default tag is the identifier under the
cursor.
<DT><B>M-*</B>

<DD>
Pop back to where you previously invoked &quot;M-.&quot;.
<DT><B>C-u M-.</B>

<DD>
Find the next definition for the last tag.
<P>
</DL>
<P>

For more commands, see the <I>Tags</I> topic in the Emacs info document.
<P>
<P>
<A NAME="lbAL">&nbsp;</A>
<H2>HOW TO USE WITH NEDIT</H2>

NEdit version 5.1 and later can handle the new extended tag file format (see
<B>--format</B>). To make NEdit use the tag file, select &quot;File-&gt;Load Tags
File&quot;. To jump to the definition for a tag, highlight the word, the press
Ctrl-D. NEdit 5.1 can can read multiple tag files from different directories.
Setting the X resource nedit.tagFile to the name of a tag file instructs NEdit
to automatically load that tag file at startup time.
<P>
<P>
<A NAME="lbAM">&nbsp;</A>
<H2>CAVEATS</H2>

Because <B>ctags</B> is neither a preprocessor nor a compiler, use of
preprocessor macros can fool <B>ctags</B> into either missing tags or
improperly generating inappropriate tags. Although <B>ctags</B> has been
designed to handle certain common cases, this is the single biggest cause of
reported problems. In particular, the use of preprocessor constructs which
alter the textual syntax of C can fool <B>ctags</B>. You can work around many
such problems by using the <B>-I</B> option.
<P>
White space is treated as a separator for file names and options read from
list files, specified using the <B>-L</B> option, and in filter mode (specified
using the <B>--filter</B> option). Therefore, it is not currently possible to
supply file names or other options containing embedded white space (spaces,
etc.) through these options.
<P>
Note that when <B>ctags</B> generates uses patterns for locating tags (see
the <B>--excmd</B> option), it is entirely possible that the wrong line may be
found by your editor if there exists another source line which is identical to
the line containing the tag. The following example demonstrates this condition:
<P>
<DL COMPACT><DT><DD>
int variable;
<P>
/* ... */
<BR>

void foo(variable)
<BR>

int variable;
<BR>

{
<DL COMPACT><DT><DD>
/* ... */
</DL>

}
</DL>

<P>
Depending upon which editor you use and where in the code you happen to be, it
is possible that the search pattern may locate the local parameter declaration
in foo() before it finds the actual global variable definition, since the
lines (and therefore their search patterns are identical). This can be avoided
by use of the <B>--excmd</B>=<I>n</I> option.
<P>
<P>
<A NAME="lbAN">&nbsp;</A>
<H2>BUGS</H2>

<B>Ctags</B> has more options than <B><A HREF="http://localhost/cgi-bin/man/man2html?1+ls">ls</A></B>(1).
<P>
When parsing a C++ member function definition (e.g. &quot;className::function&quot;),
<B>ctags</B> cannot determine whether the scope specifier is a class name or a
namespace specifier and always lists it as a class name in the scope portion
of the extension fields. Also, if the function defintion is located in a
separate file from than where the class is defined (the usual case), the
access specification (i.e. public, protected, or private) that the function
had when declared in the class is not known.
<P>
No qualified tags are generated for language objects inherited into a class.
<P>
<P>
<A NAME="lbAO">&nbsp;</A>
<H2>ENVIRONMENT VARIABLES</H2>

<P>
<DL COMPACT>
<DT><B>CTAGS</B>

<DD>
If this environment variable exists, it will be expected to contain a set of
default options which are read when <B>ctags</B> starts, after the
configuration files listed in <B>FILES</B>, below, are read, but before any
command line options are read. Options appearing on the command line will
override options specified in this variable. Only options will be read from
this variable. Note that all white space in this variable in considered a
separator, making it impossible to pass an option parameter containing an
embedded space. If this is a problem, use a configuration file instead.
<P>
<DT><B>ETAGS</B>

<DD>
Similar to the <B>CTAGS</B> variable above, this variable, if found, will be
read when <B>etags</B> starts. If this variable is not found, <B>etags</B> will
try to use <B>CTAGS</B> instead.
<P>
<DT><B>TMPDIR</B>

<DD>
On Unix-like hosts where mkstemp() is available, the value of this variable
specifies the directory in which to place temporary files. This can be useful
if the size of a temporary file becomes too large to fit on the partition
holding the default temporary directory defined at compilation time.
<B>ctags</B> creates temporary files only if either (1) an emacs-style tag file
is being generated, (2) the tag file is being sent to standard output, or (3)
the program was compiled to use an internal sort algorithm to sort the tag
files instead of the the sort utility of the operating system. If the sort
utility of the operating system is being used, it will generally observe this
variable also. Note that if <B>ctags</B> is setuid, the value of TMPDIR will be
ignored.
<P>
<P>
</DL>
<A NAME="lbAP">&nbsp;</A>
<H2>FILES</H2>


<I>/ctags.cnf (on MSDOS, MSWindows only)</I>

<BR>

<I>/etc/ctags.conf</I>

<BR>

<I>/usr/local/etc/ctags.conf</I>

<BR>

<I>$HOME/.ctags ($HOME/ctags.cnf on MSDOS, MSWindows)</I>

<BR>

<I>.ctags (ctags.cnf on MSDOS, MSWindows)</I>

<DL COMPACT>
<DT><DD>
If any of these configuration files exist, each will be expected to contain a
set of default options which are read in the order listed when <B>ctags</B>
starts, but before the <B>CTAGS</B> environment variable is read or any command
line options are read. This makes it possible to set up site-wide, personal
or project-level defaults. It is possible to compile <B>ctags</B> to read an
additional configuration file before any of those shown above, which will be
indicated if the output produced by the <B>--version</B> option lists the
&quot;custom-conf&quot; feature. Options appearing in the <B>CTAGS</B> environment
variable or on the command line will override options specified in these
files. Only options will be read from these files. Note that the option files
are read in line-oriented mode in which spaces are significant (since
shell quoting is not possible). Each line of the file is read as one command
line parameter (as if it were quoted with single quotes). Therefore, use new
lines to indicate separate command-line arguments.

<P>
<DT><I>tags</I>

<DD>
The default tag file created by <B>ctags</B>.
<DT><I>TAGS</I>

<DD>
The default tag file created by <B>etags</B>.
<P>
</DL>
<A NAME="lbAQ">&nbsp;</A>
<H2>SEE ALSO</H2>

The official Exuberant Ctags web site at:
<P>
<DL COMPACT><DT><DD>
<A HREF="http://ctags.sourceforge.net">http://ctags.sourceforge.net</A>
</DL>

<P>
Also <B><A HREF="http://localhost/cgi-bin/man/man2html?1+ex">ex</A></B>(1), <B><A HREF="http://localhost/cgi-bin/man/man2html?1+vi">vi</A></B>(1), <B>elvis</B>, or, better yet, <B>vim</B>, the
official editor of <B>ctags</B>. For more information on <B>vim</B>, see the VIM
Pages web site at:
<P>
<DL COMPACT><DT><DD>
<A HREF="http://www.vim.org/">http://www.vim.org/</A>
</DL>

<P>
<P>
<A NAME="lbAR">&nbsp;</A>
<H2>AUTHOR</H2>

Darren Hiebert &lt;<A HREF="mailto:dhiebert@users.sourceforge.net">dhiebert@users.sourceforge.net</A>&gt;
<BR>

<A HREF="http://DarrenHiebert.com/">http://DarrenHiebert.com/</A>
<P>
<P>
<A NAME="lbAS">&nbsp;</A>
<H2>MOTIVATION</H2>

&quot;Think ye at all times of rendering some service to every member of the human
race.&quot;
<P>
&quot;All effort and exertion put forth by man from the fullness of his heart is
worship, if it is prompted by the highest motives and the will to do service
to humanity.&quot;
<P>
<DL COMPACT><DT><DD>
-- From the Baha'i Writings
</DL>

<P>
<P>
<A NAME="lbAT">&nbsp;</A>
<H2>CREDITS</H2>

This version of <B>ctags</B> was originally derived from and inspired by the
ctags program by Steve Kirkendall &lt;<A HREF="mailto:kirkenda@cs.pdx.edu">kirkenda@cs.pdx.edu</A>&gt; that comes with the
Elvis vi clone (though virtually none of the original code remains).
<P>
Credit is also due Bram Moolenaar &lt;<A HREF="mailto:Bram@vim.org">Bram@vim.org</A>&gt;, the author of <B>vim</B>, who
has devoted so much of his time and energy both to developing the editor as a
service to others, and to helping the orphans of Uganda.
<P>
The section entitled &quot;HOW TO USE WITH GNU EMACS&quot; was shamelessly stolen from
the info page for GNU <B>etags</B>.
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">SOURCE FILES</A><DD>
<DT><A HREF="#lbAF">OPTIONS</A><DD>
<DT><A HREF="#lbAG">TAG KINDS</A><DD>
<DT><A HREF="#lbAH">OPERATIONAL DETAILS</A><DD>
<DT><A HREF="#lbAI">TAG FILE FORMAT</A><DD>
<DT><A HREF="#lbAJ">HOW TO USE WITH VI</A><DD>
<DT><A HREF="#lbAK">HOW TO USE WITH GNU EMACS</A><DD>
<DT><A HREF="#lbAL">HOW TO USE WITH NEDIT</A><DD>
<DT><A HREF="#lbAM">CAVEATS</A><DD>
<DT><A HREF="#lbAN">BUGS</A><DD>
<DT><A HREF="#lbAO">ENVIRONMENT VARIABLES</A><DD>
<DT><A HREF="#lbAP">FILES</A><DD>
<DT><A HREF="#lbAQ">SEE ALSO</A><DD>
<DT><A HREF="#lbAR">AUTHOR</A><DD>
<DT><A HREF="#lbAS">MOTIVATION</A><DD>
<DT><A HREF="#lbAT">CREDITS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 23:20:26 GMT, February 16, 2002
</BODY>
</HTML>