aboutsummaryrefslogtreecommitdiff
path: root/system/detox/README
diff options
context:
space:
mode:
authorPierre Cazenave <pwcazenave at gmail {dot} com>2011-02-06 10:47:37 -0600
committerRobby Workman <rworkman@slackbuilds.org>2011-02-06 10:47:37 -0600
commit32ac5f7a61445600f398415a9bcb838a59c2fd17 (patch)
tree7782b2ffd556d4fe0bc8dce7587037af92a1536a /system/detox/README
parentc85ed639024e766970985d61907a496473655ec9 (diff)
system/detox: Added (filename cleanup utility)
Signed-off-by: Robby Workman <rworkman@slackbuilds.org>
Diffstat (limited to 'system/detox/README')
-rw-r--r--system/detox/README26
1 files changed, 26 insertions, 0 deletions
diff --git a/system/detox/README b/system/detox/README
new file mode 100644
index 0000000000000..c7765b4cf1c65
--- /dev/null
+++ b/system/detox/README
@@ -0,0 +1,26 @@
+Detox is a utility designed to clean up filenames. It replaces
+difficult to work with characters, such as spaces, with standard
+equivalents. It will also clean up filenames with UTF-8 or Latin-1
+(or CP-1252) characters in them. Some features include:
+
+* Removal or replacement of upper ASCII Latin-1 (ISO8859-1)
+characters (i.e. left facing and right facing double quotes).
+Whenever possible a replacement character will be used (i.e. an
+"A" will take the place of an "A" with an accent mark over it).
+* Removal or replacement of UTF-8 encoded Unicode characters.
+This operates along the same line as the ISO 8859-1 translation,
+except the scope of Unicode is much larger
+* Removal or replacement of spaces and other potentially tricky
+characters, such as (, ), and @. Removal of any "-"s at the
+beginning of the filename
+* Removal or replacement of CGI escaped ASCII characters, i.e.
+%20 becomes " " (which then becomes "_").
+* Trimming of excessive "_" and "-"s.
+* Directory recursion, dry runs, verbose listings.
+* It's designed with safety in mind. It won't overwrite to a
+file that already exists, and it doesn't touch special files
+normally (but it can be asked to).
+
+Global configuration is in /etc/detoxrc, user-specific configuration
+can be specified in ~/.detoxrc. A sample configuration file is
+provided (/etc/detoxrc.sample).