Debian Codegraph @

upstream/debian-unstable/man3/DBM_Filter::encode.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 "DBM_Filter::encode 3perl"
58 .TH DBM_Filter::encode 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 DBM_Filter::encode \- filter for DBM_Filter
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& use SDBM_File; # or DB_File, GDBM_File, NDBM_File, ODBM_File
69 \& use DBM_Filter ;
70 \&
71 \& $db = tie %hash, ...
72 \& $db\->Filter_Push(\*(Aqencode\*(Aq => \*(Aqiso\-8859\-16\*(Aq);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 This DBM filter allows you to choose the character encoding will be
77 store in the DBM file. The usage is
78 .PP
79 .Vb 1
80 \& $db\->Filter_Push(\*(Aqencode\*(Aq => ENCODING);
81 .Ve
82 .PP
83 where "ENCODING" must be a valid encoding name that the Encode module
84 recognises.
85 .PP
86 A fatal error will be thrown if:
87 .IP 1. 5
88 The Encode module is not available.
89 .IP 2. 5
90 The encoding requested is not supported by the Encode module.
91 .SH "SEE ALSO"
92 .IX Header "SEE ALSO"
93 DBM_Filter, perldbmfilter, Encode
94 .SH AUTHOR
95 .IX Header "AUTHOR"
96 Paul Marquess [email protected]