libssh2_userauth_publickey: add man page
I found an undocumented public function and we can't have it like that. The description here is incomplete, but should serve as a template to allow filling in...
This commit is contained in:
parent
8e0983347b
commit
8ec21e0afe
@ -157,6 +157,7 @@ dist_man_MANS = \
|
||||
libssh2_userauth_list.3 \
|
||||
libssh2_userauth_password.3 \
|
||||
libssh2_userauth_password_ex.3 \
|
||||
libssh2_userauth_publickey.3 \
|
||||
libssh2_userauth_publickey_fromfile.3 \
|
||||
libssh2_userauth_publickey_fromfile_ex.3 \
|
||||
libssh2_version.3
|
||||
|
29
docs/libssh2_userauth_publickey.3
Normal file
29
docs/libssh2_userauth_publickey.3
Normal file
@ -0,0 +1,29 @@
|
||||
.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $
|
||||
.\"
|
||||
.TH libssh2_userauth_publickey 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
||||
.SH NAME
|
||||
libssh2_userauth_publickey - authenticate using a callback function
|
||||
.SH SYNOPSIS
|
||||
#include <libssh2.h>
|
||||
|
||||
.NF
|
||||
int libssh2_userauth_publickey(LIBSSH2_SESSION *session,
|
||||
const char *user,
|
||||
const unsigned char *pubkeydata,
|
||||
size_t pubkeydata_len,
|
||||
sign_callback,
|
||||
void **abstract);
|
||||
.SH DESCRIPTION
|
||||
Authenticate with the \fIsign_callback\fP callback that matches the prototype
|
||||
below
|
||||
.SH CALLBACK
|
||||
.nf
|
||||
int name(LIBSSH2_SESSION *session, unsigned char **sig, size_t *sig_len,
|
||||
const unsigned char *data, size_t data_len, void **abstract);
|
||||
.fi
|
||||
|
||||
This function gets called...
|
||||
.SH RETURN VALUE
|
||||
Return 0 on success or negative on failure.
|
||||
.SH SEE ALSO
|
||||
.BR libssh2_userauth_publickey_fromfile_ex(3)
|
Loading…
x
Reference in New Issue
Block a user