From 6d5c637c6c992e7089fd3e6963936e0878353e9b Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Wed, 18 Dec 2024 07:20:21 -0500 Subject: tweak man page --- uxd.1 | 15 ++++++++++----- uxd.rst | 15 ++++++++++----- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/uxd.1 b/uxd.1 index 8ada567..616f56d 100644 --- a/uxd.1 +++ b/uxd.1 @@ -202,7 +202,8 @@ Works with negative \fIpos\fP, too. .TP .B \-t Put terminal in UTF\-8 mode, if possible. Prints \fBESC % G\fP sequence, which -may or may not be supported by your terminal. To avoid surprises, this +may or may not be supported by your terminal (works for \fBxterm\fP(1); +does not work for \fBurxvt\fP(1)). To avoid surprises, this option also takes the terminal out of UTF\-8 mode before \fBuxd\fP exits, on the theory that you won\(aqt need this option if the terminal is normally running in UTF\-8 mode. If this assumption turns out to be wrong, you can @@ -337,14 +338,17 @@ Continuation bytes that aren\(aqt preceded by a valid prefix byte. .IP \(bu 2 Truncated UTF\-8 sequence at EOF. .IP \(bu 2 -UTF\-16 surrogates (codepoints U+D800 to U+DFFF). +UTF\-16 surrogates (codepoints U+D800 to U+DFFF) [\fB*\fP]. .IP \(bu 2 -Codepoints above U+10FFFF, which are disallowed by RFC 3629. +Codepoints above U+10FFFF, which are disallowed by the Unicode standard [\fB*\fP]. .IP \(bu 2 Overlong encodings (e.g. codepoints U+0000 to U+007F encoded -as 2 or more bytes). +as 2 or more bytes) [\fB*\fP]. .UNINDENT .sp +For items marked with [\fB*\fP], the \fB\-j\fP, \fB\-p\fP, and/or \fB\-w\fP +options can disable error highlighting for this type of error. +.sp Each occurrence of any of the above will increment the "Bad sequences" count, if the \fB\-i\fP option is used. .UNINDENT @@ -357,7 +361,8 @@ ANSI\-style escape sequences, Unicode, and UTF\-8 rendering. .sp The author\(aqs testing is done primarily with \fBurxvt\fP(1). Other terminals aren\(aqt tested as often. Some terminals may need UTF\-8 -enabled, if it\(aqs not on by default (e.g. xterm). +enabled, if it\(aqs not on by default (either in the terminal\(aqs settings +or using the \fB\-t\fP option to \fBuxd\fP). .sp Known to work: urxvt, xterm, st, xfce4\-terminal, gnome\-terminal, kitty, konsole, the Linux console (but see \fBFONTS\fP, below). diff --git a/uxd.rst b/uxd.rst index 2220174..b16a78d 100644 --- a/uxd.rst +++ b/uxd.rst @@ -163,7 +163,8 @@ as *K*, *M*, and *G* for power-of-10 based (e.g. *1K* is 1000 bytes). -t Put terminal in UTF-8 mode, if possible. Prints **ESC % G** sequence, which - may or may not be supported by your terminal. To avoid surprises, this + may or may not be supported by your terminal (works for **xterm**\(1); + does not work for **urxvt**\(1)). To avoid surprises, this option also takes the terminal out of UTF-8 mode before **uxd** exits, on the theory that you won't need this option if the terminal is normally running in UTF-8 mode. If this assumption turns out to be wrong, you can @@ -279,12 +280,15 @@ changed with the **-c** option (see above). - Truncated UTF-8 sequence at EOF. - - UTF-16 surrogates (codepoints U+D800 to U+DFFF). + - UTF-16 surrogates (codepoints U+D800 to U+DFFF) [**\***]. - - Codepoints above U+10FFFF, which are disallowed by RFC 3629. + - Codepoints above U+10FFFF, which are disallowed by the Unicode standard [**\***]. - Overlong encodings (e.g. codepoints U+0000 to U+007F encoded - as 2 or more bytes). + as 2 or more bytes) [**\***]. + + For items marked with [**\***], the **-j**, **-p**, and/or **-w** + options can disable error highlighting for this type of error. Each occurrence of any of the above will increment the "Bad sequences" count, if the **-i** option is used. @@ -297,7 +301,8 @@ ANSI-style escape sequences, Unicode, and UTF-8 rendering. The author's testing is done primarily with **urxvt**\(1). Other terminals aren't tested as often. Some terminals may need UTF-8 -enabled, if it's not on by default (e.g. xterm). +enabled, if it's not on by default (either in the terminal's settings +or using the **-t** option to **uxd**). Known to work: urxvt, xterm, st, xfce4-terminal, gnome-terminal, kitty, konsole, the Linux console (but see **FONTS**, below). -- cgit v1.2.3