From 9d247dc831569a4db75ec9466d1a988a82dfba29 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 23 Oct 2026 21:09:14 +0200 Subject: First commit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..0642311 --- /dev/null +++ b/README @@ -0,0 +1,47 @@ +NAME + libutf8 - UTF-8 encoding and decoding + +SYNOPSIS + #include + + Link with -lutf8. + +DESCRIPTION + The libutf8 library provides functions for encoding and decoding + UTF-8 sequences, with flexibility in how invalid input is handled. + + The library implements the following functions: + + Encoding functions: + libutf8_encode(3) + Encode a codepoint as UTF-8 + + libutf8_encode_measure(3) + Get the number of bytes required to encode a codepoint + + Decoding functions: + libutf8_decode(3) + Decode one sequence from a string + + libutf8_decode_mem(3) + Decode one sequence from a memory buffer + + Codepoint and byte test functions: + libutf8_is_noncharacter(3) + Test whether a codepoint is a Unicode non-character + codepoint + + libutf8_is_surrogate(3) + Test whether a codepoint is a UTF-16 surrogate + + libutf8_is_invalid(3) + Test whether a codepoint is invalid Unicode + + libutf8_is_valid(3) + Test whether a codepoint is valid Unicode + + libutf8_is_continuation(3) + Test whether a byte is a UTF-8 continuation byte + +SEE ALSO + libgrapheme(7) -- cgit v1.3.1