From 8ec21e0afe985177659cd5a5f6b040618c0c2906 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 25 Oct 2010 23:18:50 +0200 Subject: [PATCH] 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... --- docs/Makefile.am | 1 + docs/libssh2_userauth_publickey.3 | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/libssh2_userauth_publickey.3 diff --git a/docs/Makefile.am b/docs/Makefile.am index 1fdfc38..d86b416 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -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 diff --git a/docs/libssh2_userauth_publickey.3 b/docs/libssh2_userauth_publickey.3 new file mode 100644 index 0000000..31771af --- /dev/null +++ b/docs/libssh2_userauth_publickey.3 @@ -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 + +.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)