1DETOX(1)                  BSD General Commands Manual                 DETOX(1)
2

NAME

4     inline-detox — clean up filenames (stream-based)
5

SYNOPSIS

7     inline-detox [-hnLrv] [-s -sequence] [-f -configfile] file ...
8

DESCRIPTION

10     The inline-detox utility can remove spaces and other such annoyances from
11     streams.  It'll also translate or cleanup Latin-1 (ISO 8859-1) characters
12     encoded in 8-bit ASCII, Unicode characters encoded in UTF-8, and CGI
13     escaped characters.  Basically it's detox, but does not operate on files.
14
15   Sequences
16     inline-detox is driven by a configurable series of filters, called a
17     sequence.  Sequences are covered in more detail in detoxrc(5) and are
18     discoverable with the -L option.  Some examples of default sequences are
19     iso8859_1 and utf_8.
20
21   Options
22     The main options:
23
24     -f configfile
25                 Use configfile instead of the default configuration files for
26                 loading translation sequences.  No other config file will be
27                 parsed.
28
29     -h --help   Display helpful information.
30
31     -L          List the currently available sequences.  When paired with -v
32                 this option shows what filters are used in each sequence and
33                 any properties applied to the filters.
34
35     -r          Recurse into subdirectories.
36
37     -s sequence
38                 Use sequence instead of default.
39
40     -v          Be verbose about which files are being renamed.
41
42     -V          Show the current version of inline-detox.
43
44   Deprecated Options
45     Deprecated Options are options that were available in earlier versions of
46     inline-detox but have lost their meaning and are being phased out.
47
48     --remove-trailing
49                 Removes _ and - after .'s in filenames.  This was first pro‐
50                 vided in the 0.9 series of inline-detox.  After the introduc‐
51                 tion of sequences, it lost its meaning, as you could now
52                 determine the properties of wipeup through a particular
53                 sequence's configuration.  It presently forces all instances
54                 of the wipeup filter to use remove trailing, regardless of
55                 what's actually in the config files.
56

FILES

58     detoxrc        The system-wide detoxrc file.
59     ~/.detoxrc     A user's personal detoxrc.  Normally it extends the sys‐
60                    tem-wide detoxrc, unless -f has been specified, in which
61                    case, it is ignored.
62     iso8859_1.tbl  The default ISO 8859-1 translation table.
63     unicode.tbl    The default Unicode (UTF-8) translation table.
64

EXAMPLES

66     echo Foo Bar | inline-detox -s iso8859_1 -v
67                 Will run the sequence iso8859_1 listing any changes and
68                 returning the result to STDOUT.
69

SEE ALSO

71     detox(1), detoxrc(5), detox.tbl(5).
72

HISTORY

74     detox was originally designed to clean up files that I had received from
75     friends which had been created using other operating systems.  It's triv‐
76     ial to create a filename with spaces, parenthesis, brackets, and amper‐
77     sands under some operating systems.  These have special meaning within
78     FreeBSD and Linux, and cause problems when you go to access them.  I cre‐
79     ated inline-detox to clean up these files.
80

AUTHORS

82     inline-detox was written by Doug Harple.
83

BUGS

85     Long options don't work under Solaris or Darwin.
86
87     An error in the config file will cause a segfault as it's going to print
88     the offending word within the config file.
89
90BSD                             August 3, 2004                             BSD
Impressum