aboutsummaryrefslogtreecommitdiff
path: root/contrib/global/htags/htags.1
diff options
context:
space:
mode:
authorHidetoshi Shimokawa <simokawa@FreeBSD.org>1999-01-18 06:59:18 +0000
committerHidetoshi Shimokawa <simokawa@FreeBSD.org>1999-01-18 06:59:18 +0000
commit3ba3e2cc4b63fa16707f51e735e751e62dd9526e (patch)
tree2d073c94248fff7dcaa8a3b1356933e1dcd784db /contrib/global/htags/htags.1
parent0823b5bf088ea8520ea23a0c424e4ecab62491d5 (diff)
downloadsrc-3ba3e2cc4b63fa16707f51e735e751e62dd9526e.tar.gz
src-3ba3e2cc4b63fa16707f51e735e751e62dd9526e.zip
Import Global v3_4_2 sources.vendor/global
Ok'd by: peter Discussed with: msmith
Notes
Notes: svn path=/vendor/global/dist/; revision=42788
Diffstat (limited to 'contrib/global/htags/htags.1')
-rw-r--r--contrib/global/htags/htags.166
1 files changed, 40 insertions, 26 deletions
diff --git a/contrib/global/htags/htags.1 b/contrib/global/htags/htags.1
index e2f03559868c..4c22448e6f02 100644
--- a/contrib/global/htags/htags.1
+++ b/contrib/global/htags/htags.1
@@ -1,5 +1,5 @@
.\"
-.\" Copyright (c) 1996, 1997 Shigio Yamaguchi. All rights reserved.
+.\" Copyright (c) 1996, 1997, 1998 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,16 +28,18 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd June 28, 1997
+.Dd Oct 11, 1998
.Dt HTAGS 1
.Os BSD 4
.Sh NAME
.Nm htags
-.Nd generate hypertext from C and Yacc source code
+.Nd generate hypertext from C, Yacc and Java source code
.Sh SYNOPSIS
.Nm htags
.Op Fl a
+.Op Fl c
.Op Fl f
+.Op Fl h
.Op Fl l
.Op Fl n
.Op Fl v
@@ -47,47 +49,59 @@
.Op Ar dir
.Sh DESCRIPTION
.Nm Htags
-makes hypertext from C and Yacc source code using GLOBAL database (GTAGS, GRTAGS).
+makes hypertext from C, Yacc and Java source code using GLOBAL database (GTAGS, GRTAGS).
.Pp
In advance of using this command, you must execute
.Xr gtags 1
-at the root directory of the source tree.
+from the root directory of the source tree.
Then you can execute
.Nm htags
-at the same place.
+from the same place.
.Nm Htags
-makes HTML directory and generate hypertext in it.
+makes an HTML directory and generates hypertext in it.
.Pp
You can start browsing from 'HTML/index.html'.
-Once hypertext generated, you can move it anywhere and browse it
-by any browsers.
+Once the hypertext is generated, you can move it anywhere and browse it
+in any browsers.
.Pp
.br
.Bl -tag -width Ds
.It Fl a
-make an alphabetical function index. It's suitable for large project.
+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.
.It Fl f
-support input form and dynamic index by CGI program.
-You need to setup HTTP server for it.
+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.
.It Fl l
-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.
+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.
.It Fl n
-print line number. By default, doesn't print it.
+Print the line numbers (they are not printed by default).
.It Fl v
-verbose mode.
+Verbose mode.
.It Fl w
-print warning message.
+Print a warning message.
.It Fl d Ar tagdir
-the directory in which GTAGS and GRTAGS exist. Default is current directory.
+Specifies the directory in which GTAGS and GRTAGS exist. The default is the
+current directory.
.It Fl t Ar title
-Tile of this hypertext. Default is the last component of current path.
+The title of this hypertext. Defaults to the last component of the current
+path.
.It Ar dir
-the directory in which hypertext generated. Default is current directory.
+The directory in which hypertext is generated. The default is the current
+directory.
.Sh EXAMPLES
% cd /usr/src/sys
- # gtags -se
+ # gtags -o
# htags -fnvat 'Welcom to FreeBSD kernel source tour!'
% lynx HTML/index.html
.Sh FILES
@@ -95,17 +109,17 @@ the directory in which hypertext generated. Default is current directory.
.It Pa HTML/index.html
Index file.
.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.
.El
.Sh ENVIRONMENT
The following environment variables affect the execution of htags.
.Pp
.Bl -tag -width indent
.It Ev TMPDIR
-If this variable is set, its value is used as the directory to make temporary file.
-Default is /tmp.
+If this variable is set, its value is used as the directory to make temporary files.
+The default is /tmp.
.Sh DIAGNOSTICS
.Nm Htags
exits with a non 0 value if an error occurred, 0 otherwise.