1.\" Copyright (c) 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" This code is derived from software contributed to Berkeley by 5.\" the Institute of Electrical and Electronics Engineers, Inc. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 3. All advertising materials mentioning features or use of this software 16.\" must display the following acknowledgement: 17.\" This product includes software developed by the University of 18.\" California, Berkeley and its contributors. 19.\" 4. Neither the name of the University nor the names of its contributors 20.\" may be used to endorse or promote products derived from this software 21.\" without specific prior written permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" @(#)tr.1 8.1 (Berkeley) 6/6/93 36.\" $FreeBSD$ 37.\" 38.Dd October 11, 1997 39.Dt TR 1 40.Os 41.Sh NAME 42.Nm tr 43.Nd translate characters 44.Sh SYNOPSIS 45.Nm 46.Op Fl Ccsu 47.Ar string1 string2 48.Nm 49.Op Fl Ccu 50.Fl d 51.Ar string1 52.Nm 53.Op Fl Ccu 54.Fl s 55.Ar string1 56.Nm 57.Op Fl Ccu 58.Fl ds 59.Ar string1 string2 60.Sh DESCRIPTION 61The 62.Nm 63utility copies the standard input to the standard output with substitution 64or deletion of selected characters. 65.Pp 66The following options are available: 67.Bl -tag -width Ds 68.It Fl C 69Complement the set of characters in 70.Ar string1 , 71that is 72.Dq Fl C Li ab 73includes every character except for 74.Ql a 75and 76.Ql b . 77.It Fl c 78Same as 79.Fl C 80but complement the set of byte values in 81.Ar string1 . 82.It Fl d 83Delete characters in 84.Ar string1 85from the input. 86.It Fl s 87Squeeze multiple occurrences of the characters listed in the last 88operand (either 89.Ar string1 90or 91.Ar string2 ) 92in the input into a single instance of the character. 93This occurs after all deletion and translation is completed. 94.It Fl u 95Guarantee that any output is unbuffered. 96.El 97.Pp 98In the first synopsis form, the characters in 99.Ar string1 100are translated into the characters in 101.Ar string2 102where the first character in 103.Ar string1 104is translated into the first character in 105.Ar string2 106and so on. 107If 108.Ar string1 109is longer than 110.Ar string2 , 111the last character found in 112.Ar string2 113is duplicated until 114.Ar string1 115is exhausted. 116.Pp 117In the second synopsis form, the characters in 118.Ar string1 119are deleted from the input. 120.Pp 121In the third synopsis form, the characters in 122.Ar string1 123are compressed as described for the 124.Fl s 125option. 126.Pp 127In the fourth synopsis form, the characters in 128.Ar string1 129are deleted from the input, and the characters in 130.Ar string2 131are compressed as described for the 132.Fl s 133option. 134.Pp 135The following conventions can be used in 136.Ar string1 137and 138.Ar string2 139to specify sets of characters: 140.Bl -tag -width [:equiv:] 141.It character 142Any character not described by one of the following conventions 143represents itself. 144.It \eoctal 145A backslash followed by 1, 2 or 3 octal digits represents a character 146with that encoded value. 147To follow an octal sequence with a digit as a character, left zero-pad 148the octal sequence to the full 3 octal digits. 149.It \echaracter 150A backslash followed by certain special characters maps to special 151values. 152.Pp 153.Bl -column "\ea" 154.It "\ea <alert character> 155.It "\eb <backspace> 156.It "\ef <form-feed> 157.It "\en <newline> 158.It "\er <carriage return> 159.It "\et <tab> 160.It "\ev <vertical tab> 161.El 162.Pp 163A backslash followed by any other character maps to that character. 164.It c-c 165For non-octal range endpoints 166represents the range of characters between the range endpoints, inclusive, 167in ascending order, 168as defined by the collation sequence. 169If either or both of the range endpoints are octal sequences, it 170represents the range of specific coded values between the 171range endpoints, inclusive. 172.It [:class:] 173Represents all characters belonging to the defined character class. 174Class names are: 175.Pp 176.Bl -column "xdigit" 177.It "alnum <alphanumeric characters> 178.It "alpha <alphabetic characters> 179.It "cntrl <control characters> 180.It "digit <numeric characters> 181.It "graph <graphic characters> 182.It "lower <lower-case alphabetic characters> 183.It "print <printable characters> 184.It "punct <punctuation characters> 185.It "space <space characters> 186.It "upper <upper-case characters> 187.It "xdigit <hexadecimal characters> 188.El 189.Pp 190.\" All classes may be used in 191.\" .Ar string1 , 192.\" and in 193.\" .Ar string2 194.\" when both the 195.\" .Fl d 196.\" and 197.\" .Fl s 198.\" options are specified. 199.\" Otherwise, only the classes ``upper'' and ``lower'' may be used in 200.\" .Ar string2 201.\" and then only when the corresponding class (``upper'' for ``lower'' 202.\" and vice-versa) is specified in the same relative position in 203.\" .Ar string1 . 204.\" .Pp 205When ``[:lower:]'' appears in 206.Ar string1 207and ``[:upper:]'' appears in the same relative position in 208.Ar string2 , 209it represents the characters pairs from the 210.Dv toupper 211mapping in the 212.Ev LC_CTYPE 213category of the current locale. 214When ``[:upper:]'' appears in 215.Ar string1 216and ``[:lower:]'' appears in the same relative position in 217.Ar string2 , 218it represents the characters pairs from the 219.Dv tolower 220mapping in the 221.Ev LC_CTYPE 222category of the current locale. 223.Pp 224With the exception of case conversion, 225characters in the classes are in unspecified order. 226.Pp 227For specific information as to which 228.Tn ASCII 229characters are included 230in these classes, see 231.Xr ctype 3 232and related manual pages. 233.It [=equiv=] 234Represents all characters belonging to the same equivalence class as 235.Ar equiv , 236ordered by their encoded values. 237.It [#*n] 238Represents 239.Ar n 240repeated occurrences of the character represented by 241.Ar # . 242This 243expression is only valid when it occurs in 244.Ar string2 . 245If 246.Ar n 247is omitted or is zero, it is be interpreted as large enough to extend 248.Ar string2 249sequence to the length of 250.Ar string1 . 251If 252.Ar n 253has a leading zero, it is interpreted as an octal value, otherwise, 254it's interpreted as a decimal value. 255.El 256.Sh ENVIRONMENT 257The 258.Ev LANG , LC_ALL , LC_CTYPE 259and 260.Ev LC_COLLATE 261environment variables affect the execution of 262.Nm 263as described in 264.Xr environ 7 . 265.Sh EXAMPLES 266The following examples are shown as given to the shell: 267.Pp 268Create a list of the words in file1, one per line, where a word is taken to 269be a maximal string of letters. 270.Pp 271.D1 Li "tr -cs \*q[:alpha:]\*q \*q\en\*q < file1" 272.Pp 273Translate the contents of file1 to upper-case. 274.Pp 275.D1 Li "tr \*q[:lower:]\*q \*q[:upper:]\*q < file1" 276.Pp 277Strip out non-printable characters from file1. 278.Pp 279.D1 Li "tr -cd \*q[:print:]\*q < file1" 280.Pp 281Remove diacritical marks from all accented variants of the letter 282.Ql e : 283.Pp 284.Dl "tr \*q[=e=]\*q \*qe\*q" 285.Sh DIAGNOSTICS 286.Ex -std 287.Sh COMPATIBILITY 288System V has historically implemented character ranges using the syntax 289``[c-c]'' instead of the ``c-c'' used by historic 290.Bx 291implementations and 292standardized by POSIX. 293System V shell scripts should work under this implementation as long as 294the range is intended to map in another range, i.e. the command 295``tr [a-z] [A-Z]'' will work as it will map the ``['' character in 296.Ar string1 297to the ``['' character in 298.Ar string2 . 299However, if the shell script is deleting or squeezing characters as in 300the command ``tr -d [a-z]'', the characters ``['' and ``]'' will be 301included in the deletion or compression list which would not have happened 302under a historic System V implementation. 303Additionally, any scripts that depended on the sequence ``a-z'' to 304represent the three characters ``a'', ``-'' and ``z'' will have to be 305rewritten as ``a\e-z''. 306.Pp 307The 308.Nm 309utility has historically not permitted the manipulation of NUL bytes in 310its input and, additionally, stripped NUL's from its input stream. 311This implementation has removed this behavior as a bug. 312.Pp 313The 314.Nm 315utility has historically been extremely forgiving of syntax errors, 316for example, the 317.Fl c 318and 319.Fl s 320options were ignored unless two strings were specified. 321This implementation will not permit illegal syntax. 322.Sh STANDARDS 323The 324.Nm 325utility conforms to 326.St -p1003.1-2001 . 327.Pp 328It should be noted that the feature wherein the last character of 329.Ar string2 330is duplicated if 331.Ar string2 332has less characters than 333.Ar string1 334is permitted by POSIX but is not required. 335Shell scripts attempting to be portable to other POSIX systems should use 336the ``[#*]'' convention instead of relying on this behavior. 337The 338.Fl u 339option is an extension to the 340.St -p1003.1-2001 341standard. 342