~ubuntu-branches/ubuntu/quantal/gnutls28/quantal

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_hex_encode.3

  • Committer: Package Import Robot
  • Author(s): Andreas Metzler
  • Date: 2011-12-17 11:41:19 UTC
  • mfrom: (10.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20111217114119-sp3ixi00tjajm52g
Tags: 3.0.9-2
* [20_test-select.diff] Do not run gnulib test-select test anymore. The
  test fails on kfreebsd-i386, the gnutls library does not use select().
* [30_correctly-set-the-odd-bits.patch] Post release fix from GIT head.
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
 
2
.TH "gnutls_hex_encode" 3 "3.0.9" "gnutls" "gnutls"
 
3
.SH NAME
 
4
gnutls_hex_encode \- API function
 
5
.SH SYNOPSIS
 
6
.B #include <gnutls/gnutls.h>
 
7
.sp
 
8
.BI "int gnutls_hex_encode(const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");"
 
9
.SH ARGUMENTS
 
10
.IP "const gnutls_datum_t * data" 12
 
11
contain the raw data
 
12
.IP "char * result" 12
 
13
the place where hex data will be copied
 
14
.IP "size_t * result_size" 12
 
15
holds the size of the result
 
16
.SH "DESCRIPTION"
 
17
This function will convert the given data to printable data, using
 
18
the hex encoding, as used in the PSK password files.
 
19
.SH "RETURNS"
 
20
\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not
 
21
long enough, or 0 on success.
 
22
.SH "REPORTING BUGS"
 
23
Report bugs to <bug-gnutls@gnu.org>.
 
24
GnuTLS home page: http://www.gnu.org/software/gnutls/
 
25
General help using GNU software: http://www.gnu.org/gethelp/
 
26
.SH COPYRIGHT
 
27
Copyright \(co 2011 Free Software Foundation.
 
28
.br
 
29
Copying and distribution of this file, with or without modification,
 
30
are permitted in any medium without royalty provided the copyright
 
31
notice and this notice are preserved.
 
32
.SH "SEE ALSO"
 
33
The full documentation for
 
34
.B gnutls
 
35
is maintained as a Texinfo manual.  If the
 
36
.B info
 
37
and
 
38
.B gnutls
 
39
programs are properly installed at your site, the command
 
40
.IP
 
41
.B info gnutls
 
42
.PP
 
43
should give you access to the complete manual.