---
name: "File::File::Rename::Options"
section: "3pm"
platform: "linux"
package: "rename"
version: "2.02-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/File::File::Rename::Options"
---

# File::File::Rename::Options(3pm)

Option processing for File::Rename

## NAME

File::Rename::Options - Option processing for File::Rename

## SYNOPSIS

```
    use File::Rename::Options;
    my $options = File::Rename::Options::GetOptions()
        or pod2usage;
    use File::Rename::Options qw(no_require_order);
```

## DESCRIPTION

### CONFIGUATION

The parameters to `"use File::Rename::Options"` are  configurations settings for Getopt::Long

The default configuration is posix\_default and no\_ignore\_case; other settings are added to this list.

### FUNCTIONS

- "GetOptions()"

  Call `"Getopt::Long::GetOptions()"` with options for rename script, returning a HASH of options.

- "bad\_encoding($options)"

  Test if *encoding* does not look like an encoding

### OPTIONS

See rename script for options (in `@ARGV`).

See File::Rename for structure of the options HASH

## ENVIRONMENT

No environment variables are used.

## SEE ALSO

**File::Rename**(3), [**rename**(1)](/rename/1.md)

## AUTHOR

Robin Barker \<RMBarker@cpan.org\>

## DIAGNOSTICS

Returns `"undef"` when there is an error in the options.

## COPYRIGHT AND LICENSE

Copyright (C) 2018, 2022, 2023 by Robin Barker

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.