ref: e7f777ae03a4e739471c8916b436fd261da242fa
parent: a600610fded8cd7b5a2b24787d10b2fdaea50d7e
author: cinap_lenrek <[email protected]>
date: Wed Sep 26 11:58:19 EDT 2018
idn(2): add documentation for idn2utf() and utf2idn()
--- /dev/null
+++ b/sys/man/2/idn
@@ -1,0 +1,51 @@
+.TH IDN 2
+.SH NAME
+utf2idn, idn2utf \- convert internationalized domain names to and from unicode
+.SH SYNOPSIS
+.B #include <u.h>
+.br
+.B #include <libc.h>
+.PP
+.B
+int utf2idn(char *name, char *buf, int nbuf);
+.PP
+.B
+int idn2utf(char *name, char *buf, int nbuf);
+.SH DESCRIPTION
+These routines handle encoding and decoding of domain
+names as specified by RFC5890.
+.PP
+.I Utf2idn
+encodes the
+.SM UTF
+string
+.I name
+to
+.SM ASCII
+internatlionalized domain name in
+.IR buf .
+.I Idn2utf
+does the reverse, decoding the
+.SM ASCII
+string
+.I name
+back to
+.SM UTF
+in
+.IR buf .
+The maximum size of
+.I buf
+is gived by
+.IR nbuf .
+.SH DIAGNOSTICS
+The return value is the number of bytes (excluding the terminating NULL) in
+.I buf
+or
+.B -1
+on failure.
+.SH SOURCE
+.B /sys/src/libc/9sys/idn.c
+.SH "SEE ALSO"
+.B /lib/rfc/rfc5890
+.br
+.IR utf (6)