commit 4a5b4abeec1b91986ec0258289abf79b6122531c
parent fc73d06fed76dd7cde37d3704949d01391ea0032
Author: Laslo Hunhold <dev@frign.de>
Date: Tue, 4 Oct 2022 00:17:04 +0200
Rework libgrapheme(7) a bit
Add the information about the library being freestanding and fix
wordings a bit. Reflect in the first paragraph what the library can do.
Signed-off-by: Laslo Hunhold <dev@frign.de>
Diffstat:
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/man/libgrapheme.sh b/man/libgrapheme.sh
@@ -11,12 +11,14 @@ cat << EOF
The
.Nm
library provides functions to properly handle Unicode strings according
-to the Unicode specification.
+to the Unicode specification in regard to character, word, sentence and
+line segmentation and case detection and conversion.
+.Pp
Unicode strings are made up of user-perceived characters (so-called
.Dq grapheme clusters ,
see
.Sx MOTIVATION )
-that are made up of one or more Unicode codepoints, which in turn
+that are composed of one or more Unicode codepoints, which in turn
are encoded in one or more bytes in an encoding like UTF-8.
.Pp
There is a widespread misconception that it was enough to simply
@@ -32,6 +34,10 @@ Despite this complicated multilevel structure of Unicode strings,
provides methods to work with them at the byte-level (i.e. UTF-8
.Sq char
arrays) while also offering codepoint-level methods.
+Additionally, it is a
+.Dq freestanding
+library (see ISO/IEC 9899:1999 section 4.6) and thus does not depend on
+a standard library. This makes it easy to use in bare-metal environments.
.Pp
Every documented function's manual page provides a self-contained
example illustrating the possible usage.
