Debian Codegraph @

upstream/debian-unstable/man3/Search::Dict.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Search::Dict 3perl"
58 .TH Search::Dict 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Search::Dict \- look \- search for key in dictionary file
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& use Search::Dict;
69 \& look *FILEHANDLE, $key, $dict, $fold;
70 \&
71 \& use Search::Dict;
72 \& look *FILEHANDLE, $params;
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 Sets file position in FILEHANDLE to be first line greater than or equal
77 (stringwise) to \fR\f(CI$key\fR\fI\fR. Returns the new file position, or \-1 if an error
78 occurs.
79 .PP
80 The flags specify dictionary order and case folding:
81 .PP
82 If \fR\f(CI$dict\fR\fI\fR is true, search by dictionary order (ignore anything but word
83 characters and whitespace). The default is honour all characters.
84 .PP
85 If \fR\f(CI$fold\fR\fI\fR is true, ignore case. The default is to honour case.
86 .PP
87 If there are only three arguments and the third argument is a hash
88 reference, the keys of that hash can have values \f(CW\*(C`dict\*(C'\fR, \f(CW\*(C`fold\*(C'\fR, and
89 \&\f(CW\*(C`comp\*(C'\fR or \f(CW\*(C`xfrm\*(C'\fR (see below), and their corresponding values will be
90 used as the parameters.
91 .PP
92 If a comparison subroutine (comp) is defined, it must return less than zero,
93 zero, or greater than zero, if the first comparand is less than,
94 equal, or greater than the second comparand.
95 .PP
96 If a transformation subroutine (xfrm) is defined, its value is used to
97 transform the lines read from the filehandle before their comparison.