mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-19 02:24:04 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
30 lines
1.0 KiB
Groff
30 lines
1.0 KiB
Groff
.TH libssh2_session_methods 3 "8 Nov 2021" "libssh2 1.11" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_methods - return the currently active algorithms
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
const char *
|
|
libssh2_session_methods(LIBSSH2_SESSION *session, int method_type);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\fIsession\fP - Session instance as returned by
|
|
.BR libssh2_session_init_ex(3)
|
|
|
|
\fImethod_type\fP - one of the method type constants: LIBSSH2_METHOD_KEX,
|
|
LIBSSH2_METHOD_HOSTKEY, LIBSSH2_METHOD_CRYPT_CS, LIBSSH2_METHOD_CRYPT_SC,
|
|
LIBSSH2_METHOD_MAC_CS, LIBSSH2_METHOD_MAC_SC, LIBSSH2_METHOD_COMP_CS,
|
|
LIBSSH2_METHOD_COMP_SC, LIBSSH2_METHOD_LANG_CS, LIBSSH2_METHOD_LANG_SC,
|
|
LIBSSH2_METHOD_SIGN_ALGO.
|
|
|
|
Returns the actual method negotiated for a particular transport parameter.
|
|
.SH RETURN VALUE
|
|
Negotiated method or NULL if the session has not yet been started.
|
|
.SH ERRORS
|
|
\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid.
|
|
|
|
\fILIBSSH2_ERROR_METHOD_NONE\fP - no method has been set
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_init_ex(3)
|