~ubuntu-branches/ubuntu/oneiric/gnutls26/oneiric

« back to all changes in this revision

Viewing changes to doc/manpages/gnutls_cipher_suite_info.3

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2011-05-20 13:07:18 UTC
  • mfrom: (12.1.11 sid)
  • Revision ID: james.westby@ubuntu.com-20110520130718-db41dybbanzfvlji
Tags: 2.10.5-1ubuntu1
* Merge from Debian unstable, remaining changes:
  - Fix build failure with --no-add-needed.
  - Build for multiarch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2
 
.TH "gnutls_cipher_suite_info" 3 "2.8.6" "gnutls" "gnutls"
 
2
.TH "gnutls_cipher_suite_info" 3 "2.10.5" "gnutls" "gnutls"
3
3
.SH NAME
4
4
gnutls_cipher_suite_info \- API function
5
5
.SH SYNOPSIS
6
6
.B #include <gnutls/gnutls.h>
7
7
.sp
8
 
.BI "const char * gnutls_cipher_suite_info(size_t " idx ", char * " cs_id ", gnutls_kx_algorithm_t * " kx ", gnutls_cipher_algorithm_t * " cipher ", gnutls_mac_algorithm_t * " mac ", gnutls_protocol_t * " version ");"
 
8
.BI "const char * gnutls_cipher_suite_info(size_t " idx ", char * " cs_id ", gnutls_kx_algorithm_t * " kx ", gnutls_cipher_algorithm_t * " cipher ", gnutls_mac_algorithm_t * " mac ", gnutls_protocol_t * " min_version ");"
9
9
.SH ARGUMENTS
10
10
.IP "size_t idx" 12
11
11
index of cipher suite to get information about, starts on 0.
17
17
output variable indicating cipher, or \fBNULL\fP.
18
18
.IP "gnutls_mac_algorithm_t * mac" 12
19
19
output variable indicating MAC algorithm, or \fBNULL\fP.
20
 
.IP "gnutls_protocol_t * version" 12
21
 
output variable indicating TLS protocol version, or \fBNULL\fP.
 
20
.IP "gnutls_protocol_t * min_version" 12
22
21
.SH "DESCRIPTION"
23
22
Get information about supported cipher suites.  Use the function
24
23
iteratively to get information about all supported cipher suites.