/etc/detoxrc
The system-wide detoxrc file.
detox1
Clean up filenames
Usage
detox [-f
configfile]
[{-n | --dry-run}]
[-r]
[-s
sequence]
[--special]
[-v]
file ...
detox [-L]
[-f
configfile]
[-v]
detox [{-h | --help}]
detox [-V]
Overview
The detox utility renames files to make them easier to work with under Linux and other Unix-like operating systems. It replaces characters that make it hard to type out a filename with dashes and underscores. It also provides transcoding-based filters, converting ISO-8859-1 or CP-1252 to UTF-8. An additional filter unescapes CGI-escaped filenames.
Sequences
detox is driven by a configurable series of filters, called a sequence. Sequences are covered in more detail in detoxrc(5) and are discoverable with the -L option. The default sequence will run the safe and wipeup filters. Other examples of pre-configured sequences are iso8859_1 and iso8859_1-legacy, which both provide transcoding to UTF-8, and then finish with the safe and wipeup filters.
Options
-
-f configfile -
Use configfile instead of the default configuration files for loading translation sequences. No other config file will be parsed.
-
-h, --help -
Display helpful information.
-
--inline -
Run in inline mode. See inline-detox(1) for more details.
-
-L -
List the currently available sequences. When paired with
-vthis option shows what filters are used in each sequence and any properties applied to the filters. -
-n, --dry-run -
Doesn't actually change anything. This implies the
-voption. -
-r -
Recurse into subdirectories. Any file or directory that starts with a period, such as .git/ or .cache/, will be ignored during recursion unless specified on the command line. Also, any file or directory specified in the ignore section of the config file will be ignored during recursion.
-
-s sequence -
Use sequence instead of
default. -
--special -
Works on special files (including links). Normally
detoxignores these files.detoxwill not recurse into symlinks that point at directories. -
-v -
Be verbose about which files are being renamed.
-
-V -
Show the current version of
detox.
Files
-
-
~/.detoxrc -
A user's personal detoxrc. Normally it extends the system-wide detoxrc, unless
-fhas been specified, in which case, it is ignored. -
/usr/share/detox/cp1252.tbl -
The provided CP-1252 transcoding table.
-
/usr/share/detox/iso8859_1.tbl -
The provided ISO-8859-1 transcoding table.
-
/usr/share/detox/safe.tbl -
The provided safe character translation table.
-
/usr/share/detox/unicode.tbl -
The provided Unicode control character filtering table, used by the UTF-8 filter.
Examples
detox-slower-r-v-n/tmp/new_files-
Will run the sequence lower recursively, listing any changes, without changing anything, on the files of /tmp/new_files.
detox-fmy_detoxrc-L-v-
Will list the sequences within my_detoxrc, showing their filters and options.
Caveats
If, after the translation of a filename is finished, a file already exists with that same name, detox will not rename the file.
Releases
10 releases since Debian 5.0 (Lenny); the text changed 4 times.
--inline since Debian 13 (Trixie).
--remove-trailing until Debian 12 (Bookworm).