generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
8bb6cf7f95
ssh2/docs/libssh2_userauth_keyboard_interactive.3

21 lines
816 B
Groff
Raw Normal View History

added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.TH libssh2_userauth_keyboard_interactive 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual"
.SH NAME
libssh2_userauth_keyboard_interactive - convenience macro for \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP calls
.SH SYNOPSIS
#include <libssh2.h>
libssh2_userauth_keyboard_interactive.3: fix man warning It seemed to occur due to the excessive line length
2011-09-12 15:41:28 +02:00
.nf
added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
Document prototypes for macro defined functions
2011-08-06 13:44:00 +02:00
int
libssh2_userauth_keyboard_interactive(LIBSSH2_SESSION* session,
const char *username,
libssh2_userauth_keyboard_interactive.3: fix man warning It seemed to occur due to the excessive line length
2011-09-12 15:41:28 +02:00
LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC((*response_callback)));
added man pages for API macros all #defined macros in the public headers are considered to be part of the API and I've generated individual man pages for each of them to A) make it easier to figure out what each function/macro actually is for so that automated lookups work better and for B) make sure we have all public functions document (both macros and functions) to make it easier for us to work away from all the macros in a future release.
2010-02-15 14:24:40 +01:00
.SH DESCRIPTION
This is a macro defined in a public libssh2 header file that is using the
underlying function \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP.
.SH RETURN VALUE
See \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP
.SH ERRORS
See \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP
.SH SEE ALSO
man page: fix .BR lines We don't use \fI etc on .BR lines
2011-05-30 09:26:34 +02:00
.BR libssh2_userauth_keyboard_interactive_ex(3)
Reference in New Issue Copy Permalink