From 20da09932ecb7582a65afd430d16d6ab6889ccd2 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 20 Dec 2010 14:22:07 +0100 Subject: [PATCH] libssh2_userauth_list: language fix "faily" is not a good English word, and I also cleaned up some other minor mistakes --- docs/libssh2_userauth_list.3 | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/docs/libssh2_userauth_list.3 b/docs/libssh2_userauth_list.3 index 080745d9..206e7a7b 100644 --- a/docs/libssh2_userauth_list.3 +++ b/docs/libssh2_userauth_list.3 @@ -2,42 +2,40 @@ .\" .TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME -libssh2_userauth_list - list the authentication methods supported by a server +libssh2_userauth_list - list supported authentication methods .SH SYNOPSIS +.nf #include 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 \fIsession\fP - Session instance as returned by .BR libssh2_session_init_ex(3) -\fIusername\fP - Username which will be used while authenticating. Note -that most server implementations do not permit attempting authentication -with different usernames between requests. Therefore this must be the -same username you will use on later userauth calls. +\fIusername\fP - Username which will be used while authenticating. Note that +most server implementations do not permit attempting authentication with +different usernames between requests. Therefore this must be the same username +you will use on later userauth calls. \fIusername_len\fP - Length of username parameter. -Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the -remote host is configured to accept none as a viable authentication -scheme (unlikely), it will return \fBSSH_USERAUTH_FAILURE\fB along with a -listing of what authentication schemes it does support. In the unlikely -event that none authentication succeeds, this method with return NULL. This -case may be distinguished from faily by examining -.BR libssh2_userauth_authenticated(3) - +Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the remote +host is configured to accept none as a viable authentication scheme +(unlikely), it will return \fBSSH_USERAUTH_FAILURE\fP along with a listing of +what authentication schemes it does support. In the unlikely event that none +authentication succeeds, this method with return NULL. This case may be +distinguished from a failing case by examining +\fIlibssh2_userauth_authenticated(3)\fP. .SH RETURN VALUE -On success a comma delimited list of supported authentication schemes. This list is -internally managed by libssh2. On failure ruturns NULL. - +On success a comma delimited list of supported authentication schemes. This +list is internally managed by libssh2. On failure ruturns NULL. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call - .SH SEE ALSO .BR libssh2_session_init_ex(3)