From 9ba4a97c3782c77d61bdcc3db1bdd900cf7ae0f4 Mon Sep 17 00:00:00 2001 From: jozan Date: Fri, 27 Nov 2020 23:33:15 +0000 Subject: Good FossilOrigin-Name: 0467e723b7ff9101ab44ef15e3addb8b8106f142536bffbbbbac0e73818ceb2c --- README.org | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 0c1f799..bb261be 100644 --- a/README.org +++ b/README.org @@ -1,6 +1,6 @@ #+TITLE: unixize -*unixize* is a very small tool to bulk rename files into a cool UNIX-friendly +*unixize* is a small tool to bulk rename files into a cool UNIX-friendly standard. Basically, everything becomes lowercase and there is no need to escape characters anymore when entering your filenames in a terminal. It also removes unicode characters. @@ -35,8 +35,25 @@ Then build the program: make sudo make install clean #+END_SRC +Note that on BSD systems you want to use ~gmake~ instead of ~make~: +#+BEGIN_SRC shell +gmake +sudo gmake install clean +#+END_SRC + +* Usage +*USE WITH CAUTION*. Without the ~-p~ option, *unixize* will commit to do exactly +what it's supposed to do, rename all the badly formatted in the chosen +directory. To deunixize your files, you'll have to rename everything +manually. +#+BEGIN_SRC shell +cd messy_directory +unixize -v -r . +#+END_SRC * End note Please note that unixize was tested only on FreeBSD at the moment. Linux and macOS tests are coming soon. You can report bug on [[https://github.com/JozanLeClerc/unixize.git][GitHub]]. + +Thanks for checking *unixize*. -- cgit v1.2.3