xref: /netbsd/usr.bin/whatis/whatis.c (revision bf9ec67e)
1 /*	$NetBSD: whatis.c,v 1.13 2002/03/08 20:23:11 jdolecek Exp $	*/
2 
3 /*
4  * Copyright (c) 1987, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the University of
18  *	California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 #include <sys/cdefs.h>
37 
38 #ifndef lint
39 __COPYRIGHT("@(#) Copyright (c) 1987, 1993\n\
40 	The Regents of the University of California.  All rights reserved.\n");
41 #endif /* not lint */
42 
43 #ifndef lint
44 #if 0
45 static char sccsid[] = "@(#)whatis.c	8.5 (Berkeley) 1/2/94";
46 #else
47 __RCSID("$NetBSD: whatis.c,v 1.13 2002/03/08 20:23:11 jdolecek Exp $");
48 #endif
49 #endif /* not lint */
50 
51 #include <sys/param.h>
52 #include <sys/queue.h>
53 
54 #include <ctype.h>
55 #include <err.h>
56 #include <glob.h>
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <string.h>
60 #include <unistd.h>
61 
62 #include <man/config.h>
63 #include <man/pathnames.h>
64 
65 #define	MAXLINELEN	8192			/* max line handled */
66 
67 static int *found, foundman;
68 
69 int main __P((int, char **));
70 void dashtrunc __P((char *, char *));
71 int match __P((char *, char *));
72 void usage __P((void));
73 void whatis __P((char **, char *, int));
74 
75 int
76 main(argc, argv)
77 	int argc;
78 	char *argv[];
79 {
80 	ENTRY *ep;
81 	TAG *tp;
82 	int ch, rv;
83 	char *beg, *conffile, **p, *p_augment, *p_path;
84 	glob_t pg;
85 
86 	conffile = NULL;
87 	p_augment = p_path = NULL;
88 	while ((ch = getopt(argc, argv, "C:M:m:P:")) != -1)
89 		switch (ch) {
90 		case 'C':
91 			conffile = optarg;
92 			break;
93 		case 'M':
94 		case 'P':		/* backward compatible */
95 			p_path = optarg;
96 			break;
97 		case 'm':
98 			p_augment = optarg;
99 			break;
100 		case '?':
101 		default:
102 			usage();
103 		}
104 	argv += optind;
105 	argc -= optind;
106 
107 	if (argc < 1)
108 		usage();
109 
110 	if ((found = malloc((u_int)argc * sizeof(int))) == NULL)
111 		err(1, "malloc");
112 	memset(found, 0, argc * sizeof(int));
113 
114 	for (p = argv; *p; ++p)			/* trim full paths */
115 		if ((beg = strrchr(*p, '/')))
116 			*p = beg + 1;
117 
118 	if (p_augment)
119 		whatis(argv, p_augment, 1);
120 	if (p_path || (p_path = getenv("MANPATH")))
121 		whatis(argv, p_path, 1);
122 	else {
123 		config(conffile);
124 		ep = (tp = getlist("_whatdb")) == NULL ?
125 		   NULL : TAILQ_FIRST(&tp->list);
126 		for (; ep != NULL; ep = TAILQ_NEXT(ep, q)) {
127 			if ((rv = glob(ep->s, GLOB_BRACE | GLOB_NOSORT, NULL,
128 			    &pg)) != 0) {
129 				if (rv == GLOB_NOMATCH)
130 					continue;
131 				else
132 					err(EXIT_FAILURE, "glob");
133 			}
134 			if (pg.gl_pathc)
135 				for (p = pg.gl_pathv; *p; p++)
136 					whatis(argv, *p, 0);
137 			globfree(&pg);
138 		}
139 	}
140 
141 	if (!foundman) {
142 		fprintf(stderr, "whatis: no %s file found.\n", _PATH_WHATIS);
143 		exit(1);
144 	}
145 	rv = 1;
146 	for (p = argv; *p; ++p)
147 		if (found[p - argv])
148 			rv = 0;
149 		else
150 			printf("%s: not found\n", *p);
151 	exit(rv);
152 }
153 
154 void
155 whatis(argv, path, buildpath)
156 	char **argv, *path;
157 	int buildpath;
158 {
159 	char *end, *name, **p;
160 	char buf[MAXLINELEN + 1], wbuf[MAXLINELEN + 1];
161 	char hold[MAXPATHLEN + 1];
162 
163 	for (name = path; name; name = end) {	/* through name list */
164 		if ((end = strchr(name, ':')))
165 			*end++ = '\0';
166 
167 		if (buildpath) {
168 			(void)sprintf(hold, "%s/%s", name, _PATH_WHATIS);
169 			name = hold;
170 		}
171 
172 		if (!freopen(name, "r", stdin))
173 			continue;
174 
175 		foundman = 1;
176 
177 		/* for each file found */
178 		while (fgets(buf, sizeof(buf), stdin)) {
179 			dashtrunc(buf, wbuf);
180 			for (p = argv; *p; ++p)
181 				if (match(wbuf, *p)) {
182 					printf("%s", buf);
183 					found[p - argv] = 1;
184 
185 					/* only print line once */
186 					while (*++p)
187 						if (match(wbuf, *p))
188 							found[p - argv] = 1;
189 					break;
190 				}
191 		}
192 	}
193 }
194 
195 /*
196  * match --
197  *	match a full word
198  */
199 int
200 match(bp, str)
201 	char *bp, *str;
202 {
203 	int len;
204 	char *start;
205 
206 	if (!*str || !*bp)
207 		return(0);
208 	for (len = strlen(str);;) {
209 		for (; *bp && !isdigit(*bp) && !isalpha(*bp); ++bp);
210 		if (!*bp)
211 			break;
212 		for (start = bp++;
213 		    *bp && (*bp == '_' || isdigit(*bp) || isalpha(*bp)); ++bp);
214 		if (bp - start == len && !strncasecmp(start, str, len))
215 			return(1);
216 	}
217 	return(0);
218 }
219 
220 /*
221  * dashtrunc --
222  *	truncate a string at " - "
223  */
224 void
225 dashtrunc(from, to)
226 	char *from, *to;
227 {
228 	int ch;
229 
230 	for (; (ch = *from) && ch != '\n' &&
231 	    (ch != ' ' || from[1] != '-' || from[2] != ' '); ++from)
232 		*to++ = ch;
233 	*to = '\0';
234 }
235 
236 /*
237  * usage --
238  *	print usage message and die
239  */
240 void
241 usage()
242 {
243 	(void)fprintf(stderr,
244 	    "usage: whatis [-C file] [-M path] [-m path] command ...\n");
245 	exit(1);
246 }
247