BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / ctags / ctags.1

diff --git a/usr/src/usr.bin/ctags/ctags.1 b/usr/src/usr.bin/ctags/ctags.1
index 0b329c5..363204a 100644 (file)
--- a/usr/src/usr.bin/ctags/ctags.1
+++ b/usr/src/usr.bin/ctags/ctags.1
@@ -1,11 +1,37 @@
 .\" Copyright (c) 1987, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1987, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"     @(#)ctags.1    6.7 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.Dd 
+.\"     @(#)ctags.1    6.8 (Berkeley) 4/24/91
+.\"
+.Dd April 24, 1991

 .Dt CTAGS 1
 .Os BSD 4
 .Sh NAME
 .Dt CTAGS 1
 .Os BSD 4
 .Sh NAME


@@ -21,7 +47,9 @@
 makes a tags file for
 .Xr ex 1
 from the specified C,
 makes a tags file for
 .Xr ex 1
 from the specified C,

-Pascal, Fortran, YACC, lex, and lisp sources.  A tags file gives the
+Pascal, Fortran,
+.Tn YACC ,
+lex, and lisp sources.  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 is defined,
 and a search pattern for the object definition, separated by white-space.
 locations of specified objects in a group of files.  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 white-space.


@@ -34,54 +62,32 @@ definitions.  Depending on the options provided to
 .Nm ctags ,
 objects will consist of subroutines, typedefs, defines, structs,
 enums and unions.
 .Nm ctags ,
 objects will consist of subroutines, typedefs, defines, structs,
 enums and unions.

-.Pp
-.Tw Ds
-.Tp Fl x
-.Nm ctags
-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.
-.Pp
-.Tp Fl v
-An index of the form expected by
-.Xr vgrind 1
-is produced on the standard output.  This listing
-contains the object 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
-.Xr sort 1 .
-Sample use:
-.Pp
-.Ds I
-ctags \-v files \&| sort \-f > index
-vgrind \-x index
-.De
-.Tp Fl f
-Places the tag descriptions in a file called
-.Ar tagsfile .
-The default behaviour is to place them in a file
-.Ar tags .
-.Tp Fl F
-use forward searching patterns (/.../) (the default).
-.Tp Fl B
-use backward searching patterns (?...?).
-.Tp Fl a
+.Bl -tag -width Ds
+.It Fl B
+use backward searching patterns
+.Pq Li ?...? .
+.It Fl F
+use forward searching patterns
+.Pq Li /.../
+(the default).
+.It Fl a

 append to
 .Ar tags
 file.
 append to
 .Ar tags
 file.

-.Tp Fl d
+.It Fl d

 create tags for
 .Li #defines
 that don't take arguments;
 .Li #defines
 that take arguments are tagged automatically.
 create tags for
 .Li #defines
 that don't take arguments;
 .Li #defines
 that take arguments are tagged automatically.

-.Tp Fl t
+.It Fl f
+Places the tag descriptions in a file called
+.Ar tagsfile .
+The default behaviour is to place them in a file
+.Ar tags .
+.It Fl t

 create tags for typedefs, structs, unions, and enums.
 create tags for typedefs, structs, unions, and enums.

-.Tp Fl w
-suppress warning diagnostics.
-.Tp Fl u
+.It Fl u

 update the specified files in the
 .Ar tags
 file, that is, all
 update the specified files in the
 .Ar tags
 file, that is, all


@@ -90,7 +96,29 @@ file.  (Beware: this option is implemented in a way which is rather
 slow; it is usually faster to simply rebuild the
 .Ar tags
 file.)
 slow; it is usually faster to simply rebuild the
 .Ar tags
 file.)

-.Tp
+.It Fl v
+An index of the form expected by
+.Xr vgrind 1
+is produced on the standard output.  This listing
+contains the object 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
+.Xr sort 1 .
+Sample use:
+.Bd -literal -offset indent
+ctags \-v files \&| sort \-f > index
+vgrind \-x index
+.Ed
+.It Fl w
+suppress warning diagnostics.
+.It Fl x
+.Nm ctags
+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.
+.El

 .Pp
 Files whose names end in
 .Nm \&.c
 .Pp
 Files whose names end in
 .Nm \&.c


@@ -100,7 +128,9 @@ are assumed to be C
 source files and are searched for C style routine and macro definitions.
 Files whose names end in
 .Nm \&.y
 source files and are searched for C style routine and macro definitions.
 Files whose names end in
 .Nm \&.y

-are assumed to be YACC source files.
+are assumed to be
+.Tn YACC
+source files.

 Files whose names end in
 .Nm \&.l
 are assumed to be lisp files if their
 Files whose names end in
 .Nm \&.l
 are assumed to be lisp files if their


@@ -132,11 +162,10 @@ of the second section of the yacc file, and
 is the start of
 the second section of the lex file.
 .Sh FILES
 is the start of
 the second section of the lex file.
 .Sh FILES

-.Dw tags
-.Di L
-.Dp Pa tags
+.Bl -tag -width tags -compact
+.It Pa tags

 default output tags file
 default output tags file

-.Dp
+.El

 .Sh DIAGNOSTICS
 .Nm Ctags
 exits with a value of 1 if an error occurred, where
 .Sh DIAGNOSTICS
 .Nm Ctags
 exits with a value of 1 if an error occurred, where


@@ -144,42 +173,41 @@ duplicate objects are not considered errors, 0 otherwise.
 .Sh SEE ALSO
 .Xr ex 1 ,
 .Xr vi 1
 .Sh SEE ALSO
 .Xr ex 1 ,
 .Xr vi 1

-.Sh HISTORY
-.Nm
-appeared in 3 BSD.
-.Sh AUTHOR
-Ken Arnold; FORTRAN added by Jim Kleckner; Bill Joy added Pascal and
-.Fl x ,
-replacing
-.Ar cxref  ;
-C typedefs added by Ed Pelegri-Llopart.

 .Sh BUGS
 Recognition of
 .Nm functions  ,
 .Nm subroutines
 and
 .Nm procedures
 .Sh BUGS
 Recognition of
 .Nm functions  ,
 .Nm subroutines
 and
 .Nm procedures

-for FORTRAN and Pascal is done is a very simpleminded way.  No attempt
+for
+.Tn FORTRAN
+and Pascal is done is a very simpleminded way.  No attempt

 is made to deal with block structure; if you have two Pascal procedures
 in different blocks with the same name you lose.
 .Nm Ctags
 doesn't
 understand about Pascal types.
 .Pp
 is made to deal with block structure; if you have two Pascal procedures
 in different blocks with the same name you lose.
 .Nm Ctags
 doesn't
 understand about Pascal types.
 .Pp

-The method of deciding whether to look for C, Pascal or FORTRAN
+The method of deciding whether to look for C, Pascal or
+.Tn FORTRAN

 functions is a hack.
 .Pp
 .Nm Ctags
 relies on the input being well formed, and any syntactical
 errors will completely confuse it.  It also finds some legal syntax
 confusing; for example, as it doesn't understand
 functions is a hack.
 .Pp
 .Nm Ctags
 relies on the input being well formed, and any syntactical
 errors will completely confuse it.  It also finds some legal syntax
 confusing; for example, as it doesn't understand

-.Sf Li #ifdef 's,
+.Li #ifdef Ns 's ,

 (incidentally, that's a feature, not a bug) any code with unbalanced
 braces inside
 (incidentally, that's a feature, not a bug) any code with unbalanced
 braces inside

-.Sf Li #ifdef 's
+.Li #ifdef Ns 's

 will cause it to become somewhat disoriented.
 In a similar fashion, multiple line changes within a definition will
 cause it to enter the last line of the object, rather than the first, as
 the searching pattern.  The last line of multiple line
 will cause it to become somewhat disoriented.
 In a similar fashion, multiple line changes within a definition will
 cause it to enter the last line of the object, rather than the first, as
 the searching pattern.  The last line of multiple line

-.Sf Li typedef 's
+.Li typedef Ns 's

 will similarly be noted.
 will similarly be noted.

+.Sh HISTORY
+The
+.Nm
+command appeared in 
+.Bx 3.0 .