Debian Codegraph @

upstream/debian-unstable/man3/File::File::Rename::Options.3pm

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