Debian Codegraph @

upstream/opensuse-tumbleweed/man3/DBM_Filter::encode.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "DBM_Filter::encode 3pm"
61 .TH DBM_Filter::encode 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 DBM_Filter::encode \- filter for DBM_Filter
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use SDBM_File; # or DB_File, GDBM_File, NDBM_File, ODBM_File
72 \& use DBM_Filter ;
73 \&
74 \& $db = tie %hash, ...
75 \& $db\->Filter_Push(\*(Aqencode\*(Aq => \*(Aqiso\-8859\-16\*(Aq);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 This DBM filter allows you to choose the character encoding will be
80 store in the DBM file. The usage is
81 .PP
82 .Vb 1
83 \& $db\->Filter_Push(\*(Aqencode\*(Aq => ENCODING);
84 .Ve
85 .PP
86 where "ENCODING" must be a valid encoding name that the Encode module
87 recognises.
88 .PP
89 A fatal error will be thrown if:
90 .IP 1. 5
91 The Encode module is not available.
92 .IP 2. 5
93 The encoding requested is not supported by the Encode module.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 DBM_Filter, perldbmfilter, Encode
97 .SH AUTHOR
98 .IX Header "AUTHOR"
99 Paul Marquess [email protected]