Modified README to reflects COPYING changes.
[anime_rename.git] / README
blobe9137b86d235628c4bb551aa551da9b120120818
1 anime_rename documentation.
3 Suppose that you have the next directory:
5   $ ls anime_directory/
7   [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_08_[XVID+MP3][704x396][D1CD64FB].avi
8   [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_09_[XVID+MP3][704x396][29313464].avi
9   [volans]_Zoku_Sayonara_Zetsubou_Sensei_10_[4B243239].mkv
10   [volans]_Zoku_Sayonara_Zetsubou_Sensei_11_[xvid][99404FE2].avi
11   [volans]_Zoku_Sayonara_Zetsubou_Sensei_12_[xvid][4CB01B32].avi
12   [volans]_Zoku_Sayonara_Zetsubou_Sensei_13_[h264][243F017A].mkv
15 And you want your files to be renamed this way:
17   [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_08_[XVID+MP3][704x396][D1CD64FB].avi
18           -> zoku_08.avi
19   [anon]_Zoku_Sayonara_Zetsubou_Sensei_-_09_[XVID+MP3][704x396][29313464].avi
20           -> zoku_09.avi
21   [volans]_Zoku_Sayonara_Zetsubou_Sensei_10_[4B243239].mkv
22           -> zoku_10.mkv
23   [volans]_Zoku_Sayonara_Zetsubou_Sensei_11_[xvid][99404FE2].avi
24           -> zoku_11.avi
25   [volans]_Zoku_Sayonara_Zetsubou_Sensei_12_[xvid][4CB01B32].avi
26           -> zoku_12.avi
27   [volans]_Zoku_Sayonara_Zetsubou_Sensei_13_[h264][243F017A].mkv
28           -> zoku_13.mkv
30 Anime rename will extract the ``index'' (the representative digits, by default
31     extracts 2 ``isolated' digits) of each file and its extension then use it to
32 rename the file using a user-specified prefix.
34   $ anime_rename --prefix=zoku anime_directory/*Zoku*
36 Will do the renaming duty.
38 and now
40   $ ls anime_directory/
42   zoku_08.avi
43   zoku_09.avi
44   zoku_10.mkv
45   zoku_11.avi
46   zoku_12.avi
47   zoku_13.mkv
49 LICENSING: See COPYING for more info.