diff --git a/tren.rst b/tren.rst index 49eaf7f..57b33b5 100644 --- a/tren.rst +++ b/tren.rst @@ -1727,43 +1727,54 @@ modification. **tren** implements a set of time-related file attribute renaming -tokens intended to provide full access to these various timestamps. They -are identically named, except that the first letter of each of the -time-related attribute tokens indicates which of the three timestamps -above is used to compute the value: +tokens intended to provide full access to these various timestamps. +As a practical matter, you're most likely to use the ``MTIME``-based +tokens, but components for all three time values are available should +you need them. They are identically named, except that the first +letter of each of the time-related attribute tokens indicates which of +the three timestamps above is used to compute the value: -``/ADAY/, /CDAY/, /MDAY/ Returns File- Or Directory's`` +``/ADAY/, /CDAY/, /MDAY/ Returns Timestamp's Day Of The Month`` - Explanation + Returns the day of the month of the timestamp in ``dd`` format. -``/AHOUR, /CHOUR/, /MHOUR/ Returns File- Or Directory's`` +``/AHOUR, /CHOUR/, /MHOUR/ Returns Timestamp's Hour Of The Day`` - Explanation + Returns the hour of the day of the timestamp in ``hh`` format. -``/AMIN/, /CMIN/, /MMIN/ Returns File- Or Directory's`` +``/AMIN/, /CMIN/, /MMIN/ Returns Timestamp's Minute Of The Hour`` - Explanation + Returns the minute of the hour of the timestamp in ``mm`` format. -``/AMON/, /CMON/, /MMON/ Returns File- Or Directory's`` +``/AMON/, /CMON/, /MMON/ Returns Timestamp's Month Of The Year`` - Explanation + Returns the month of the year of the timestamp in ``mm`` format -``/AMONT, /CMONTH/, /MMONTH/ Returns File- Or Directory's`` +``/AMONTH, /CMONTH/, /MMONTH/ Returns Timestamp's Name Of The Month`` - Explanation + Returns the name of the month of the timestamp in ``Nnn`` format. -``/ASEC/, /CSEC/, /MSEC/ Returns File- Or Directory's`` +``/ASEC/, /CSEC/, /MSEC/ Returns Timestamp's Seconds Of The Minute`` - Explanation + Returns the seconds of the minute of the timestamp in ``ss`` format. -``/AWDAY, /CWDAY/, /MWDAY/ Returns File- Or Directory's`` +``/AWDAY, /CWDAY/, /MWDAY/ Returns Timestamp's Name Of The Day`` - Explanation + Returns the name of the day of the timestamp in ``Ddd`` format. -``/AYEAR, /CYEAR/, /MYEAR/ Returns File- Or Directory's`` +``/AYEAR, /CYEAR/, /MYEAR/ Returns Timestamp's Year`` - Explanation + Returns the year of the timestamp in ``yyyy`` format. + + +So, for example:: + + tren.py -r=/FNAME/-/MYEAR/-/MMON/-/MDAY/-/MMONTH/-/MWDAY/-/MHOUR/:/MMIN/:/MSEC/ foo + +Might rename the file to something like:: + + foo-2005-01-07-Jan-Fri-01:23:33 System Renaming Tokens @@ -2172,7 +2183,7 @@ :: - $Id: tren.rst,v 1.173 2010/04/05 19:31:25 tundra Exp $ + $Id: tren.rst,v 1.174 2010/04/05 19:54:03 tundra Exp $ You can find the latest version of this program at: