Diffstat (limited to 'contrib/global/htags')
2 files changed, 26 insertions, 51 deletions
diff --git a/contrib/global/htags/Makefile.generic b/contrib/global/htags/Makefile.generic
deleted file mode 100644
@@ -1,11 +0,0 @@
-PROG = htags
-BINDIR = /usr/bin
-MANDIR = /usr/man
- cp $(PROG).pl $(BINDIR)/$(PROG)
- chmod 755 $(BINDIR)/$(PROG)
- cp $(PROG).1 $(MANDIR)/man1
- chmod 644 $(MANDIR)/man1/$(PROG).1
diff --git a/contrib/global/htags/htags.1 b/contrib/global/htags/htags.1
index 4c22448e6f02..2a9dea12265f 100644
@@ -1,5 +1,5 @@
-.\" Copyright (c) 1996, 1997, 1998 Shigio Yamaguchi. All rights reserved.
+.\" Copyright (c) 1996, 1997 Shigio Yamaguchi. All rights reserved.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@@ -28,18 +28,16 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
-.Dd Oct 11, 1998
+.Dd June 28, 1997
.Dt HTAGS 1
.Os BSD 4
-.Nd generate hypertext from C, Yacc and Java source code
+.Nd generate hypertext from C and Yacc source code
.Op Fl a
-.Op Fl c
.Op Fl f
-.Op Fl h
.Op Fl l
.Op Fl n
.Op Fl v
@@ -49,59 +47,47 @@
.Op Ar dir
-makes hypertext from C, Yacc and Java source code using GLOBAL database (GTAGS, GRTAGS).
+makes hypertext from C and Yacc source code using GLOBAL database (GTAGS, GRTAGS).
In advance of using this command, you must execute
.Xr gtags 1
-from the root directory of the source tree.
+at the root directory of the source tree.
Then you can execute
-from the same place.
+at the same place.
-makes an HTML directory and generates hypertext in it.
+makes HTML directory and generate hypertext in it.
You can start browsing from 'HTML/index.html'.
-Once the hypertext is generated, you can move it anywhere and browse it
-in any browsers.
+Once hypertext generated, you can move it anywhere and browse it
+by any browsers.
.Bl -tag -width Ds
.It Fl a
-Make an alphabetical function index, suitable for a large project.
-.It Fl c
-Compress html files by
-.Xr gzip 1 .
-You need to set up an HTTP server so that
-.Xr gzip 1
-is invoked for each compressed
-files. See skelton file 'HTML/.htaccess.skel' that is generated by htags.
+make an alphabetical function index. It's suitable for large project.
.It Fl f
-Support an input form and a dynamic index with a CGI program.
-You need to set up an HTTP server for this.
-.It Fl h
-Add title header frame. By default, doesn't add this.
+support input form and dynamic index by CGI program.
+You need to setup HTTP server for it.
.It Fl l
-Make a name tag(<A NAME=line number>) for each line, so that other hypertext
-can link to any line of this hypertext.
-By default, htags makes it only for lines that are referred to by an object.
+make name tag(<A NAME=line number>) for each line so that outer hypertext
+can point any line of this hypertext.
+By default, make it only for lines which have referred object.
.It Fl n
-Print the line numbers (they are not printed by default).
+print line number. By default, doesn't print it.
.It Fl v
.It Fl w
-Print a warning message.
+print warning message.
.It Fl d Ar tagdir
-Specifies the directory in which GTAGS and GRTAGS exist. The default is the
+the directory in which GTAGS and GRTAGS exist. Default is current directory.
.It Fl t Ar title
-The title of this hypertext. Defaults to the last component of the current
+Title of this hypertext. Default is the last component of current path.
.It Ar dir
-The directory in which hypertext is generated. The default is the current
+the directory in which hypertext generated. Default is current directory.
% cd /usr/src/sys
- # gtags -o
+ # gtags -se
# htags -fnvat 'Welcom to FreeBSD kernel source tour!'
% lynx HTML/index.html
@@ -109,17 +95,17 @@ directory.
.It Pa HTML/index.html
.It Pa GTAGS
-Tags file for function definitions.
+tags file for function definitions.
.It Pa GRTAGS
-Tags file for function references.
+tags file for function references.
The following environment variables affect the execution of htags.
.Bl -tag -width indent
.It Ev TMPDIR
-If this variable is set, its value is used as the directory to make temporary files.
-The default is /tmp.
+If this variable is set, its value is used as the directory to make temporary file.
+Default is /tmp.
exits with a non 0 value if an error occurred, 0 otherwise.