summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_idna_map.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/gnutls_idna_map.3
parentInitial commit. (diff)
downloadgnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz
gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages/gnutls_idna_map.3')
-rw-r--r--doc/manpages/gnutls_idna_map.354
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_idna_map.3 b/doc/manpages/gnutls_idna_map.3
new file mode 100644
index 0000000..506d479
--- /dev/null
+++ b/doc/manpages/gnutls_idna_map.3
@@ -0,0 +1,54 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
+.TH "gnutls_idna_map" 3 "3.7.9" "gnutls" "gnutls"
+.SH NAME
+gnutls_idna_map \- API function
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "int gnutls_idna_map(const char * " input ", unsigned " ilen ", gnutls_datum_t * " out ", unsigned " flags ");"
+.SH ARGUMENTS
+.IP "const char * input" 12
+contain the UTF\-8 formatted domain name
+.IP "unsigned ilen" 12
+the length of the provided string
+.IP "gnutls_datum_t * out" 12
+the result in an null\-terminated allocated string
+.IP "unsigned flags" 12
+should be zero
+.SH "DESCRIPTION"
+This function will convert the provided UTF\-8 domain name, to
+its IDNA mapping in an allocated variable. Note that depending on the flags the used gnutls
+library was compiled with, the output of this function may vary (i.e.,
+may be IDNA2008, or IDNA2003).
+
+To force IDNA2008 specify the flag \fBGNUTLS_IDNA_FORCE_2008\fP. In
+the case GnuTLS is not compiled with the necessary dependencies,
+\fBGNUTLS_E_UNIMPLEMENTED_FEATURE\fP will be returned to indicate that
+gnutls is unable to perform the requested conversion.
+
+Note also, that this function will return an empty string if an
+empty string is provided as input.
+.SH "RETURNS"
+\fBGNUTLS_E_INVALID_UTF8_STRING\fP on invalid UTF\-8 data, or 0 on success.
+.SH "SINCE"
+3.5.8
+.SH "REPORTING BUGS"
+Report bugs to <bugs@gnutls.org>.
+.br
+Home page: https://www.gnutls.org
+
+.SH COPYRIGHT
+Copyright \(co 2001- Free Software Foundation, Inc., and others.
+.br
+Copying and distribution of this file, with or without modification,
+are permitted in any medium without royalty provided the copyright
+notice and this notice are preserved.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.
+If the /usr/share/doc/gnutls/
+directory does not contain the HTML form visit
+.B
+.IP https://www.gnutls.org/manual/
+.PP