BSD 3 development
authorBill Joy <wnj@ucbvax.Berkeley.EDU>
Sun, 25 Nov 1979 09:06:29 +0000 (01:06 -0800)
committerBill Joy <wnj@ucbvax.Berkeley.EDU>
Sun, 25 Nov 1979 09:06:29 +0000 (01:06 -0800)
Work on file usr/man/man1/ctags.1
Work on file usr/man/man1/cxref.1

Synthesized-from: 3bsd

usr/man/man1/ctags.1 [new file with mode: 0644]
usr/man/man1/cxref.1 [new file with mode: 0644]

diff --git a/usr/man/man1/ctags.1 b/usr/man/man1/ctags.1
new file mode 100644 (file)
index 0000000..d31cc0e
--- /dev/null
@@ -0,0 +1,61 @@
+.TH CTAGS 1 8/9/79
+.UC
+.SH NAME
+ctags \- maintain a tags file for a C program
+.SH SYNOPSIS
+.B ctags
+[ 
+.B \-auw
+]
+name ...
+.SH DESCRIPTION
+.I Ctags
+makes a tags file for
+.IR ex (1)
+from the specified C programs.
+A tags file gives the locations of specified objects (in this case
+functions) in a group of files.
+Each line of the tags file contains the function name,
+the file in which it is defined, and a scanning pattern used to find
+the function definition.  These are given in separate fields on the line,
+separated by blanks or tabs.
+.PP
+The
+.B \-a
+option causes the output to be appended to the tags file
+instead of rewriting it.
+.PP
+The
+.B \-u
+option causes the specified files to be
+.I updated
+in tags, that is, all references to them are deleted,
+and the new values are appended to the file.
+This option implies the
+.B \-a
+option.
+.PP
+The
+.B \-w
+option suppresses warning diagnostics.
+.PP
+The tag
+.I main
+is treated specially.
+The tag formed is created by prepending
+.I M
+to the name of the file, with a trailing .c removed, if
+any, and leading pathname components also removed.
+This makes use of ctags practical in directories with
+more than one program.
+.SH FILES
+.DT
+tags   output tags file
+.SH SEE ALSO
+ex(1), vi(1)
+.SH BUGS
+In a directory with only one
+.I main,
+the tag
+.I main
+will still not be created.
diff --git a/usr/man/man1/cxref.1 b/usr/man/man1/cxref.1
new file mode 100644 (file)
index 0000000..9f11533
--- /dev/null
@@ -0,0 +1,39 @@
+.TH CXREF 1 2/24/79
+.UC
+.SH NAME
+cxref \- a simple C routine referencing program
+.SH SYNOPSIS
+.B cxref
+name ...
+.SH DESCRIPTION
+.I Cxref
+is a simple shell script which uses
+.IR grep (1)
+and
+.IR ex (1)
+and
+.IR sort (1)
+to make a listing of the routines in the specified C program
+files and the lines on which they are defined.
+It is useful as a summary when prowling in a large program,
+especially since
+.I cref
+has a habit of looping on large program input.
+.SH SEE\ ALSO
+cref(1)
+.SH AUTHOR
+William Joy
+.SH BUGS
+.I Cxref
+assumes that routines begin in the first column of lines,
+and that type names are given on different lines than the routine names.
+If you have a program which is in a different format than this,
+.I cxref
+will fail miserably.
+The operating system,
+C compiler,
+Pascal translator,
+.I ex
+editor,
+etc. all work with
+.I cxref.