diff --git a/examples/rename.lua b/examples/rename.lua index 2f8d1ab..5811e61 100755 --- a/examples/rename.lua +++ b/examples/rename.lua @@ -2,9 +2,12 @@ -- Basic mass file renamer using osx and -- standard Lua gsub(). -- --- Renames every file inside a directory. --- A trimmed down but functional and useful --- variant of util-linux rename(1) +-- Renames every file inside a directory (defaults to current directory). +-- Trimmed down but functional and useful variant of util-linux rename(1). +-- +-- Example uses: +-- lua rename.lua 'something' 'something_else' +-- lua rename.lua '(%w+).lua' '%1.lua.bk' src -- -- Author Lorenzo Cogotti, The DoubleFourteen Code Forge