`rename-flac` is a command-line tool that takes the information from FLAC
metadata to batch rename the files according to a filenaming scheme.

# Dependencies

This program is written in Python3. You will need these to run `rename-flac`
correctly:

* python3
* metaflac

If you are using FLAC files, metaflac should already be installed by default.
On Debian distros type this to install the dependencies:

    $ sudo apt install python3 flac

# Installation

## In Debian

`rename-flac` is in Debian and other Debian-based distributions (like Ubuntu)!
You can install it using:

    $ sudo apt install rename-flac

## Manually

Since `rename-flac` is a single python file, you can call you can it directly:

    $ python3 /path/to/rename_flac.py

## Building the man page

The man page for `rename-flac` can be generated using the `rst2man` command line
tool provided by the Python docutils project:

    $ rst2man manpage.rst rename-flac.1

# CLI options

     $ rename-flac "%n - %t" "/media/Main/Musique/The Beatles"

The example above renames files to look like this: `01 - Yellow Submarine.flac`.

The complete CLI parameters can be found below.

    Usage:
        rename-flac <scheme> <directory> [--verbose] [--sanitize-slash [CHAR]]
        rename-flac (-h | --help)
        rename-flac --version
    
    Arguments:
        <scheme>	The filenaming scheme. Has to be between quotation marks
        <directory>	The path to the directory containing the album
    
    Options:
        -h  --help               Shows the help screen
        --sanitize-slash [CHAR]  Replace "/" in metadata with a filesystem-safe
                                 character. Defaults to "∕" (Division Slash U+2215)
        --version                Outputs version information
        --verbose                Runs the program as verbose mode
    
        These are the options you can use to define the filenaming scheme:
          %a = Artist  |  %b = Album        |  %c = Composer  |  %d = Date
          %g = Genre   |  %n = Tracknumber  |  %t = Title
