1PERLINDEX(1)          User Contributed Perl Documentation         PERLINDEX(1)
2
3
4

NAME

6       perlindex - index and query perl manual pages
7

SYNOPSIS

9           perlindex -index
10
11           perlindex tell me where the flowers are
12

DESCRIPTION

14       ""perlindex -index"" generates an AnyDBM_File index which can be
15       searched with free text queries ""perlindex" a verbose query".
16
17       Each word of the query is searched in the index and a score is
18       generated for each document containing it. Scores for all words are
19       added and the documents with the highest score are printed.  All words
20       are stemed with Porters algorithm (see Text::English) before indexing
21       and searching happens.
22
23       The score is computed as:
24
25           $score{$document} += $tf{$word,$document}/$maxtf{$document}
26                                * log ($N/$n{$word});
27
28       where
29
30       $N        is the number of documents in the index,
31
32       $n{$word} is the number of documents containing the word,
33
34       $tf{$word,$document}
35                 is the number of occurances of word in the document, and
36
37       $maxtf{$document}
38                 is the maximum freqency of any word in document.
39

OPTIONS

41       All options may be abreviated.
42
43       -maxhits maxhits
44                 Maximum numer of hits to display. Default is 15.
45
46       -menu
47       -nomenu   Use the matches as menu for calling "man". Default is -menu.q
48
49       -cbreak
50       -nocbreak Switch to cbreak in menu mode or dont. -cbreak is the
51                 default.
52
53       -verbose  Generates additional information which query words have been
54                 not found in the database and which words of the query are
55                 stopwords.
56

EXAMPLE

58           perlindex foo bar
59
60           1  3.735 lib/pod/perlbot.pod
61           2  2.640 lib/pod/perlsec.pod
62           3  2.153 lib/pod/perldata.pod
63           4  1.920 lib/Symbol.pm
64           5  1.802 lib/pod/perlsub.pod
65           6  1.586 lib/Getopt/Long.pm
66           7  1.190 lib/File/Path.pm
67           8  1.042 lib/pod/perlop.pod
68           9  0.857 lib/pod/perlre.pod
69           a  0.830 lib/Shell.pm
70           b  0.691 lib/strict.pm
71           c  0.691 lib/Carp.pm
72           d  0.680 lib/pod/perlpod.pod
73           e  0.680 lib/File/Find.pm
74           f  0.626 lib/pod/perlsyn.pod
75           Enter Number or 'q'>
76
77       Hitting the keys 1 to "f" will display the corresponding manual page.
78       Hitting "q" quits. All other keys display this manual page.
79

FILES

81       The index will be generated in your man directory. Strictly speaking in
82       "$Config{man1direxp}/.."
83
84           The following files will be generated:
85
86           index_fn           # docid -> (max frequency, filename)
87           index_idf          # term  -> number of documents containing term
88           index_if           # term  -> (docid, frequency)*
89           index_seen         # fn    -> indexed?
90

AUTHOR

92       Ulrich Pfeifer <pfeifer@ls6.informatik.uni-dortmund.de>
93
94
95
96perl v5.34.0                      2022-01-21                      PERLINDEX(1)
Impressum