Skip to content

Commit

Permalink
README cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
jimsalterjrs committed Oct 14, 2015
1 parent f13bbdd commit 98ec039
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ A simple script to rename all files in a folder, and create a simple CSV file in

There are no prerequisites or dependencies beyond Perl itself: just download it, make sure it's executable, and run it. On Linux or BSD or Mac, you should already have Perl, and I'd recommend putting it in `/usr/local/bin` and `chmod 755 /usr/local/bin/blindrename.pl`, after which you can just type **blindrename.pl** ***foldername*** and it will obligingly do its thing. On Windows... well, do whatever you need to do to run a Perl script on Windows. (If you're a lost little scientist with only Windows: check out <a href="http://www.cygwin.com/" target="_blank">Cygwin</a> or <a href="http://www.activestate.com/activeperl" target="_blank">ActivePerl</a> for Windows implementations of Perl.)

`blindrename.pl` is reasonably smart - it will test to make sure that you supply a foldername, and that the foldername exists and is a folder. It also refuses to blindrename a folder *twice* - if there's already a `keyfile.csv` present, it'll die and let you know why. It logs each rename to `keyfile.csv` *before* actually performing the operation, and will die if it can't successfully rename a file. Finally, it won't traverse subdirectories, and it won't rename dotfiles. With all that said... this is still a potentially **really destructive** operation. **Don't** run `blindrename.pl` on any important system folders, please... including but not limited to your own home folder!
`blindrename.pl` is reasonably smart - it will test to make sure that you supply a foldername, and that the foldername exists and is a folder. It also refuses to blindrename a folder *twice* - if there's already a `keyfile.csv` present, it'll die and let you know why. It logs each rename to `keyfile.csv` *before* actually performing the operation, and will die if it can't successfully rename a file. Finally, it will refuse to run as root, won't traverse subdirectories, and won't rename dotfiles. With all that said... this is still a potentially **really destructive** operation. **Don't** run `blindrename.pl` on any important system folders, please... including but not limited to your own home folder!

Sample usage:

Expand Down

0 comments on commit 98ec039

Please # to comment.