USE OPTIONS

Parameters to "use File::Rename" consists of functions to be imported and configuration options.

The only exported function is "rename()". The configuation options are preceded by :config, and are passed to File::Rename::Options.

FUNCTIONS

"rename( FILES, CODE [, VERBOSE])"

rename FILES using CODE, if FILES is empty read list of files from stdin

"rename_files( CODE, VERBOSE, FILES)"

rename FILES using CODE

"rename_list( CODE, VERBOSE, HANDLE [, FILENAME])"

rename a list of file read from HANDLE, using CODE

OPTIONS

FILES

List of files to be renamed, for "rename" must be an ARRAY reference

CODE

Subroutine to change file names, for "rename" can be a string, otherwise it is a code reference

VERBOSE

Flag for printing names of files successfully renamed, optional for "rename"

HANDLE

Filehandle to read file names to be renames

FILENAME (Optional)

Name of file that HANDLE reads from

HASH

Either CODE or VERBOSE can be a HASH of options.

If CODE is a HASH, VERBOSE is ignored and CODE is supplied by the _code key.

Other options are

verbose

As VERBOSE above, provided by -v.

input_null

Input separator \0 when reading file names from stdin.

no_action

Print names of files to be renamed, but do not rename (i.e. take no action), provided by -n.

over_write

Allow files to be over-written by the renaming, provided by -f.

filename_only

Only apply renaming to the filename component of the path, provided by -d.

show_help

Print help, provided by -h.

show_manual

Print manual page, provided by -m.

show_version

Print version number, provided by -V.

unicode_strings

Enable unicode_strings feature, provided by -u.

encoding

Encoding for filenames, provided by -u.

EXPORT

rename