sbase/tr.1

.Dd 2016-10-05
.Dt TR 1
.Os sbase
.Sh NAME
.Nm tr
.Nd translate characters
.Sh SYNOPSIS
.Nm
.Op Fl c | Fl C
.Op Fl sd
.Ar set1 set2
.Sh DESCRIPTION
.Nm
matches characters from stdin and performs translations to stdout.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl c | Fl C
Match to
.Ar set1
complement.
.It Fl d
Delete characters matching
.Ar set1 .
.It Fl s
Squeeze repeated characters matching
.Ar set1
or
.Ar set2
if
.Fl d
is set.
.El
.Sh SET
.Bl -tag -width Ds
.It Literal Sy c
.It Escape sequence Sy \ec
\e\e, \e', \e", \ea, \eb, \ee, \ef, \en, \er, \et, \ev, \exH[H], \eO[OO]
.It Range Sy c-d
.It Repeat Sy [c*n]
Only in
.Ar set2 .
If n = 0 or left out, set n to length of
.Ar set1 .
.It Character class Sy [:class:]
See
.Xr wctype 3 .
.It Equivalence class Sy [=c=]
Resolve to
.Sy c .
.El
.Sh TRANSLATION
If
.Fl d
is not set,
.Nm
translates from
.Ar set1
to
.Ar set2
by index or character class.
.Pp
If
.Ar set2
is shorter than
.Ar set1
or
.Ar set1
is a character class,
overflowing characters translate to the last character in
.Ar set2 .
.Sh EXIT STATUS
.Bl -tag -width Ds
.It 0
Input processed successfully.
.It 1
An error occurred.
.El
.Sh SEE ALSO
.Xr awk 1 ,
.Xr sed 1 ,
.Xr utf8 7
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2013
specification except from equivalence classes.
tr.1: Make note of some changes in the utility 2016-10-05 19:42:24 +00:00			`.Dd 2016-10-05`
remove sbase-VERSION from man page, fix sponge.1 date 2015-01-31 13:20:02 +00:00			`.Dt TR 1`
Add .Os sbase and sed replace to .Os sbase $(VERSION) in make install 2015-01-31 19:37:03 +00:00			`.Os sbase`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`.Sh NAME`
			`.Nm tr`
			`.Nd translate characters`
			`.Sh SYNOPSIS`
add some mandoc pages and fix some warnings - add .Os, it is mandatory. - don't redeclare .Nm when it's not needed. - fix some warnings (checked with mandoc -Tlint). - remove some leftover old stuff. 2015-01-30 20:17:58 +00:00			`.Nm`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`.Op Fl c \| Fl C`
			`.Op Fl sd`
			`.Ar set1 set2`
			`.Sh DESCRIPTION`
			`.Nm`
			`matches characters from stdin and performs translations to stdout.`
			`.Sh OPTIONS`
			`.Bl -tag -width Ds`
			`.It Fl c \| Fl C`
			`Match to`
			`.Ar set1`
			`complement.`
			`.It Fl d`
			`Delete characters matching`
			`.Ar set1 .`
			`.It Fl s`
			`Squeeze repeated characters matching`
			`.Ar set1`
			`or`
			`.Ar set2`
Add trivial equivalence class support in tr(1) and update manpage Equivalence classes are a hard matter and there's still no "standard" way to solve the issue. Previously, tr would just skip those classes, but it's much better when it resolves a [=c=] to a normal c instead of treating it as a literal. Also, reflect recent changes in the manpage (octal escapes) and fix the markup in some areas. 2015-01-28 18:44:05 +00:00			`if`
			`.Fl d`
			`is set.`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`.El`
			`.Sh SET`
			`.Bl -tag -width Ds`
Add trivial equivalence class support in tr(1) and update manpage Equivalence classes are a hard matter and there's still no "standard" way to solve the issue. Previously, tr would just skip those classes, but it's much better when it resolves a [=c=] to a normal c instead of treating it as a literal. Also, reflect recent changes in the manpage (octal escapes) and fix the markup in some areas. 2015-01-28 18:44:05 +00:00			`.It Literal Sy c`
			`.It Escape sequence Sy \ec`
Update escape-sequence information in tr.1 2015-02-15 13:56:49 +00:00			`\e\e, \e', \e", \ea, \eb, \ee, \ef, \en, \er, \et, \ev, \exH[H], \eO[OO]`
Add trivial equivalence class support in tr(1) and update manpage Equivalence classes are a hard matter and there's still no "standard" way to solve the issue. Previously, tr would just skip those classes, but it's much better when it resolves a [=c=] to a normal c instead of treating it as a literal. Also, reflect recent changes in the manpage (octal escapes) and fix the markup in some areas. 2015-01-28 18:44:05 +00:00			`.It Range Sy c-d`
			`.It Repeat Sy [c*n]`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`Only in`
			`.Ar set2 .`
			`If n = 0 or left out, set n to length of`
			`.Ar set1 .`
Add trivial equivalence class support in tr(1) and update manpage Equivalence classes are a hard matter and there's still no "standard" way to solve the issue. Previously, tr would just skip those classes, but it's much better when it resolves a [=c=] to a normal c instead of treating it as a literal. Also, reflect recent changes in the manpage (octal escapes) and fix the markup in some areas. 2015-01-28 18:44:05 +00:00			`.It Character class Sy [:class:]`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`See`
			`.Xr wctype 3 .`
Add trivial equivalence class support in tr(1) and update manpage Equivalence classes are a hard matter and there's still no "standard" way to solve the issue. Previously, tr would just skip those classes, but it's much better when it resolves a [=c=] to a normal c instead of treating it as a literal. Also, reflect recent changes in the manpage (octal escapes) and fix the markup in some areas. 2015-01-28 18:44:05 +00:00			`.It Equivalence class Sy [=c=]`
			`Resolve to`
			`.Sy c .`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`.El`
			`.Sh TRANSLATION`
tr.1: Make note of some changes in the utility 2016-10-05 19:42:24 +00:00			`If`
			`.Fl d`
			`is not set,`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`.Nm`
			`translates from`
			`.Ar set1`
			`to`
			`.Ar set2`
			`by index or character class.`
			`.Pp`
			`If`
			`.Ar set2`
			`is shorter than`
tr.1: Make note of some changes in the utility 2016-10-05 19:42:24 +00:00			`.Ar set1`
			`or`
			`.Ar set1`
			`is a character class,`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`overflowing characters translate to the last character in`
			`.Ar set2 .`
			`.Sh EXIT STATUS`
			`.Bl -tag -width Ds`
			`.It 0`
			`Input processed successfully.`
			`.It 1`
			`An error occurred.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr awk 1 ,`
fix mandoc warnings - sort references in SEE ALSO section to section number, name. - cols.1: proper order of sections. - wrap lines to max 79 column length. 2015-01-31 13:43:27 +00:00			`.Xr sed 1 ,`
Add mandoc-manpage for tr(1) and mark it as finished in the README. 2015-01-15 23:53:50 +00:00			`.Xr utf8 7`
			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility is compliant with the`
POSIX 2013 audit Mostly manpage-shuffling according to the changes in the corrigendum, wording changes and more idiomatic expressions. All this is finished up by marking the POSIX 2013 conformant tools with .St -p1003.1-2013 which is not available in older mandoc builds or nroff, but which reflects what we actually did, so who cares? This is a huge step and it's not far until we can release sbase 0.1. 2015-03-27 16:22:48 +00:00			`.St -p1003.1-2013`
Add octal sequence support to tr(1) 2015-01-24 21:43:46 +00:00			`specification except from equivalence classes.`