|DETOX(1)||General Commands Manual||DETOX(1)|
detox — clean up
detox utility renames files to make
them easier to work with. It removes spaces and other such annoyances. It'll
also translate or cleanup Latin-1 (ISO 8859-1) characters encoded in 8-bit
ASCII, Unicode characters encoded in UTF-8, and CGI escaped characters.
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. Some examples of default sequences are
The main options:
- Use configfile instead of the default configuration files for loading translation sequences. No other config file will be parsed.
- Display helpful information.
- 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.
- Doesn't actually change anything. This implies the
- Recurse into subdirectories.
- Use sequence instead of default.
- Works on special files (including links). Normally
detoxignores these files.
- Be verbose about which files are being renamed.
- Show the current version of
Deprecated Options are options that were available in earlier
detox but have lost their meaning and
are being phased out.
- Removes _ and - after .'s in filenames. This was first provided in the 0.9
detox. After the introduction of sequences, it lost its meaning, as you could now determine the properties of wipeup through a particular sequence's configuration. It presently forces all instances of the wipeup filter to use remove trailing, regardless of what's actually in the config files.
- The system-wide detoxrc file.
- A user's personal detoxrc. Normally it extends the system-wide detoxrc,
-fhas been specified, in which case, it is ignored.
- The default ISO 8859-1 translation table.
- The default Unicode (UTF-8) translation table.
- Will run the sequence iso8859_1 recursively, listing any changes, without changing anything, on the files of /tmp/new_files.
- Will list the sequences within my_detoxrc, showing their filters and options.
detox was originally designed to clean up
files that I had received from friends which had been created using other
operating systems. It's trivial to create a filename with spaces,
parenthesis, brackets, and ampersands under some operating systems. These
have special meaning within FreeBSD and Linux, and cause problems when you
go to access them. I created
detox to clean up these
detox was written by Doug
If, after the translation of a filename is finished, a file
already exists with that same name,
detox will not
rename the file. This could cause a problem with the
max_length filter, if it was imperative that the
files be cut down to a certain length.
Long options don't work under Solaris or Darwin.
An error in the config file will cause a segfault as it's going to print the offending word within the config file.
|February 11, 2021||Debian|