[examples/replace] Minor fixes to comments and add SYNOPSIS.

This commit is contained in:
Lorenzo Cogotti 2022-12-15 19:36:23 +01:00
parent d056382b5c
commit ba72d29ef9
1 changed files with 4 additions and 1 deletions

View File

@ -2,6 +2,9 @@
-- Basic mass file renamer using osx and -- Basic mass file renamer using osx and
-- standard Lua gsub(). -- standard Lua gsub().
-- --
-- SYNOPSIS:
-- rename.lua <pattern> <replacement> [directory]
--
-- Renames every file inside a directory (defaults to current directory). -- Renames every file inside a directory (defaults to current directory).
-- Trimmed down but functional and useful variant of util-linux rename(1). -- Trimmed down but functional and useful variant of util-linux rename(1).
-- --
@ -9,7 +12,7 @@
-- lua rename.lua 'something' 'something_else' -- lua rename.lua 'something' 'something_else'
-- lua rename.lua '(%w+).lua' '%1.lua.bk' src -- lua rename.lua '(%w+).lua' '%1.lua.bk' src
-- --
-- Author Lorenzo Cogotti, The DoubleFourteen Code Forge -- Author: Lorenzo Cogotti, The DoubleFourteen Code Forge
local io = require 'io' local io = require 'io'
local osx = require 'osx' local osx = require 'osx'