README.md
1# Overview
2
3`detox` is a program that renames files to make them easier to work with under
4Unix and related operating systems. Spaces and various other unsafe
5characters (such as "$") get replaced with "_". ISO 8859-1 (Latin-1)
6characters can be transliterated to ASCII, as can UTF-8 characters.
7More details are contained in the `detox.1` man page.
8
9# Runtime Notes
10
11The most important option to learn is `-n`, aka `--dry-run`. This will let you
12run `detox` without actually changing any files, so that you can get an idea
13of what `detox` is all about.
14
15The simplest way to run `detox` is to just run it on a directory containing
16files that need work:
17
18 detox xfer_files/
19
20You can also just to specify the filename:
21
22 detox my\ bad\ file.txt
23
24You can also specify recursion (this works best on directories):
25
26 detox -r /music/transferred_from_elsewhere/
27
28# Build
29
30To build `detox` from source, run:
31
32```
33git clone https://github.com/dharple/detox.git
34cd detox
35autoreconf --install
36./configure
37make
38```
39
40# Contact
41
42Doug Harple <detox.dharple@gmail.com>
43