summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/File::File::Rename::Options.3pm
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/File::File::Rename::Options.3pm
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/File::File::Rename::Options.3pm')
-rw-r--r--upstream/debian-unstable/man3/File::File::Rename::Options.3pm133
1 files changed, 133 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/File::File::Rename::Options.3pm b/upstream/debian-unstable/man3/File::File::Rename::Options.3pm
new file mode 100644
index 00000000..5c2bc3a5
--- /dev/null
+++ b/upstream/debian-unstable/man3/File::File::Rename::Options.3pm
@@ -0,0 +1,133 @@
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "File::Rename::Options 3pm"
+.TH File::Rename::Options 3pm "2024-01-01" "perl v5.36.0" "User Contributed Perl Documentation"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+File::Rename::Options \- Option processing for File::Rename
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 3
+\& use File::Rename::Options;
+\& my $options = File::Rename::Options::GetOptions()
+\& or pod2usage;
+\&
+\& use File::Rename::Options qw(no_require_order);
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+.SS "\s-1CONFIGUATION\s0"
+.IX Subsection "CONFIGUATION"
+The parameters to \f(CW\*(C`use File::Rename::Options\*(C'\fR are
+configurations settings for Getopt::Long
+.PP
+The default configuration is posix_default and no_ignore_case;
+other settings are added to this list.
+.SS "\s-1FUNCTIONS\s0"
+.IX Subsection "FUNCTIONS"
+.ie n .IP """GetOptions()""" 4
+.el .IP "\f(CWGetOptions()\fR" 4
+.IX Item "GetOptions()"
+Call \f(CW\*(C`Getopt::Long::GetOptions()\*(C'\fR with options for rename script,
+returning a \s-1HASH\s0 of options.
+.ie n .IP """bad_encoding($options)""" 4
+.el .IP "\f(CWbad_encoding($options)\fR" 4
+.IX Item "bad_encoding($options)"
+Test if \fIencoding\fR does not look like an encoding
+.SS "\s-1OPTIONS\s0"
+.IX Subsection "OPTIONS"
+See rename script for options (in \f(CW@ARGV\fR).
+.PP
+See File::Rename for structure of the options \s-1HASH\s0
+.SH "ENVIRONMENT"
+.IX Header "ENVIRONMENT"
+No environment variables are used.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBFile::Rename\fR\|(3), \fBrename\fR\|(1)
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Robin Barker <RMBarker@cpan.org>
+.SH "DIAGNOSTICS"
+.IX Header "DIAGNOSTICS"
+Returns \f(CW\*(C`undef\*(C'\fR when there is an error in the options.
+.SH "COPYRIGHT AND LICENSE"
+.IX Header "COPYRIGHT AND LICENSE"
+Copyright (C) 2018, 2022, 2023 by Robin Barker
+.PP
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.8 or,
+at your option, any later version of Perl 5 you may have available.