Debian Codegraph @

upstream/debian-trixie/man3/File::File::Rename::Unicode.3pm

raw
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\" ========================================================================
72 .\"
73 .IX Title "File::Rename::Unicode 3pm"
74 .TH File::Rename::Unicode 3pm "2024-01-01" "perl v5.36.0" "User Contributed Perl Documentation"
75 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
76 .\" way too many mistakes in technical documents.
77 .if n .ad l
78 .nh
79 .SH "NAME"
80 File::Rename::Unicode \- Unicode wrapper for user code for File::Rename
81 .SH "SYNOPSIS"
82 .IX Header "SYNOPSIS"
83 .Vb 2
84 \& require File::Rename::Unicode;
85 \& my $sub = File::Rename::Unicode::code($code, $enc);
86 .Ve
87 .SH "DESCRIPTION"
88 .IX Header "DESCRIPTION"
89 .SS "\s-1FUNCTIONS\s0"
90 .IX Subsection "FUNCTIONS"
91 .ie n .IP """code()""" 4
92 .el .IP "\f(CWcode()\fR" 4
93 .IX Item "code()"
94 Wrap the call to user code in utf8/unicode features.
95 .SS "\s-1OPTIONS\s0"
96 .IX Subsection "OPTIONS"
97 See rename script \-\-unicode option
98 .PP
99 See File::Rename for unicode_strings option
100 .SH "ENVIRONMENT"
101 .IX Header "ENVIRONMENT"
102 No environment variables are used.
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 \&\fBFile::Rename\fR\|(3), \fBrename\fR\|(1)
106 .SH "AUTHOR"
107 .IX Header "AUTHOR"
108 Robin Barker <[email protected]>
109 .SH "DIAGNOSTICS"
110 .IX Header "DIAGNOSTICS"
111 None
112 .SH "COPYRIGHT AND LICENSE"
113 .IX Header "COPYRIGHT AND LICENSE"
114 Copyright (C) 2021 by Robin Barker
115 .PP
116 This library is free software; you can redistribute it and/or modify
117 it under the same terms as Perl itself, either Perl version 5.8 or,
118 at your option, any later version of Perl 5 you may have available.