Further cleanup of the options section.
1 parent c58a3a3 commit 4ac12678d25262a3aa3f1a0f55ed5198f17d9174
@tundra tundra authored on 23 Mar 2010
Showing 1 changed file
View
61
tren.rst
! - Rename all the remaining files without further prompting
q - Quit the program
 
These options are all insensitive to case.
 
If you're doing forced renaming ('``-f``'), this option will
interactively ask you first about making any necessary backups
and then renaming the original target. *If you decline to
do the backup renaming, but accept the renaming of the original
target, the file or directory that already exists with that
name will be lost!*.
 
-C Do case-sensitive renaming
 
(*Default*: This is the program default)
-d Dump debugging information
 
(*Default*: Off)
 
Dumps all manner of information about **tren** internals -
of interest only to program developers and maintainers.
Dumps all manner of information about **tren** internals - of
interest only to program developers and maintainers. This
option provides internal program state *at the time it is
encountered on the command line*. For maximum debug output,
place this as the last (rightmost) option on the command line,
right before the list of files and directories to rename. You
can also place multiple '``-d``' options on the command line to
see how the internal tables of the program change as various
options are parsed.
 
-f Force renaming even if target file or directory name already
exists.
 
With this option enabled, **tren** will print out diagnostic
information about what your command *would* do, *without
actually doing it*.
 
If your renaming requests contain random renaming tokens,
test mode will only show you an approximation of the renaming
to take place (because new random name strings are generated
each time the program runs).
 
-v Print detailed program version information and keep running.
 
This is handy if you're capturing **tren** output into a log
and you want a record of what version of the program was used.
useful when you're capturing **tren** output into
a log and don't want lines wrapped::
 
tren.py -w999 ..... 2>&1 > tren.log
 
**tren** makes sure you don't set this to some
unreasonably small value such that output formatting
would be impossible.
 
-X Treat the renaming strings literally
 
 
TUTORIAL AND DESCRIPTION
------------------------
 
.. WARNING:: **tren** is a powerful file and directory renaming tool.
Be **sure** you know what you're about to do. If you're
not, run the program in test mode (invoke with the '``-t``'
option) to see what would happen. You have been warned!
.. WARNING:: ONE MORE TIME: **tren** is a powerful file and directory
renaming tool. Be **sure** you know what you're about to
do. If you're not, run the program in test mode (invoke
with the '``-t``' option) to see what would happen. You
have been warned!
 
**tren** is a general purpose file and directory renaming tool. Unlike
commands like '``mv``', **tren** is particularly well suited for
renaming *batches* of files and/or directories with a single command
the new name already exists. Such attempts will cause no change to the
file or directory being processed and an error message will be
displayed. This is intentional to force you to manually rename or
remove the file or directory that would have been clobbered by a
rename. You can override this default and *force* a renaming and thus
the removal of such existing files or directories ('``-f``' option).
rename. You can override this default and *force* a renaming via the
'``-f``' option. This will cause the orginal file or dictory itself
to be renamed with a '``.backup``' suffix. You can change this
suffix via the '``-S``' option.
 
**tren** supports a variety of renaming mechanisms. The one thing
they have in common is that you must specify an *old string* which
will be replaced by a *new string* when the file or directory is
-----------------------------
 
::
 
$Id: tren.rst,v 1.140 2010/03/23 19:38:51 tundra Exp $
$Id: tren.rst,v 1.141 2010/03/23 20:19:17 tundra Exp $
 
You can find the latest version of this program at:
 
http://www.tundraware.com/Software/tren