8354 sync regcomp(3C) with upstream (fix make catalog)
[unleashed/tickless.git] / usr / src / lib / libast / common / man / find.3
bloba14ceaee0fd7d5350186120d31d8467431d6dd51
1 .fp 5 CW
2 .de Af
3 .ds ;G \\*(;G\\f\\$1\\$3\\f\\$2
4 .if !\a\\$4\a\a .Af \\$2 \\$1 "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
5 ..
6 .de aF
7 .ie \a\\$3\a\a .ft \\$1
8 .el \{\
9 .ds ;G \&
10 .nr ;G \\n(.f
11 .Af "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
12 \\*(;G
13 .ft \\n(;G \}
15 .de L
16 .aF 5 \\n(.f "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
18 .de LR
19 .aF 5 1 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
21 .de RL
22 .aF 1 5 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
24 .de EX          \" start example
25 .ta 1i 2i 3i 4i 5i 6i
26 .PP
27 .RS 
28 .PD 0
29 .ft 5
30 .nf
32 .de EE          \" end example
33 .fi
34 .ft
35 .PD
36 .RE
37 .PP
39 .TH FIND 3
40 .SH NAME
41 find \- fastfind algorithm interface
42 .SH SYNOPSIS
43 .EX
44 #include <find.h>
46 void* findopen(const char* \fIpattern\fP);
47 char* findnext(void* \fIhandle\fP);
48 void findclose(void* \fIhandle\fP);
49 .EE
50 .SH DESCRIPTION
51 These routines access the data generated by the
52 .I fastfind
53 algorithm.
54 The data itself is generated by a standalone program that is run daily
55 via
56 .I cron
58 .IR at .
59 .PP
60 .L findopen 
61 returns a handle to a 
62 .I fastfind
63 stream for the 
64 .I ksh 
65 file pattern
66 .IR pattern .
67 .L findnext
68 returns the next pathname that matches the pattern specified by
69 .IR handle .
70 .L findnext
71 returns 
72 .L 0
73 when no more pathnames match the pattern.
74 Finally,
75 .L findclose
76 closes the
77 .I fastfind
78 stream for
79 .IR handle .
80 .SH BUGS
81 These rotuines are only as good as the
82 .I fastfind
83 information which is in the system administration domain.
84 .SH "SEE ALSO"
85 tw(1),
86 find(1),
87 strmatch(3)
88 .br
89 James A. Woods, \fIFast Find Algorithm\fP, Usenix ;login:, February/March, 1983, p. 8