From 6a2f098e72e71437154ec00506e8e736aa8e1026 Mon Sep 17 00:00:00 2001 From: Soccera1 <129828376+Soccera1@users.noreply.github.com> Date: Tue, 28 Jul 2026 15:54:54 +1000 Subject: Add docs --- man/tr.1 | 151 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 man/tr.1 (limited to 'man/tr.1') diff --git a/man/tr.1 b/man/tr.1 new file mode 100644 index 0000000..6bf656c --- /dev/null +++ b/man/tr.1 @@ -0,0 +1,151 @@ +.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md. +.TH TR "1" "2026-07-28" "BNU 9.11" "BNU Commands" +.SH NAME +tr \- translate or delete characters +.SH SYNOPSIS +.B tr +[\fI\,OPTION\/\fR]... \fI\,STRING1 \/\fR[\fI\,STRING2\/\fR] +.SH DESCRIPTION +.\" This page is derived from GNU Coreutils documentation. +This page documents BNU, an independent Bun implementation compatible with +GNU Coreutils 9.11. +.PP +Translate, squeeze, and/or delete characters from standard input, +writing to standard output. STRING1 and STRING2 specify arrays of +characters ARRAY1 and ARRAY2 that control the action. +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#tr-c'\fB\-c, \-C, \-\-complement\fP\X'tty: link' +use the complement of ARRAY1 +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#tr-d'\fB\-d, \-\-delete\fP\X'tty: link' +delete characters in ARRAY1, do not translate +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#tr-s'\fB\-s, \-\-squeeze\-repeats\fP\X'tty: link' +replace each sequence of a repeated character +that is listed in the last specified ARRAY, +with a single occurrence of that character +.TP +\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#tr-t'\fB\-t, \-\-truncate\-set1\fP\X'tty: link' +first truncate ARRAY1 to length of ARRAY2 +.TP +\X'tty: link https://www.gnu.org/software/coreutils/tr#tr--help'\fB\-\-help\fP\X'tty: link' +display this help and exit +.TP +\X'tty: link https://www.gnu.org/software/coreutils/tr#tr--version'\fB\-\-version\fP\X'tty: link' +output version information and exit +.PP +ARRAYs are specified as strings of characters. Most represent themselves. +Interpreted sequences are: +.TP +\eNNN +character with octal value NNN (1 to 3 octal digits) +.TP +\e\e +backslash +.TP +\ea +audible BEL +.TP +\eb +backspace +.TP +\ef +form feed +.TP +\en +new line +.TP +\er +return +.TP +\et +horizontal tab +.TP +\ev +vertical tab +.TP +CHAR1\-CHAR2 +all characters from CHAR1 to CHAR2 in ascending order +.TP +[CHAR*] +in ARRAY2, copies of CHAR until length of ARRAY1 +.TP +[CHAR*REPEAT] +REPEAT copies of CHAR, REPEAT octal if starting with 0 +.TP +[:alnum:] +all letters and digits +.TP +[:alpha:] +all letters +.TP +[:blank:] +all horizontal whitespace +.TP +[:cntrl:] +all control characters +.TP +[:digit:] +all digits +.TP +[:graph:] +all printable characters, not including space +.TP +[:lower:] +all lower case letters +.TP +[:print:] +all printable characters, including space +.TP +[:punct:] +all punctuation characters +.TP +[:space:] +all horizontal or vertical whitespace +.TP +[:upper:] +all upper case letters +.TP +[:xdigit:] +all hexadecimal digits +.TP +[=CHAR=] +all characters which are equivalent to CHAR +.PP +Translation occurs if \fB\-d\fR is not given and both STRING1 and STRING2 appear. +\fB\-t\fR is only significant when translating. ARRAY2 is extended to length of +ARRAY1 by repeating its last character as necessary. Excess characters +of ARRAY2 are ignored. Character classes expand in unspecified order; +while translating, '[:lower:]' and '[:upper:]' may be used in pairs to +specify case conversion. Squeezing occurs after translation or deletion. +Arguments like '[...]' should be quoted, to avoid potential shell globbing. +.SH BUGS +.PP +Full support is available only for safe single-byte locales, +in which every possible input byte represents a single character. +The C locale is safe in GNU systems, so you can avoid this issue +in the shell by running +.B "LC_ALL=C tr" +instead of plain +.BR tr . +.SH AUTHORS +Upstream GNU Coreutils documentation authors: +Written by Jim Meyering. +.br +Adapted for BNU; the BNU implementation is independent. +.SH "REPORTING BUGS" +Report BNU bugs at . +.br +For upstream GNU Coreutils, see . +.SH COPYRIGHT +Copyright \(co 2026 Free Software Foundation, Inc. +.br +This manual page was adapted for BNU in 2026. +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +Upstream documentation +.br +BNU documentation is available locally via: info \(aq(bnu) tr invocation\(aq -- cgit v1.3