Debian Codegraph @

upstream/debian-unstable/man3/PerlIO::via::QuotedPrint.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 "PerlIO::via::QuotedPrint 3perl"
58 .TH PerlIO::via::QuotedPrint 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 PerlIO::via::QuotedPrint \- PerlIO layer for quoted\-printable strings
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use PerlIO::via::QuotedPrint;
69 \&
70 \& open(my $in, \*(Aq<:via(QuotedPrint)\*(Aq, \*(Aqfile.qp\*(Aq) or
71 \& die "Can\*(Aqt open file.qp for reading: $!\en";
72 \&
73 \& open(my $out, \*(Aq>:via(QuotedPrint)\*(Aq, \*(Aqfile.qp\*(Aq) or
74 \& die "Can\*(Aqt open file.qp for writing: $!\en";
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 This module implements a PerlIO layer that works on files encoded in the
79 quoted-printable format. It will decode from quoted-printable while reading
80 from a handle, and it will encode as quoted-printable while writing to a handle.
81 .SH EXPORTS
82 .IX Header "EXPORTS"
83 \&\fINone\fR.
84 .SH "KNOWN BUGS"
85 .IX Header "KNOWN BUGS"
86 \&\fINone\fR.
87 .SH FEEDBACK
88 .IX Header "FEEDBACK"
89 Patches, bug reports, suggestions or any other feedback is welcome.
90 .PP
91 Patches can be sent as GitHub pull requests at
92 <https://github.com/steve\-m\-hay/PerlIO\-via\-QuotedPrint/pulls>.
93 .PP
94 Bug reports and suggestions can be made on the CPAN Request Tracker at
95 <https://rt.cpan.org/Public/Bug/Report.html?Queue=PerlIO\-via\-QuotedPrint>.
96 .PP
97 Currently active requests on the CPAN Request Tracker can be viewed at
98 <https://rt.cpan.org/Public/Dist/Display.html?Status=Active;Queue=PerlIO\-via\-QuotedPrint>.
99 .PP
100 Please test this distribution. See CPAN Testers Reports at
101 <https://www.cpantesters.org/> for details of how to get involved.
102 .PP
103 Previous test results on CPAN Testers Reports can be viewed at
104 <https://www.cpantesters.org/distro/P/PerlIO\-via\-QuotedPrint.html>.
105 .PP
106 Please rate this distribution on CPAN Ratings at
107 <https://cpanratings.perl.org/rate/?distribution=PerlIO\-via\-QuotedPrint>.
108 .SH "SEE ALSO"
109 .IX Header "SEE ALSO"
110 PerlIO::via,
111 MIME::QuotedPrint.
112 .SH ACKNOWLEDGEMENTS
113 .IX Header "ACKNOWLEDGEMENTS"
114 Based on an example in the standard library module MIME::QuotedPrint in Perl
115 (version 5.8.0).
116 .SH AVAILABILITY
117 .IX Header "AVAILABILITY"
118 The latest version of this module is available from CPAN (see
119 "CPAN" in perlmodlib for details) at
120 .PP
121 <https://metacpan.org/release/PerlIO\-via\-QuotedPrint> or
122 .PP
123 <https://www.cpan.org/authors/id/S/SH/SHAY/> or
124 .PP
125 <https://www.cpan.org/modules/by\-module/PerlIO/>.
126 .PP
127 The latest source code is available from GitHub at
128 <https://github.com/steve\-m\-hay/PerlIO\-via\-QuotedPrint>.
129 .SH INSTALLATION
130 .IX Header "INSTALLATION"
131 See the \fIINSTALL\fR file.
132 .SH AUTHOR
133 .IX Header "AUTHOR"
134 Elizabeth Mattijsen <[email protected] <mailto:[email protected]>>.
135 .PP
136 Steve Hay <[email protected] <mailto:[email protected]>> is now maintaining
137 PerlIO::via::QuotedPrint as of version 0.08.
138 .SH COPYRIGHT
139 .IX Header "COPYRIGHT"
140 Copyright (C) 2002\-2004, 2012 Elizabeth Mattijsen. All rights reserved.
141 .PP
142 Copyright (C) 2015, 2020 Steve Hay. All rights reserved.
143 .SH LICENCE
144 .IX Header "LICENCE"
145 This module is free software; you can redistribute it and/or modify it under
146 the same terms as Perl itself, i.e. under the terms of either the GNU General
147 Public License or the Artistic License, as specified in the \fILICENCE\fR file.
148 .SH VERSION
149 .IX Header "VERSION"
150 Version 0.10
151 .SH DATE
152 .IX Header "DATE"
153 22 May 2022
154 .SH HISTORY
155 .IX Header "HISTORY"
156 See the \fIChanges\fR file.