Difference between revisions of "Tr (coreutils)"
|Line 165:||Line 165:|
$ echo "AAAefgAAA" | tr '[e-g]' '[x-z]'
$ echo "AAAefgAAA" | tr '[e-g]' '[x-z]'
Latest revision as of 07:26, 1 July 2020
tr [option]... set1 [set2]
tr copies standard input to standard output, performing one of the following operations:
- translate, and optionally squeeze repeated characters in the result;
- squeeze repeated characters;
- delete characters; or
- delete characters, then squeeze repeated characters from the result.
The set1 and (if given) set2 arguments define ordered sets of characters, referred to below as set1 and set2. These sets are the characters of the input that tr operates on. The --complement (-c, -C) option replaces set1 with its complement (all of the characters that are not in set1).
Currently tr fully supports only single-byte characters. Eventually it will support multibyte characters; when it does, the -C option will cause it to complement the set of characters, whereas -c will cause it to complement the set of values. This distinction will matter only when some values are not characters, and this is possible only in locales using multibyte encodings when the input contains encoding errors.
The program accepts the --help and --version options. See Common options. Options must precede operands.
An exit status of zero indicates success, and a nonzero value indicates failure.
Specifying sets of characters
The format of the set1 and set2 arguments resembles the format of regular expressions; however, they are not regular expressions, only lists of characters. Most characters simply represent themselves in these strings, but the strings can contain the shorthands listed below, for convenience. Some of them can be used only in set1 or set2, as noted below.
The following backslash escape sequences are recognized:
\a # Control-G \b # Control-H \f # Control-L \n # Control-J \r # Control-M \t # Control-I \v # Control-K \\ # A backslash \ooo
The 8-bit character with the value given by
ooo, which is 1 to 3 octal digits. Note that '
\400' is interpreted as the two-byte sequence, '
While a backslash followed by a character not listed above is interpreted as that character, the backslash also effectively removes any special significance, so it is useful to escape '[', ']', '*', and '-'.
The notation '
m-n' expands to all of the characters from
n, in ascending order.
m should collate before
n; if it does not, an error results. As an example, '
0-9' is the same as '
gnu tr does not support the System V syntax that uses square brackets to enclose ranges. Translations specified in that format sometimes work as expected, since the brackets are often transliterated to themselves. However, they should be avoided because they sometimes behave unexpectedly. For example, "
tr -d '[0-9]'" deletes brackets as well as digits.
Many historically common and even accepted uses of ranges are not portable. For example, on EBCDIC hosts using the 'A-Z' range will not do what most would expect because 'A' through 'Z' are not contiguous as they are in ASCII. If you can rely on a POSIX compliant version of tr, then the best way to work around this is to use character classes (see below). Otherwise, it is most portable (and most ugly) to enumerate the members of the ranges.
The notation '[c*n]' in set2 expands to n copies of character c. Thus, '[y*6]' is the same as 'yyyyyy'. The notation '[c*]' in string2 expands to as many copies of c as are needed to make set2 as long as set1. If n begins with '0', it is interpreted in octal, otherwise in decimal.
The notation '[:class:]' expands to all of the characters in the (predefined) class class. The characters expand in no particular order, except for the upper and lower classes, which expand in ascending order. When the --delete (-d) and --squeeze-repeats (-s) options are both given, any character class can be used in set2. Otherwise, only the character classes lower and upper are accepted in set2, and then only if the corresponding character class (upper and lower, respectively) is specified in the same relative position in set1. Doing this specifies case conversion. The class names are given below; an error results when an invalid class name is given.
alnum: Letters and digits.
blank: Horizontal whitespace.
cntrl: Control characters.
graph: Printable characters, not including space.
lower: Lowercase letters.
punct: Punctuation characters.
space: Horizontal or vertical whitespace.
upper: Uppercase letters.
xdigit: Hexadecimal digits.
The syntax '[=c=]' expands to all of the characters that are equivalent to c, in no particular order. Equivalence classes are a relatively recent invention intended to support non-English alphabets. But there seems to be no standard way to define them or determine their contents. Therefore, they are not fully implemented in gnu tr; each character's equivalence class consists only of that character, which is of no particular use.
tr performs translation when set1 and set2 are both given and the --delete (-d) option is not given. tr translates each character of its input that is in set1 to the corresponding character in set2. Characters not in set1 are passed through unchanged. When a character appears more than once in set1 and the corresponding characters in set2 are not all the same, only the final one is used. For example, these two commands are equivalent:
tr aaa xyz tr a z
A common use of tr is to convert lowercase characters to uppercase. This can be done in many ways. Here are three of them:
tr abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ tr a-z A-Z tr '[:lower:]' '[:upper:]'
But note that using ranges like a-z above is not portable.
When tr is performing translation, set1 and set2 typically have the same length. If set1 is shorter than set2, the extra characters at the end of set2 are ignored.
On the other hand, making set1 longer than set2 is not portable; POSIX says that the result is undefined. In this situation, BSD tr pads set2 to the length of set1 by repeating the last character of set2 as many times as necessary. System V tr truncates set1 to the length of set2.
By default, gnu tr handles this case like BSD tr. When the --truncate-set1 (-t) option is given, gnu tr handles this case like the System V tr instead. This option is ignored for operations other than translation.
Acting like System V tr in this case breaks the relatively common BSD idiom:
tr -cs A-Za-z0-9 '\012'
because it converts only zero bytes (the first element in the complement of set1), rather than all non-alphanumerics, to newlines.
By the way, the above idiom is not portable because it uses ranges, and it assumes that the octal code for newline is 012. Assuming a POSIX compliant tr, here is a better way to write it:
tr -cs '[:alnum:]' '[\n*]'
Squeezing repeats and deleting
When given just the --delete (-d) option, tr removes any input characters that are in set1.
When given just the --squeeze-repeats (-s) option, tr replaces each input sequence of a repeated character that is in set1 with a single occurrence of that character.
When given both --delete and --squeeze-repeats, tr first performs any deletions using set1, then squeezes repeats from any remaining characters using set2.
The --squeeze-repeats option may also be used when translating, in which case tr first performs translation, then squeezes repeats from any remaining characters using set2.
Here are some examples to illustrate various combinations of options:
- Remove all zero bytes:
tr -d '\0'
- Put all words on lines by themselves. This converts all non-alphanumeric characters to newlines, then squeezes each string of repeated newlines into a single newline:
tr -cs '[:alnum:]' '[\n*]'
- Convert each sequence of repeated newlines to a single newline:
tr -s '\n'
- Find doubled occurrences of words in a document. For example, people often write "the the" with the repeated words separated by a newline. The Bourne shell script below works first by converting each sequence of punctuation and blank characters to a single newline. That puts each "word" on a line by itself. Next it maps all uppercase characters to lower case, and finally it runs uniq with the -d option to print out only the words that were repeated.
#!/bin/sh cat -- "$@" \ | tr -s '[:punct:][:blank:]' '[\n*]' \ | tr '[:upper:]' '[:lower:]' \ | uniq -d
- Deleting a small set of characters is usually straightforward. For example, to remove all 'a's, 'x's, and 'M's you would do this:
tr -d axM
However, when '-' is one of those characters, it can be tricky because '-' has special meanings. Performing the same task as above but also removing all '-' characters, we might try
tr -d -axM, but that would fail because tr would try to interpret -a as a command-line option. Alternatively, we could try putting the hyphen inside the string, tr -d a-xM, but that would not work either because it would make tr interpret a-x as the range of characters 'a'...'x' rather than the three. One way to solve the problem is to put the hyphen at the end of the list of characters:
tr -d axM-
Or you can use '--' to terminate option processing:
tr -d -- -axM
More generally, use the character class notation [=c=] with '-' (or any other character) in place of the 'c':
tr -d '[=-=]axM'
Note how single quotes are used in the above example to protect the square brackets from interpretation by a shell.
$ echo "@foo" | tr \@ \^ ^foo
- Replace ("squeeze" out) multiple spaces with a single space:
$ echo "foo bar baz" | tr -s ' ' ' ' foo bar baz
- Selective deleting of characters
$ echo "foo bar baz" | tr -d 'ba' foo r z
- Selective character replacement
$ echo "AAAefgAAA" | tr '[efg]' '[xyz]' # ~OR~ $ echo "AAAefgAAA" | tr '[e-g]' '[x-z]' AAAxyzAAA
- Obfuscate one's email address (in this case, mine):
$ echo "firstname.lastname@example.org" | tr 'A-M N-Z a-m n-z' 'N-Z A-M n-z a-m' # ~OR~ $ tr 'P-~\!-O' '\!-~' <<<"49C:DE@A9]492>Ao8>2:=]4@>"
- Most of the above was taken directly from the GNU Coreutils Manual on 2013-02-06 (with my own formatting).