detox(1) [debian man page]
DETOX(1) BSD General Commands Manual DETOX(1) NAME
detox -- clean up filenames SYNOPSIS
detox [-hnLrv] [-s -sequence] [-f -configfile] [--dry-run] [--special] file ... DESCRIPTION
The 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. Sequences detox is driven by a configurable series of filters, called a sequence. Sequences are covered in more detail in detoxrc(5) and are discover- able with the -L option. Some examples of default sequences are iso8859_1 and utf_8. Options The main 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. -L List the currently available sequences. When paired with -v this 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 -v option. -r Recurse into subdirectories. -s sequence Use sequence instead of default. --special Works on special files (including links). Normally detox ignores these files. -v Be verbose about which files are being renamed. -V Show the current version of detox. Deprecated Options Deprecated Options are options that were available in earlier versions of detox but have lost their meaning and are being phased out. --remove-trailing Removes _ and - after .'s in filenames. This was first provided in the 0.9 series of detox. After the introduction of sequences, it lost its meaning, as you could now determine the properties of wipeup through a particular sequence's configura- tion. It presently forces all instances of the wipeup filter to use remove trailing, regardless of what's actually in the config files. FILES
detoxrc The system-wide detoxrc file. ~/.detoxrc A user's personal detoxrc. Normally it extends the system-wide detoxrc, unless -f has been specified, in which case, it is ignored. iso8859_1.tbl The default ISO 8859-1 translation table. unicode.tbl The default Unicode (UTF-8) translation table. EXAMPLES
detox -s iso8859_1 -r -v -n /tmp/new_files Will run the sequence iso8859_1 recursively, listing any changes, without changing anything, on the files of /tmp/new_files. detox -c my_detoxrc -L -v Will list the sequences within my_detoxrc, showing their filters and options. SEE ALSO
detoxrc(5), detox.tbl(5). HISTORY
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 files. AUTHORS
detox was written by Doug Harple. BUGS
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. BSD
August 3, 2004 BSD
Check Out this Related Man Page
mark(1mh) mark(1mh) Name mark - mark messages Syntax mark [ +folder ] [ msgs ] [ options ] Description Use the command to assign a name to a sequence of messages within the current folder. A sequence is a number of messages that are grouped together under a name. You can then use that name with any MH command instead of a message number, to perform the command on all the messages in the sequence. You can still continue to handle messages individually when they belong to a sequence, just as you did before. Sequences are specific to a particular folder. You can use the same name for sequences in different folders without causing problems. By default, operates on the sequences in the current folder. You can specify another folder by using the +folder argument. When you create a sequence using the ordering of messages within the folder remains unchanged. So if messages 3, 7 and 9 are put into the sequence, they are still numbered as messages 3, 7 and 9 when you use to list the contents of the folder. The command does not show you what sequences messages belong to; you must use to find this information. The command is used only to modify sequences, not messages. If you delete a message from a sequence using it remains in the folder. How- ever, when a message is deleted or moved from a folder (for example, using or it is removed from all the sequences in that folder. Options -add Adds messages to sequences. The command takes the messages specified by the msgs argument, and adds them to the sequence named by using the -sequence name option. If no msgs argument is given, the current message is added to the sequence. This option can also be used in conjunction with the -zero option. This option cannot be used in conjunction with the -delete or -list options. If you attempt to use two or more of these options together, takes the last occurrence of any of them, and ignores any previous occurrences. -delete Deletes messages from sequences. The command removes the messages specified by the msgs argument from the named sequences. As with -add, the sequences are specified using the -sequence name option. If no msgs argument is given, the current message is removed from the named sequences. This option can also be used in conjunction with the -zero option. This option cannot be used in conjunction with the -add or -list options. If you attempt to use two or more of these options together, takes the last occurrence of any of them, and ignores any previous occurrences. -help Prints a list of the valid options to this command. -list Lists the sequences defined for the current folder and the messages associated with those sequences. If you wish to list only particular sequences in a folder, you can specify them by using the -sequence name option. If you do not use this option, lists all the sequences in the current folder. You can also list sequences in another folder by using the +folder argument. This option cannot be used in conjunction with the -add or -delete options. If you attempt to use two or more of these options together, takes the last occurrence of any of them, and ignores any previous occurrences. The command automatically lists the sequences in the folder unless you use the -add or -delete options, or unless you give a msgs argument. -public -nopublic Indicates that the sequence being created should be made readable for other MH users. When you use the -add option to create a sequence, the -public option makes the sequence public, that is, readable to other MH users. By contrast, the -nopublic option indicates that the sequence should be private, or exclusive to your own MH environment. -sequence name... Specifies the sequence(s) you wish to list or modify. You use this option in conjunction with the -add, -delete, and -list options, to name the sequences you wish to add messages to, delete messages from, or list. You can name more than one sequence by listing the names with a space separating them; you do not need to repeat -sequence before each sequence name. -zero -nozero Modifies the behavior of the -add and -delete options. If you use the -zero option with -add, all messages are removed from the named sequence before the new messages are added to it. This means that the sequence contains only the new messages that you have just added. The -nozero option simply adds the new messages to the existing sequence, without deleting any of the messages already in the sequence. This is the default behavior. If you use -zero with -delete, all of the messages in the folder are added to the named sequence, and then the messages you spec- ify are deleted from the sequence. This means that the sequence contains all the messages in the folder except those that you have named. The -nozero option simply removes the messages you specify from the sequence, leaving the rest of the contents of the sequence intact. This is the default behavior. The defaults for this command are: +folder defaults to the current folder msgs defaults to the current message (or all messages if -list is specified) -add if a msgs argument is specified, -list otherwise -nopublic if the folder is read-only, -public otherwise -nozero Restrictions MH allows a maximum of ten sequences in any folder. The names of sequences must consist entirely of alphabetic or numeric characters, and must begin with an alphabetic character. Punctuation is not allowed. In addition, certain names are reserved for use by MH. These include first, next, prev, and cur. Examples The first example shows how lists all the sequences in a named folder: % mark cur: 20 Admail: 1 5 9-12 test: 3-7 This output is identical to that produced by using the -list option. The next example creates a sequence called odd, containing the first five odd-numbered messages: % mark -add -sequence odd 1 3 5 7 9 % mark cur: 20 Admail: 1 5 9-12 odd: 1 3 5 7 9 test: 3-7 The next example deletes message 3 from the sequences test and odd: % mark -delete -sequence test odd 3 % mark cur: 20 Admail: 1 5 9-12 odd: 1 5 7 9 test: 4-7 The final example illustrates how the -zero option works with -add. All messages are first removed from the sequence test, and then mes- sages 1 to 3 are added. The result is that test contains only messages 1 to 3: % mark -add -zero -sequence test 1-3 % mark cur: 20 Admail: 1 5 9-12 odd: 1 5 7 9 test: 1-3 Profile Components Path: To determine your Mail directory Files The user profile. See Also folder(1mh), pick(1mh), sortm(1mh) mark(1mh)