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
|
.TH HTMAKE 1 "27 March 1999" "Debian GNU/Linux" "GLOBAL cgi Utilities"
.\" Copyright (c) 1999, 2000 Ron Lee. All rights reserved.
.\" This text may be distributed under the same terms as the htmake source.
.\" All copies of this manual must acknowledge the author and include the
.\" above copyright statement.
.\"
.\" In cases of discrepancy the source is authorative. Duh 8^}
.SH NAME
htmake \- create GLOBAL hypertext source searchable by gsearch.cgi
.SH SYNOPSIS
.BR htmake " [" "htags options" "] [" --url=base-url ]
.RI [ destdir ]
.SH "DESCRIPTION"
.B htmake
is a wrapper script that creates searchable hypertext from program
source code and records information into a \fBpath database\fP
needed for a centralised search mechanism.
.PP
Prior to using this command you must have installed gsearch.cgi
using the \fBhtconfig -I\fP option and configured the location
of the \fBpath database\fP in \fIhtmake.conf\fP
.PP
Before you can create the hypertext source you need to execute
\fBgtags\fP(1) from the root directory of the source tree.
\fBhtmake\fP is then called from the same place.
.PP
\fBhtmake\fP uses \fBhtags\fP(1) to create the hypertext with a
unique id and \fBhtconfig\fP(1) to make the required entries in
the \fBpath database\fP.
.SH OPTIONS
The following options will be passed to \fBhtags\fP(1) if used.
.TP
.B -a
Make an alphabetical function index.
.TP
.B -c
Compress html. Use gzip(1) with .ghtml suffix.
.TP
.B -C
Compress html. Use gzip(1) with .html.gz suffix.
.TP
.B -d \fItagdir\fP, --tags=gtagsdbpath
Specifies the directory in which GTAGS and GRTAGS exist. The default is the current directory.
.TP
.B -F
Use frames for definition index, file index and main view.
.TP
.B -l
Make a name tag for each line of hypertext created.
.TP
.B -n
Print out the line numbers.
.TP
.B -t title
The title of this hypertext. Defaults to the last component of the current path.
.TP
.B --action=cgi-url
Specify the location search queries are submitted to.
Defaults to the value set in \fBhtmake.conf\fP or to
.br
.I http://localhost/cgi-bin/gsearch.cgi
.PP
The remaining options are more general or are passed to \fBhtconfig\fP(1).
.TP
.B --url=base-url
the base url for your new hypertext source.
For best results always use absolute url's here.
.br
eg. \fIhttp://host/~user/mysource\fP
.br
It defaults to \fIfile:/destdir\fP
.TP
.I destdir
The directory in which hypertext is generated.
The default is \fI./HTML\fP
.TP
.B -v, --verbose
Activate the inbuilt screen saver. Give your phosphors a workout.
.SH EXAMPLES
$ cd /usr/src/myprog
.br
$ gtags
.br
$ htmake
.PP
$ cd /usr/src/myprog
.br
$ gtags -c
.br
$ htmake \-c \-\-url=http://host/~user/prog/HTML \\
/home/user/public_html/prog
.SH FILES
.I /etc/gtags/htmake.conf
.br
.I path database
.SH BUGS
As a wrapper \fBhtmake\fP gets to inherit bugs from other software too.
Isn't life fun.
.PP
This is \fIalpha\fP software \- expect anything!
.SH "SEE ALSO"
.BR htconfig (1), " htags" (1), " gtags" (1), " global" (1).
.SH AUTHOR
Ron Lee <ron@debian.org>
.SH CREDITS
Thanks to Shigio Yamaguchi <shigio@gnu.org> for creating
\fBGLOBAL\fP and releasing it as free software.
.br
A truly cool productivity tool!
|
