Filled in more of the sequence renaming token material.
1 parent f6ac49c commit dbcc6e571acabeba5bf253f464c5ca2c6c592a9f
@tundra tundra authored on 16 Jan 2010
Showing 1 changed file
View
134
tren.rst
you've selected) or to be appended or prepended to the name.
 
Currently, **tren** defines a number of renaming tokens.
 
File Related Renaming Tokens
----------------------------
File Attribute Renaming Tokens
------------------------------
 
These tokens are derived from information about the file or
directory being renamed.
 
This token is replaced with the time of creation
of the file or directory being renamed. It is
in ``HH:MM:SS`` format.
 
``/00nn/ File time sequence, ascending``
 
``/-00nn/ File time sequence, descending``
Sequence Renaming Tokens
------------------------
 
Sometimes it's useful to rename files or directories not based on
their original names. Instead, it can be useful to rename them - in
whole or part, based on some *property they possess* like the date or
time of creation, the size of the file, who owns it, and so on. This
is the purpose of *sequence renaming tokens*.
 
The best way to think of sequence renaming tokens is as *unique
strings* designed to help organize the files or directories you're
renaming based on some *shared property*. The actual order of these
strings reflects something about that shared property.
 
General Format Of Sequence Renaming Tokens
------------------------------------------
 
Sequence renaming tokens have the following general format::
 
/<optional ordering flag and type><counting pattern>/
where,
ordering flag:
+ ascending
- descending
type:
D sequence on file creation date
G sequence on file's group membership
S sequence on file size
T sequence on file creation time within a given day
U sequence on file's owner
empty sequence on order of file renaming
 
 
Count Pattern Format
--------------------
 
In each of the cases below, the counting pattern is mandatory and
describes two things: The number of digits to use, and the starting
number in the sequence. Examples::
 
0001 -> 0001, 0002, 0003, ...
0000 -> 0000, 0001, 0002, ...
03 -> 03, 04, 05, ...
 
You do not have to use a ``0`` to indicate the number of digits to
use. You can use *any* padding characters you like. **tren**
only cares about the width of the field and will "consume" your
padding characters as the count increases.::
 
xxx3 -> xxx3, xxx4, xxx5, ...
-+8 -> -+8, -+9, -10, -11, ...
 
You are not restricted to numbers in a counting pattern. Letters may
also be used. **tren** will preserve the case you specify in the
template when creating sequences like this.::
 
000a -> 000a, 000b, 000c, ...
---X -> ---X, ---Y, ---Z, --AA
 
 
 
System Related Renaming Tokens
------------------------------
-----------------------------
 
::
 
$Id: tren.rst,v 1.117 2010/01/16 19:58:19 tundra Exp $
$Id: tren.rst,v 1.118 2010/01/16 20:50:52 tundra Exp $
 
You can find the latest version of this program at:
 
http://www.tundraware.com/Software/tren