# Table of Contents

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
escape characters anymore when entering your filenames in a terminal. It
also removes unicode characters.

**unixize** is configurable through options. Refer to

```sh
man unixize
```

to get a list of options.


<a id="org0cfb26c"></a>

# Dependencies

-   A C compiler
-   GNU Make


<a id="orge26b09a"></a>

# Installation

You can get **unixize** either through `git` or `fossil`.

For `fossil` use:

```sh
mkdir unixize
cd unixize
fossil clone https://chiselapp.com/user/JozanLeClerc/repository/unixize unixize.fossil
fossil open --force unixize.fossil
```

or for `git`:

```sh
git clone git://jozanleclerc.xyz/jozan/unixize.git
cd unixize
```

Then build the program:

```sh
make
sudo make install clean
```

Note that on BSD systems you want to use `gmake` instead of `make`:

```sh
gmake
sudo gmake install clean
```


<a id="orgaf1a9db"></a>

# 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.

Example of usage:
```sh
cd messy_directory
unixize -R .
tree
  .
  ├── Sub directory
  │  ├── 01. IMG.JPG
  │  ├── archive.tar.xz
  │  └── zxc*:()ASD.qWe
  ├── a file
  ├── Bad-file.mkv
  ├── good_file
  ├── README
  └── ‡‡‡‡song‡‡‡‡.mp3
unixize -R .
tree
  .
  ├── sub_directory
  │  ├── 01_img.jpg
  │  ├── archive.tar.xz
  │  └── zxcasd.qwe
  ├── a_file
  ├── bad_file.mkv
  ├── good_file
  ├── readme
  └── song.mp3
```


<a id="orgf54857b"></a>

# End note

Despite being single-threaded, **unixize** performs well. Used on my whole music
directory (14943 files and directories) on FreeBSD with UFS, the operation
took less than one second.

Please note that unixize was tested only on FreeBSD at the moment.
Linux and macOS tests are coming soon.  You can report bug on
[GitHub](https://github.com/JozanLeClerc/unixize/issues) or on
[Chisel](https://chiselapp.com/user/JozanLeClerc/repository/unixize/ticket).

Thanks for checking **unixize**.