Debian Codegraph @

upstream/debian-trixie/man3/File::File::Rename::Options.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::Options 3pm"
74 .TH File::Rename::Options 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::Options \- Option processing for File::Rename
81 .SH "SYNOPSIS"
82 .IX Header "SYNOPSIS"
83 .Vb 3
84 \& use File::Rename::Options;
85 \& my $options = File::Rename::Options::GetOptions()
86 \& or pod2usage;
87 \&
88 \& use File::Rename::Options qw(no_require_order);
89 .Ve
90 .SH "DESCRIPTION"
91 .IX Header "DESCRIPTION"
92 .SS "\s-1CONFIGUATION\s0"
93 .IX Subsection "CONFIGUATION"
94 The parameters to \f(CW\*(C`use File::Rename::Options\*(C'\fR are
95 configurations settings for Getopt::Long
96 .PP
97 The default configuration is posix_default and no_ignore_case;
98 other settings are added to this list.
99 .SS "\s-1FUNCTIONS\s0"
100 .IX Subsection "FUNCTIONS"
101 .ie n .IP """GetOptions()""" 4
102 .el .IP "\f(CWGetOptions()\fR" 4
103 .IX Item "GetOptions()"
104 Call \f(CW\*(C`Getopt::Long::GetOptions()\*(C'\fR with options for rename script,
105 returning a \s-1HASH\s0 of options.
106 .ie n .IP """bad_encoding($options)""" 4
107 .el .IP "\f(CWbad_encoding($options)\fR" 4
108 .IX Item "bad_encoding($options)"
109 Test if \fIencoding\fR does not look like an encoding
110 .SS "\s-1OPTIONS\s0"
111 .IX Subsection "OPTIONS"
112 See rename script for options (in \f(CW@ARGV\fR).
113 .PP
114 See File::Rename for structure of the options \s-1HASH\s0
115 .SH "ENVIRONMENT"
116 .IX Header "ENVIRONMENT"
117 No environment variables are used.
118 .SH "SEE ALSO"
119 .IX Header "SEE ALSO"
120 \&\fBFile::Rename\fR\|(3), \fBrename\fR\|(1)
121 .SH "AUTHOR"
122 .IX Header "AUTHOR"
123 Robin Barker <[email protected]>
124 .SH "DIAGNOSTICS"
125 .IX Header "DIAGNOSTICS"
126 Returns \f(CW\*(C`undef\*(C'\fR when there is an error in the options.
127 .SH "COPYRIGHT AND LICENSE"
128 .IX Header "COPYRIGHT AND LICENSE"
129 Copyright (C) 2018, 2022, 2023 by Robin Barker
130 .PP
131 This library is free software; you can redistribute it and/or modify
132 it under the same terms as Perl itself, either Perl version 5.8 or,
133 at your option, any later version of Perl 5 you may have available.