.\" 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 "RENAME 1p"
.TH RENAME 1p "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 \- renames multiple files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBfile-rename\fR
[ \fB\-h\fR|\fB\-m\fR|\fB\-V\fR ]
[ \fB\-v\fR ]
[ \fB\-0\fR ]
[ \fB\-n\fR ]
[ \fB\-f\fR ]
[ \fB\-d\fR ]
[ \fB\-u\fR [\fIenc\fR]]
[ \fB\-e\fR|\fB\-E\fR \fIperlexpr\fR]*|\fIperlexpr\fR
[ \fIfiles\fR ]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`file\-rename\*(C'\fR
renames the filenames supplied according to the rule specified as the
first argument.
The \fIperlexpr\fR 
argument is a Perl expression which is expected to modify the \f(CW$_\fR
string in Perl for at least some of the filenames specified.
If a given filename is not modified by the expression, it will not be
renamed.
If no filenames are given on the command line, filenames will be read
via standard input.
.SS "Examples (Larry Wall,  1992)"
.IX Subsection "Examples (Larry Wall, 1992)"
For example, to rename all files matching \f(CW\*(C`*.bak\*(C'\fR to strip the extension,
you might say
.PP
.Vb 1
\&        file\-rename \-\- \*(Aqs/\e.bak$//\*(Aq *.bak
.Ve
.PP
To translate uppercase names to lower, you'd use
.PP
.Vb 1
\&        file\-rename \*(Aqy/A\-Z/a\-z/\*(Aq ./*
.Ve
.PP
Examples rewritten to avoid globs which could inject options.
.SS "More examples (2020)"
.IX Subsection "More examples (2020)"
You can also use rename to move files between directories, possibly at
the same time as making other changes (but see \fB\-\-filename\fR)
.PP
.Vb 1
\&        file\-rename \*(Aqy/A\-Z/a\-z/;s/^/my_new_dir\e//\*(Aq ./*.*
.Ve
.PP
You can also write the statements separately (see \fB\-e\fR/\fB\-E\fR)
.PP
.Vb 1
\&        file\-rename \-E \*(Aqy/A\-Z/a\-z/\*(Aq \-E \*(Aqs/^/my_new_dir\e//\*(Aq \-\- *.*
.Ve
.PP
You can use the predefined variables \f(CW\*(C`$a, $b\*(C'\fR in the code; 
for instance to create sequences of numbers
.PP
.Vb 1
\&    rename \-e \*(Aq$a++;s/\ew+/file_$a/\*(Aq \-\- *.*
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-v\fR, \fB\-\-verbose\fR" 8
.IX Item "-v, --verbose"
Verbose: print names of files successfully renamed.
.IP "\fB\-0\fR, \fB\-\-null\fR" 8
.IX Item "-0, --null"
Use \e0 as record separator when reading from \s-1STDIN.\s0
.IP "\fB\-n\fR, \fB\-\-nono\fR" 8
.IX Item "-n, --nono"
No action: print names of files to be renamed, but don't rename.
.IP "\fB\-f\fR, \fB\-\-force\fR" 8
.IX Item "-f, --force"
Over write: allow existing files to be over-written.
.IP "\fB\-\-path\fR, \fB\-\-fullpath\fR" 8
.IX Item "--path, --fullpath"
Rename full path: including any directory component.  \s-1DEFAULT\s0
.IP "\fB\-d\fR, \fB\-\-filename\fR, \fB\-\-nopath\fR, \fB\-\-nofullpath\fR" 8
.IX Item "-d, --filename, --nopath, --nofullpath"
Do not rename directory: only rename filename component of path.
.IP "\fB\-h\fR, \fB\-\-help\fR" 8
.IX Item "-h, --help"
Help: print \s-1SYNOPSIS\s0 and \s-1OPTIONS.\s0
.IP "\fB\-m\fR, \fB\-\-man\fR" 8
.IX Item "-m, --man"
Manual: print manual page.
.IP "\fB\-V\fR, \fB\-\-version\fR" 8
.IX Item "-V, --version"
Version: show version number.
.IP "\fB\-u\fR, \fB\-\-unicode\fR [\fIencoding\fR]" 8
.IX Item "-u, --unicode [encoding]"
Treat filenames as perl (unicode) strings when
running the user-supplied code.
.Sp
Decode/encode filenames using \fIencoding\fR, if
present.
.Sp
\&\fIencoding\fR is optional: if omitted, the next argument
should be an option starting with '\-', for instance \fB\-e\fR.
.IP "\fB\-e\fR" 8
.IX Item "-e"
Expression: code to act on files name.
.Sp
May be repeated to build up code (like \f(CW\*(C`perl \-e\*(C'\fR).
If no \fB\-e\fR, the first argument is used as code.
.IP "\fB\-E\fR" 8
.IX Item "-E"
Statement: code to act on files name, as \fB\-e\fR but terminated by ';'.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
No environment variables are used.
.SH "AUTHOR"
.IX Header "AUTHOR"
Larry Wall
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBmv\fR\|(1), \fBperl\fR\|(1)
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
If you give an invalid Perl expression you'll get a syntax error.
.SH "BUGS"
.IX Header "BUGS"
The original
\&\f(CW\*(C`rename\*(C'\fR
did not check for the existence of target filenames,
so had to be used with care.