docs: rename.1 verbose, long options and warning
Add new verbose and long options to manual page. I also added warning section which hopefully gets read by people who run the command first time. It might be good idea to make the rename such that it would not overwrite by default, and have a --force option if an use wants that. In current state the rename is somewhat dangerous. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
This commit is contained in:
parent
d200a926df
commit
03b3d715de
|
@ -1,49 +1,57 @@
|
||||||
.\" Written by Andries E. Brouwer (aeb@cwi.nl)
|
.\" Written by Andries E. Brouwer (aeb@cwi.nl)
|
||||||
.\" Placed in the public domain
|
.\" Placed in the public domain
|
||||||
.\"
|
.\"
|
||||||
.TH RENAME 1 "1 January 2000" "" "Linux Programmer's Manual"
|
.TH RENAME "1" "June 2011" "util-linux" "User Commands"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
rename \- rename files
|
rename \- rename files
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B rename
|
.B rename
|
||||||
.IR "from to file" ...
|
[\fIoptions\fR] \fIexpression replacement file\fR...
|
||||||
.br
|
|
||||||
.B rename -V
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.B rename
|
.B rename
|
||||||
will rename the specified files by replacing the first occurrence of
|
will rename the specified files by replacing the first occurrence of
|
||||||
.I from
|
.I expression
|
||||||
in their name by
|
in their name by
|
||||||
.IR to .
|
.IR replacement .
|
||||||
|
.SH OPTIONS
|
||||||
.TP
|
.TP
|
||||||
.BR \-V , " \-\-version"
|
\fB\-v\fR, \fB\-\-verbose\fR
|
||||||
|
Give visual feedback which files where renamed, if any.
|
||||||
|
.TP
|
||||||
|
\fB\-V\fR, \fB\-\-version\fR
|
||||||
Display version information and exit.
|
Display version information and exit.
|
||||||
|
.TP
|
||||||
|
\fB\-h\fR, \fB\-\-help\fR
|
||||||
|
Display help screen and exit.
|
||||||
.SH EXAMPLES
|
.SH EXAMPLES
|
||||||
Given the files
|
Given the files
|
||||||
.IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 ,
|
.IR foo1 ", ..., " foo9 ", " foo10 ", ..., " foo278 ,
|
||||||
the commands
|
the commands
|
||||||
|
|
||||||
.RS
|
.RS
|
||||||
|
.PP
|
||||||
.nf
|
.nf
|
||||||
rename foo foo0 foo?
|
rename foo foo0 foo?
|
||||||
rename foo foo0 foo??
|
rename foo foo0 foo??
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
will turn them into
|
will turn them into
|
||||||
.IR foo001 ", ..., " foo009 ", " foo010 ", ..., " foo278 .
|
.IR foo001 ", ..., " foo009 ", " foo010 ", ..., " foo278 .
|
||||||
|
|
||||||
And
|
And
|
||||||
.RS
|
.RS
|
||||||
|
.PP
|
||||||
.nf
|
.nf
|
||||||
rename .htm .html *.htm
|
rename .htm .html *.htm
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
will fix the extension of your html files.
|
will fix the extension of your html files.
|
||||||
|
.SH WARNING
|
||||||
|
The rename has no safeguards. If user has permission to rewrite file names
|
||||||
|
the command will perform the action without any questions. For example
|
||||||
|
result can be quite drastic when the command is ran as root in /lib
|
||||||
|
directory. Make always a backup before running the command, unless you truly
|
||||||
|
know what you are doing.
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
.BR mmv (1),
|
.BR mmv (1),
|
||||||
.BR mv (1)
|
.BR mv (1)
|
||||||
|
|
Loading…
Reference in New Issue