Fork: 0
tundra / tren
Browse code
Finished section on general attribute renaming tokens.
master
1 parent 0955495 commit 3794f4945196b50f5751273b40077522acbd2210
@tundra tundra authored on 3 Apr 2010
Patch
Unified Split
Showing 1 changed file
View
153
■■■■■
 tren.rst
you need to make use of the User/Group Name renaming tokens
on Windows, consider installing the ``win32all`` extensions
to your Windows Python installation. If you don't, **tren**
will base its order on the generic names ``WindowsUser`` and
``WindowsGroup``. (In any case, User/Group *ID* numbers are
not meaningful under Windows and default to 0. Renaming
``WindowsGroup``.
 
In any case, User/Group *ID* numbers, and the Nlink values
are not meaningful under Windows and default to 0. Renaming
tokens based on these IDs should thus be avoided on Windows
systems since every file- and directory will have the same
ID.)
ID.
 
 
There is one other important detail to keep in mind here. When
**tren** first starts up, it examines the metadata of every file- and
General Attribute Renaming Tokens
=================================
 
 
NOTE TO WINDOWS USERS GOES HERE
 
 
These tokens are derived from information about the file or
directory being renamed.
directory being renamed. (Windows users, see the section above,
`How tren Uses File Metadata`_, on limitatioins of ``/GID/``,
``/GROUP/``, ``/UID/``, ``/USER``, & ``/NLINK/``.)
 
 
``/DEV/ Returns File- Or Directory's Device ID``
 
This is the ID of the device containing the file being renamed.
You might want to rename files so that all the files on a given
device start with the same key. That way, their names group
together in a directory listing::
This is the ID of the device containing the file being
renamed. You might want to rename files so that all the
files on a given device start with the same key. That
way, their names group together in a sorted directory
listing::
 
tren.py -r=/DEV/-/FNAME/ file | dir, file | dir, ...
 
You end up with a directory listing that looks something like::
You end up with a sorted directory listing that looks
something like::
 
93-...
93-...
97-...
98-...
 
The filenames are still preserved in our renaming reqest above,
now they're just preceded by the device ID of the where they live
with a trailing ``-`` separator.
The filenames are still preserved in our renaming reqest
above, now they're just preceded by the device ID of the
where they live with a trailing ``-`` separator.
 
``/FNAME/ Returns Original File- Or Directory Name``
 
This is the name of the file- or directory you are
 
This is the number for the group to which the file- or
directory belongs. One way to use this is to prepend it
to every file name, thereby having all files (and or
directories) in the same group sort together in a
directories) in the same group sort together in a sorted
directory listing::
 
tren.py -r=/GID/-/FNAME/ file | dir ...
tren.py -r=/GID/-/FNAME/ *
 
``/GROUP/ Returns File- Or Directory's Group Name``
Essentially the same as ``/GID/`` except it returns the
*name* of the group rather than the number. Again, this
is useful when clustering names together in a directory listing::
 
tren.py -r=/GROUP/-/FNAME/ file | dir ...
 
``/INODE/ Returns File- Or Directory's``
 
Explanation
 
``/MODE/ Returns File- Or Directory's``
 
Explanation
 
``/NLINK/ Returns File- Or Directory's``
 
Explanation
 
``/SIZE/ Returns File- Or Directory's``
 
Explanation
 
``/UID/ Returns File- Or Directory's``
 
Explanation
 
``/USER/ Returns File- Or Directory's``
 
Explanation
is useful when clustering names together in a sorted
directory listing::
 
tren.py -r=/GROUP/-/FNAME/ *
 
``/INODE/ Returns File- Or Directory's Serial Number``
 
This is typically an identifier to the directory entry
for the file- or directory being renamed. ``/DEV/`` and
``/INODE`` taken together provide a unique systemwide
identifier for the file- or directory being renamed.
 
``/MODE/ Returns File- Or Directory's Permissions``
 
This is a numeric string that represents the permissions
of the file- or directory being renamed in standard Unix
format.
 
``/NLINK/ Returns Number Of Links To File- Or Directory Being Renamed``
 
Most operating systems allow a single file to have
multiple names. These names are "linked" to the an
instance of the file. This replacement token is a
numeric string representing the number of such links.
 
``/SIZE/ Returns File- Or Directory's Length In Bytes``
 
This is handy if you want a sorted directory listing to
list all the files of the same size together. You simply
prepend the file- or directory's length onto its name::
 
tren.py -r=/SIZE/-/FNAME/ *
 
Now all of the files of, say, length 23 will group
together in a sorted directory listing.
 
``/UID/ Returns File- Or Directory's User ID``
 
This is the number for the user that owns the file- or
directory being renamed. One way to use this is to
prepend it to every file name, thereby having all files
(and or directories) owned by the same user cluster
together in a sorted directory listing::
 
tren.py -r=/UID/-/FNAME/ *
 
``/USER/ Returns File- Or Directory's User Name``
Essentially the same as ``/UID/`` except it returns the
*name* of the user rather than the number. Again, this
is useful when clustering names together in a sorted
directory listing::
 
tren.py -r=/USER/-/FNAME/ *
 
 
Time-Related Attribute Renaming Tokens
======================================
-----------------------------
 
::
 
$Id: tren.rst,v 1.171 2010/04/02 20:29:45 tundra Exp $
$Id: tren.rst,v 1.172 2010/04/03 15:40:42 tundra Exp $
 
You can find the latest version of this program at:
 
http://www.tundraware.com/Software/tren