diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 29 insertions, 19 deletions
@@ -1,10 +1,10 @@ # Table of Contents -1. [Dependencies](#org0b55cd2) -2. [Installation](#orgc36ed01) -3. [Usage](#org06b1425) -4. [End note](#orgd171c54) +1. [Dependencies](#org0cfb26c) +2. [Installation](#orge26b09a) +3. [Usage](#orgaf1a9db) +4. [End note](#orgf54857b) **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 @@ -13,12 +13,14 @@ also removes unicode characters. **unixize** is configurable through options. Refer to - man unixize +```sh +man unixize +``` to get a list of options. -<a id="org0b55cd2"></a> +<a id="org0cfb26c"></a> # Dependencies @@ -26,7 +28,7 @@ to get a list of options. - GNU Make -<a id="orgc36ed01"></a> +<a id="orge26b09a"></a> # Installation @@ -34,7 +36,7 @@ You can get **unixize** either through `git` or `fossil`. For `fossil` use: -``` shell +```sh mkdir unixize cd unixize fossil clone https://chiselapp.com/user/JozanLeClerc/repository/unixize unixize.fossil @@ -43,36 +45,44 @@ fossil open --force unixize.fossil or for `git`: - git clone git://jozanleclerc.xyz/jozan/unixize.git - cd unixize +```sh +git clone git://jozanleclerc.xyz/jozan/unixize.git +cd unixize +``` Then build the program: - make - sudo make install clean +```sh +make +sudo make install clean +``` Note that on BSD systems you want to use `gmake` instead of `make`: - gmake - sudo gmake install clean +```sh +gmake +sudo gmake install clean +``` -<a id="org06b1425"></a> +<a id="orgaf1a9db"></a> # Usage -**USE WITH CAUTION**. +**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. - cd messy_directory - unixize -v -r . +```sh +cd messy_directory +unixize -v -r . +``` -<a id="orgd171c54"></a> +<a id="orgf54857b"></a> # End note |