File: gopherindex.8

package info (click to toggle)
gopher 2.3-2
  • links: PTS
  • area: non-free
  • in suites: hamm
  • size: 2,364 kB
  • ctags: 2,030
  • sloc: ansic: 22,451; perl: 1,950; sh: 1,510; makefile: 397; asm: 1
file content (99 lines) | stat: -rw-r--r-- 2,314 bytes parent folder | download | duplicates (3)
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
.TH GOPHERINDEX 8
.SH NAME
gopherindex \- make full text indexes inside of gopher
.SH SYNOPSIS
.B gopherindex
.RI [ -v
.IR ]
.RI [ -t
.IR next|wais]
.RI [ -N 
.IR index_name]
.RI [ -gd 
.IR gopherdatadir]
.RI [ data_directory
.IR ]
.SH DESCRIPTION
The gopherindex program is used to make full-text indexes for a Gopher
server.  It uses the underlying indexing mechanism, either WAIS, or the
NeXT Digital Librarian to create the indexes.
.PP
Gopherindex uses 
.B waisindex
to generate indexes for sites using WAIS.
For sites using NeXT indexing, gopherindex uses
.B ixBuild.
These programs must be in the current path for this script to work.
.PP
.B -v
.RS 3
Specifies verbose output.  Otherwise only error messages are output.
.RE
.B -N
.RS 3
specifies the name of the Index as it should appear to gopher
users.  Remember to quote your name if it uses spaces.
.RE
.B -gd
.RS 3
specifies the name of the gopher-data directory.  You'll only need to use this
if you have multiple servers on the same machine, or move your gopher-data
directory.
.RE
.B -t
.RS 3
specifies the type of indexing to use.  This is only really useful if
you are on a NeXT with both WAIS and NeXT indexing capabilities.
Specify 
.B wais
for wais indices.  Specify 
.B next
for NeXT indices.
.RE
.B -wais
.RS 3
Specifies extra arguments to be passed to the 
.B waisindex 
command.  These options will need to be quoted so they are not
processed by the script.  See the EXAMPLES section.

.SH EXAMPLES

.PP
The following command indexes all of the files inside of 
.B /home/joeboy/gopher-data/courses
with verbose output and makes a link name of 
.B "Search CIS Short Courses".

.RS 3
 /usr/local/bin/gopherindex -v -N \\
   "Search CIS Services Short Courses" \\
   /home/joeboy/gopher-data/courses
.RE

.PP
The following command uses wais to all of the files in 
.B /home/joeboy/gopher-data/providers/bookstore
with verbose output.  The 
.B -wais "-t dash" 
specifies that 
.B waisindex 
should consider all of the files to have subdocuments separated by
lines of dashes.

.RS 3
 /usr/local/bin/gopherindex -v -N \\
   "Search Minnesota Bookcenter electronics inventory" \\
   -wais "-t dash" \\
   /home/joeboy/gopher-data/providers/bookstore
.RE


.SH FILES

.B ixBuild
Indexer for NeXT machines
 
.B waisindex
Indexer for other machines