lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-08-07 08:02:56 +03:00
Code Activity

libssh2_userauth_list: language fix

Browse Source 
"faily" is not a good English word, and I also cleaned up some other minor
mistakes
This commit is contained in:
Daniel Stenberg
2010-12-20 14:22:07 +01:00
parent 3ab7af095a
commit 20da09932e
1 changed files with 17 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/libssh2_userauth_list.3
View File

@@ -2,42 +2,40 @@
.\" .\"
.TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME .SH NAME
libssh2_userauth_list - list the authentication methods supported by a server libssh2_userauth_list - list supported authentication methods
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
char * char *
libssh2_userauth_list(LIBSSH2_SESSION *session, const char *username, unsigned int username_len); libssh2_userauth_list(LIBSSH2_SESSION *session, const char *username,
unsigned int username_len);
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)
\fIusername\fP - Username which will be used while authenticating. Note \fIusername\fP - Username which will be used while authenticating. Note that
that most server implementations do not permit attempting authentication most server implementations do not permit attempting authentication with
with different usernames between requests. Therefore this must be the different usernames between requests. Therefore this must be the same username
same username you will use on later userauth calls. you will use on later userauth calls.
\fIusername_len\fP - Length of username parameter. \fIusername_len\fP - Length of username parameter.
Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the remote
remote host is configured to accept none as a viable authentication host is configured to accept none as a viable authentication scheme
scheme (unlikely), it will return \fBSSH_USERAUTH_FAILURE\fB along with a (unlikely), it will return \fBSSH_USERAUTH_FAILURE\fP along with a listing of
listing of what authentication schemes it does support. In the unlikely what authentication schemes it does support. In the unlikely event that none
event that none authentication succeeds, this method with return NULL. This authentication succeeds, this method with return NULL. This case may be
case may be distinguished from faily by examining distinguished from a failing case by examining
.BR libssh2_userauth_authenticated(3) \fIlibssh2_userauth_authenticated(3)\fP.
.SH RETURN VALUE .SH RETURN VALUE
On success a comma delimited list of supported authentication schemes. This list is On success a comma delimited list of supported authentication schemes. This
internally managed by libssh2. On failure ruturns NULL. list is internally managed by libssh2. On failure ruturns NULL.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)