Debian Codegraph @

upstream/mageia-cauldron/man3pm/DBM_Filter::null.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::null 3pm"
61 .TH DBM_Filter::null 3pm 2023-12-22 "perl v5.42.0" "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::null \- 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, or ODBM_File
72 \& use DBM_Filter ;
73 \&
74 \& $db = tie %hash, ...
75 \& $db\->Filter_Push(\*(Aqnull\*(Aq);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 This filter ensures that all data written to the DBM file is null
80 terminated. This is useful when you have a perl script that needs
81 to interoperate with a DBM file that a C program also uses. A fairly
82 common issue is for the C application to include the terminating null
83 in a string when it writes to the DBM file. This filter will ensure that
84 all data written to the DBM file can be read by the C application.
85 .SH "SEE ALSO"
86 .IX Header "SEE ALSO"
87 DBM_Filter, perldbmfilter
88 .SH AUTHOR
89 .IX Header "AUTHOR"
90 Paul Marquess [email protected]