glib2 1.1.4-x86-mingw32 → 1.1.5-x86-mingw32

data/vendor/local/share/man/man3/gnutls_handshake.3

@@ -0,0 +1,53 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_handshake" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_handshake \- This is the main function in the handshake protocol.
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "int gnutls_handshake(gnutls_session_t " session ");"
+.SH ARGUMENTS
+.IP "gnutls_session_t session" 12
+is a \fBgnutls_session_t\fP structure.
+.SH "DESCRIPTION"
+This function does the handshake of the TLS/SSL protocol, and
+initializes the TLS connection.
+
+This function will fail if any problem is encountered, and will
+return a negative error code. In case of a client, if the client
+has asked to resume a session, but the server couldn't, then a
+full handshake will be performed.
+
+The non\-fatal errors such as \fBGNUTLS_E_AGAIN\fP and
+\fBGNUTLS_E_INTERRUPTED\fP interrupt the handshake procedure, which
+should be later be resumed.  Call this function again, until it
+returns 0; cf.  \fBgnutls_record_get_direction()\fP and
+\fBgnutls_error_is_fatal()\fP.
+
+If this function is called by a server after a rehandshake request
+then \fBGNUTLS_E_GOT_APPLICATION_DATA\fP or
+\fBGNUTLS_E_WARNING_ALERT_RECEIVED\fP may be returned.  Note that these
+are non fatal errors, only in the specific case of a rehandshake.
+Their meaning is that the client rejected the rehandshake request.
+.SH "RETURNS"
+\fBGNUTLS_E_SUCCESS\fP on success, otherwise an error.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_handshake_get_last_in.3

@@ -0,0 +1,41 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_handshake_get_last_in" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_handshake_get_last_in \- Returns the last handshake message received.
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "gnutls_handshake_description_t gnutls_handshake_get_last_in(gnutls_session_t " session ");"
+.SH ARGUMENTS
+.IP "gnutls_session_t session" 12
+is a \fBgnutls_session_t\fP structure.
+.SH "DESCRIPTION"
+This function is only useful to check where the last performed
+handshake failed.  If the previous handshake succeed or was not
+performed at all then no meaningful value will be returned.
+
+Check \fBgnutls_handshake_description_t\fP in gnutls.h for the
+available handshake descriptions.
+.SH "RETURNS"
+the last handshake message type received, a
+\fBgnutls_handshake_description_t\fP.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_handshake_get_last_out.3

@@ -0,0 +1,41 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_handshake_get_last_out" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_handshake_get_last_out \- Returns the last handshake message sent.
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "gnutls_handshake_description_t gnutls_handshake_get_last_out(gnutls_session_t " session ");"
+.SH ARGUMENTS
+.IP "gnutls_session_t session" 12
+is a \fBgnutls_session_t\fP structure.
+.SH "DESCRIPTION"
+This function is only useful to check where the last performed
+handshake failed.  If the previous handshake succeed or was not
+performed at all then no meaningful value will be returned.
+
+Check \fBgnutls_handshake_description_t\fP in gnutls.h for the
+available handshake descriptions.
+.SH "RETURNS"
+the last handshake message type sent, a
+\fBgnutls_handshake_description_t\fP.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_handshake_set_max_packet_length.3

@@ -0,0 +1,42 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_handshake_set_max_packet_length" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_handshake_set_max_packet_length \- set the maximum size of the handshake
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "void gnutls_handshake_set_max_packet_length(gnutls_session_t " session ", size_t " max ");"
+.SH ARGUMENTS
+.IP "gnutls_session_t session" 12
+is a \fBgnutls_session_t\fP structure.
+.IP "size_t max" 12
+is the maximum number.
+.SH "DESCRIPTION"
+This function will set the maximum size of all handshake messages.
+Handshakes over this size are rejected with
+\fBGNUTLS_E_HANDSHAKE_TOO_LARGE\fP error code.  The default value is
+48kb which is typically large enough.  Set this to 0 if you do not
+want to set an upper limit.
+
+The reason for restricting the handshake message sizes are to
+limit Denial of Service attacks.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_handshake_set_post_client_hello_function.3

@@ -0,0 +1,48 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_handshake_set_post_client_hello_function" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_handshake_set_post_client_hello_function \- set callback to be called after the client hello is received
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "void gnutls_handshake_set_post_client_hello_function(gnutls_session_t " session ", gnutls_handshake_post_client_hello_func " func ");"
+.SH ARGUMENTS
+.IP "gnutls_session_t session" 12
+.IP "gnutls_handshake_post_client_hello_func func" 12
+is the function to be called
+.SH "DESCRIPTION"
+This function will set a callback to be called after the client
+hello has been received (callback valid in server side only). This
+allows the server to adjust settings based on received extensions.
+
+Those settings could be ciphersuites, requesting certificate, or
+anything else except for version negotiation (this is done before
+the hello message is parsed).
+
+This callback must return 0 on success or a gnutls error code to
+terminate the handshake.
+.SH "WARNING"
+You should not use this function to terminate the
+handshake based on client input unless you know what you are
+doing. Before the handshake is finished there is no way to know if
+there is a man\-in\-the\-middle attack being performed.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_handshake_set_private_extensions.3

@@ -0,0 +1,44 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_handshake_set_private_extensions" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_handshake_set_private_extensions \- Used to enable the private cipher suites
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "void gnutls_handshake_set_private_extensions(gnutls_session_t " session ", int " allow ");"
+.SH ARGUMENTS
+.IP "gnutls_session_t session" 12
+is a \fBgnutls_session_t\fP structure.
+.IP "int allow" 12
+is an integer (0 or 1)
+.SH "DESCRIPTION"
+This function will enable or disable the use of private cipher
+suites (the ones that start with 0xFF).  By default or if \fIallow\fP
+is 0 then these cipher suites will not be advertized nor used.
+
+Unless this function is called with the option to allow (1), then
+no compression algorithms, like LZO.  That is because these
+algorithms are not yet defined in any RFC or even internet draft.
+
+Enabling the private ciphersuites when talking to other than
+gnutls servers and clients may cause interoperability problems.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_hex2bin.3

@@ -0,0 +1,44 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_hex2bin" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_hex2bin \- convert hex string into binary buffer.
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "int gnutls_hex2bin(const char * " hex_data ", size_t " hex_size ", char * " bin_data ", size_t * " bin_size ");"
+.SH ARGUMENTS
+.IP "const char * hex_data" 12
+string with data in hex format
+.IP "size_t hex_size" 12
+size of hex data
+.IP "char * bin_data" 12
+output array with binary data
+.IP "size_t * bin_size" 12
+when calling *\fIbin_size\fP should hold size of \fIbin_data\fP,
+on return will hold actual size of \fIbin_data\fP.
+.SH "DESCRIPTION"
+Convert a buffer with hex data to binary data.
+.SH "RETURNS"
+\fBGNUTLS_E_SUCCESS\fP on success, otherwise an error.
+.SH "SINCE"
+2.4.0
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_hex_decode.3

@@ -0,0 +1,43 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_hex_decode" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_hex_decode \- decode hex encoded data
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "int gnutls_hex_decode(const gnutls_datum_t * " hex_data ", char * " result ", size_t * " result_size ");"
+.SH ARGUMENTS
+.IP "const gnutls_datum_t * hex_data" 12
+contain the encoded data
+.IP "char * result" 12
+the place where decoded data will be copied
+.IP "size_t * result_size" 12
+holds the size of the result
+.SH "DESCRIPTION"
+This function will decode the given encoded data, using the hex encoding
+used by PSK password files.
+
+Note that hex_data should be null terminated.
+.SH "RETURNS"
+\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not
+long enough, or 0 on success.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_hex_encode.3

@@ -0,0 +1,41 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_hex_encode" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_hex_encode \- convert raw data to hex encoded
+.SH SYNOPSIS
+.B #include <gnutls/gnutls.h>
+.sp
+.BI "int gnutls_hex_encode(const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");"
+.SH ARGUMENTS
+.IP "const gnutls_datum_t * data" 12
+contain the raw data
+.IP "char * result" 12
+the place where hex data will be copied
+.IP "size_t * result_size" 12
+holds the size of the result
+.SH "DESCRIPTION"
+This function will convert the given data to printable data, using
+the hex encoding, as used in the PSK password files.
+.SH "RETURNS"
+\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not
+long enough, or 0 on success.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.

data/vendor/local/share/man/man3/gnutls_ia_allocate_client_credentials.3

@@ -0,0 +1,42 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
+.TH "gnutls_ia_allocate_client_credentials" 3 "2.4.2" "gnutls" "gnutls"
+.SH NAME
+gnutls_ia_allocate_client_credentials \- Used to allocate an gnutls_ia_server_credentials_t structure
+.SH SYNOPSIS
+.B #include <gnutls/extra.h>
+.sp
+.BI "int gnutls_ia_allocate_client_credentials(gnutls_ia_client_credentials_t * " sc ");"
+.SH ARGUMENTS
+.IP "gnutls_ia_client_credentials_t * sc" 12
+is a pointer to an \fBgnutls_ia_server_credentials_t\fP structure.
+.SH "DESCRIPTION"
+This structure is complex enough to manipulate directly thus this
+helper function is provided in order to allocate it.
+
+Adding this credential to a session will enable TLS/IA, and will
+require an Application Phase after the TLS handshake (if the server
+support TLS/IA).  Use \fBgnutls_ia_require_inner_phase()\fP to toggle the
+TLS/IA mode.
+.SH "RETURNS"
+On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise
+an error code is returned.
+.SH "REPORTING BUGS"
+Report bugs to <bug-gnutls@gnu.org>.
+.SH COPYRIGHT
+Copyright \(co 2008 Free Software Foundation.
+.br
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+.SH "SEE ALSO"
+The full documentation for
+.B gnutls
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B gnutls
+programs are properly installed at your site, the command
+.IP
+.B info gnutls
+.PP
+should give you access to the complete manual.