From 95d69d3a81261e84978c8efe33ff518e8b3933f0 Mon Sep 17 00:00:00 2001 From: Henrik Nordstrom Date: Sat, 6 Aug 2011 13:44:00 +0200 Subject: [PATCH] Document prototypes for macro defined functions --- docs/libssh2_channel_direct_tcpip.3 | 3 ++- docs/libssh2_channel_exec.3 | 2 +- docs/libssh2_channel_flush.3 | 2 +- docs/libssh2_channel_flush_stderr.3 | 2 +- docs/libssh2_channel_forward_listen.3 | 2 +- docs/libssh2_channel_ignore_extended_data.3 | 3 +++ docs/libssh2_channel_open_session.3 | 3 ++- docs/libssh2_channel_read.3 | 2 +- docs/libssh2_channel_read_stderr.3 | 2 +- docs/libssh2_channel_request_pty.3 | 2 +- docs/libssh2_channel_request_pty_size.3 | 2 +- docs/libssh2_channel_setenv.3 | 2 +- docs/libssh2_channel_shell.3 | 2 +- docs/libssh2_channel_subsystem.3 | 2 +- docs/libssh2_channel_window_read.3 | 2 +- docs/libssh2_channel_window_write.3 | 2 +- docs/libssh2_channel_write.3 | 4 ++-- docs/libssh2_channel_write_stderr.3 | 4 ++-- docs/libssh2_channel_x11_req.3 | 2 +- docs/libssh2_publickey_add.3 | 5 ++++- docs/libssh2_publickey_add_ex.3 | 21 ++++++++++++++++---- docs/libssh2_publickey_remove.3 | 4 +++- docs/libssh2_scp_send.3 | 3 ++- docs/libssh2_session_disconnect.3 | 2 +- docs/libssh2_session_init.3 | 3 ++- docs/libssh2_sftp_close.3 | 2 +- docs/libssh2_sftp_closedir.3 | 2 +- docs/libssh2_sftp_fsetstat.3 | 2 +- docs/libssh2_sftp_fstat.3 | 2 +- docs/libssh2_sftp_lstat.3 | 2 +- docs/libssh2_sftp_mkdir.3 | 2 +- docs/libssh2_sftp_open.3 | 3 ++- docs/libssh2_sftp_opendir.3 | 3 ++- docs/libssh2_sftp_readdir.3 | 2 +- docs/libssh2_sftp_rename.3 | 2 +- docs/libssh2_sftp_rewind.3 | 2 +- docs/libssh2_sftp_setstat.3 | 2 +- docs/libssh2_sftp_stat.3 | 2 +- docs/libssh2_sftp_unlink.3 | 2 +- docs/libssh2_userauth_hostbased_fromfile.3 | 2 +- docs/libssh2_userauth_keyboard_interactive.3 | 6 +++++- docs/libssh2_userauth_password.3 | 4 +++- docs/libssh2_userauth_publickey_fromfile.3 | 7 ++++++- 43 files changed, 85 insertions(+), 47 deletions(-) diff --git a/docs/libssh2_channel_direct_tcpip.3 b/docs/libssh2_channel_direct_tcpip.3 index ae5c26af..ea93b347 100644 --- a/docs/libssh2_channel_direct_tcpip.3 +++ b/docs/libssh2_channel_direct_tcpip.3 @@ -6,7 +6,8 @@ libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_t .SH SYNOPSIS #include -libssh2_channel_direct_tcpip(arguments) +LIBSSH2_CHANNEL * +libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_exec.3 b/docs/libssh2_channel_exec.3 index 588f3682..982d8536 100644 --- a/docs/libssh2_channel_exec.3 +++ b/docs/libssh2_channel_exec.3 @@ -6,7 +6,7 @@ libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup( .SH SYNOPSIS #include -libssh2_channel_exec(arguments) +int libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *command); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_flush.3 b/docs/libssh2_channel_flush.3 index f0371fad..9d3abfef 100644 --- a/docs/libssh2_channel_flush.3 +++ b/docs/libssh2_channel_flush.3 @@ -6,7 +6,7 @@ libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP .SH SYNOPSIS #include -libssh2_channel_flush(arguments) +int libssh2_channel_flush(LIBSSH2_CHANNEL *channel); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_flush_stderr.3 b/docs/libssh2_channel_flush_stderr.3 index 063d74cc..986f3925 100644 --- a/docs/libssh2_channel_flush_stderr.3 +++ b/docs/libssh2_channel_flush_stderr.3 @@ -6,7 +6,7 @@ libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex .SH SYNOPSIS #include -libssh2_channel_flush_stderr(arguments) +int libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_forward_listen.3 b/docs/libssh2_channel_forward_listen.3 index 4de06f89..70185b6f 100644 --- a/docs/libssh2_channel_forward_listen.3 +++ b/docs/libssh2_channel_forward_listen.3 @@ -6,7 +6,7 @@ libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forwar .SH SYNOPSIS #include -libssh2_channel_forward_listen(arguments) +int libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_ignore_extended_data.3 b/docs/libssh2_channel_ignore_extended_data.3 index 2d632780..cb1235a1 100644 --- a/docs/libssh2_channel_ignore_extended_data.3 +++ b/docs/libssh2_channel_ignore_extended_data.3 @@ -9,6 +9,9 @@ libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_ libssh2_channel_ignore_extended_data(arguments) .SH DESCRIPTION +This function is deprecated. Use the +\fIlibssh2_channel_handle_extended_data2(3)\fP function instead! + This is a macro defined in a public libssh2 header file that is using the underlying function \fIlibssh2_channel_handle_extended_data(3)\fP. .SH RETURN VALUE diff --git a/docs/libssh2_channel_open_session.3 b/docs/libssh2_channel_open_session.3 index 7d86dd9e..3b2a5f84 100644 --- a/docs/libssh2_channel_open_session.3 +++ b/docs/libssh2_channel_open_session.3 @@ -6,7 +6,8 @@ libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex( .SH SYNOPSIS #include -libssh2_channel_open_session(arguments) +LIBSSH2_CHANNEL * +libssh2_channel_open_session(LIBSSH2_SESSION *session); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_read.3 b/docs/libssh2_channel_read.3 index 86813155..438a6d4a 100644 --- a/docs/libssh2_channel_read.3 +++ b/docs/libssh2_channel_read.3 @@ -6,7 +6,7 @@ libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP ca .SH SYNOPSIS #include -libssh2_channel_read(arguments) +ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_read_stderr.3 b/docs/libssh2_channel_read_stderr.3 index da045e61..f251bed8 100644 --- a/docs/libssh2_channel_read_stderr.3 +++ b/docs/libssh2_channel_read_stderr.3 @@ -6,7 +6,7 @@ libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3 .SH SYNOPSIS #include -libssh2_channel_read_stderr(arguments) +ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_request_pty.3 b/docs/libssh2_channel_request_pty.3 index c8680012..0be7bf82 100644 --- a/docs/libssh2_channel_request_pty.3 +++ b/docs/libssh2_channel_request_pty.3 @@ -6,7 +6,7 @@ libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_p .SH SYNOPSIS #include -libssh2_channel_request_pty(arguments) +int libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_request_pty_size.3 b/docs/libssh2_channel_request_pty_size.3 index 30c78210..49f9ad99 100644 --- a/docs/libssh2_channel_request_pty_size.3 +++ b/docs/libssh2_channel_request_pty_size.3 @@ -6,7 +6,7 @@ libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_requ .SH SYNOPSIS #include -libssh2_channel_request_pty_size(arguments) +int libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel, int width, int height); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_setenv.3 b/docs/libssh2_channel_setenv.3 index a15b3dde..24dd8828 100644 --- a/docs/libssh2_channel_setenv.3 +++ b/docs/libssh2_channel_setenv.3 @@ -6,7 +6,7 @@ libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\f .SH SYNOPSIS #include -libssh2_channel_setenv(arguments) +int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, const char *varname, const char *value); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_shell.3 b/docs/libssh2_channel_shell.3 index a786cfc3..0a97a69d 100644 --- a/docs/libssh2_channel_shell.3 +++ b/docs/libssh2_channel_shell.3 @@ -6,7 +6,7 @@ libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup .SH SYNOPSIS #include -libssh2_channel_shell(arguments) +int libssh2_channel_shell(LIBSSH2_CHANNEL *channel); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_subsystem.3 b/docs/libssh2_channel_subsystem.3 index e3f2cb7a..1bce38f9 100644 --- a/docs/libssh2_channel_subsystem.3 +++ b/docs/libssh2_channel_subsystem.3 @@ -6,7 +6,7 @@ libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_sta .SH SYNOPSIS #include -libssh2_channel_subsystem(arguments) +int libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *subsystem); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_window_read.3 b/docs/libssh2_channel_window_read.3 index 16cb8e01..564b76ca 100644 --- a/docs/libssh2_channel_window_read.3 +++ b/docs/libssh2_channel_window_read.3 @@ -6,7 +6,7 @@ libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_re .SH SYNOPSIS #include -libssh2_channel_window_read(arguments) +unsigned long libssh2_channel_window_read(LIBSSH2_CHANNEL *channel); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_window_write.3 b/docs/libssh2_channel_window_write.3 index f4ca7844..542dd042 100644 --- a/docs/libssh2_channel_window_write.3 +++ b/docs/libssh2_channel_window_write.3 @@ -6,7 +6,7 @@ libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_w .SH SYNOPSIS #include -libssh2_channel_window_write(arguments) +unsigend long libssh2_channel_window_write(LIBSSH2_CHANNEL *channel); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_channel_write.3 b/docs/libssh2_channel_write.3 index b8c006df..69a89516 100644 --- a/docs/libssh2_channel_write.3 +++ b/docs/libssh2_channel_write.3 @@ -7,8 +7,8 @@ libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP .nf #include -#define libssh2_channel_write(channel, buf, buflen) \\ - libssh2_channel_write_ex((channel), 0, (buf), (buflen)) +ssize_t libssh2_channel_write(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); + .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function \fIlibssh2_channel_write_ex(3)\fP. diff --git a/docs/libssh2_channel_write_stderr.3 b/docs/libssh2_channel_write_stderr.3 index 40f18116..0a8d2403 100644 --- a/docs/libssh2_channel_write_stderr.3 +++ b/docs/libssh2_channel_write_stderr.3 @@ -7,8 +7,8 @@ libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex .nf #include -#define libssh2_channel_write_stderr(channel, buf, buflen) \\ - libssh2_channel_write_ex((channel), SSH_EXTENDED_DATA_STDERR, (buf), (buflen)) +ssize_t libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); + .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function \fIlibssh2_channel_write_ex(3)\fP. diff --git a/docs/libssh2_channel_x11_req.3 b/docs/libssh2_channel_x11_req.3 index c335173a..101590aa 100644 --- a/docs/libssh2_channel_x11_req.3 +++ b/docs/libssh2_channel_x11_req.3 @@ -6,7 +6,7 @@ libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3) .SH SYNOPSIS #include -libssh2_channel_x11_req(arguments) +int libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_publickey_add.3 b/docs/libssh2_publickey_add.3 index 7389a359..3548fbd2 100644 --- a/docs/libssh2_publickey_add.3 +++ b/docs/libssh2_publickey_add.3 @@ -6,7 +6,10 @@ libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP .SH SYNOPSIS #include -libssh2_publickey_add(arguments) +int libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey, + const unsigned char *name, + const unsigned char *blob, unsigned long blob_len, char overwrite, + unsigned long num_attrs, const libssh2_publickey_attribute attrs[]); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_publickey_add_ex.3 b/docs/libssh2_publickey_add_ex.3 index c07baae6..adda65d8 100644 --- a/docs/libssh2_publickey_add_ex.3 +++ b/docs/libssh2_publickey_add_ex.3 @@ -2,13 +2,26 @@ .\" .TH libssh2_publickey_add_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME -libssh2_publickey_add_ex - TODO +libssh2_publickey_add_ex - Add a public key entry .SH SYNOPSIS +#include + +int +libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, + unsigned long name_len, const unsigned char *blob, + unsigned long blob_len, char overwrite, + unsigned long num_attrs, + const libssh2_publickey_attribute attrs[]) .SH DESCRIPTION - +TBD .SH RETURN VALUE - +Returns 0 on success, negative on failure. .SH ERRORS - +LIBSSH2_ERROR_BAD_USE +LIBSSH2_ERROR_ALLOC, +LIBSSH2_ERROR_EAGAIN +LIBSSH2_ERROR_SOCKET_SEND, +LIBSSH2_ERROR_SOCKET_TIMEOUT, +LIBSSH2_ERROR_PUBLICKEY_PROTOCOL, .SH SEE ALSO diff --git a/docs/libssh2_publickey_remove.3 b/docs/libssh2_publickey_remove.3 index 0a2f0b7f..2d11ac4e 100644 --- a/docs/libssh2_publickey_remove.3 +++ b/docs/libssh2_publickey_remove.3 @@ -6,7 +6,9 @@ libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex( .SH SYNOPSIS #include -libssh2_publickey_remove(arguments) +int libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey, + const unsigned char *name, unsigned long name_len, + const unsigned char *blob, unsigned long blob_len); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_scp_send.3 b/docs/libssh2_scp_send.3 index 1a805f09..75393b70 100644 --- a/docs/libssh2_scp_send.3 +++ b/docs/libssh2_scp_send.3 @@ -6,7 +6,8 @@ libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_scp_send(arguments) +LIBSSH2_CHANNEL * +libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, int mode, size_t size); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_session_disconnect.3 b/docs/libssh2_session_disconnect.3 index 6bb8fde5..ec5de542 100644 --- a/docs/libssh2_session_disconnect.3 +++ b/docs/libssh2_session_disconnect.3 @@ -6,7 +6,7 @@ libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect .SH SYNOPSIS #include -libssh2_session_disconnect(arguments) +int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_session_init.3 b/docs/libssh2_session_init.3 index ea631673..b2ba8f75 100644 --- a/docs/libssh2_session_init.3 +++ b/docs/libssh2_session_init.3 @@ -6,7 +6,8 @@ libssh2_session_init - convenience macro for \fIlibssh2_session_init_ex(3)\fP ca .SH SYNOPSIS #include -libssh2_session_init(arguments) +LIBSSH2_SESSION * +libssh2_session_init(void); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_close.3 b/docs/libssh2_sftp_close.3 index 0968178b..11ef82f0 100644 --- a/docs/libssh2_sftp_close.3 +++ b/docs/libssh2_sftp_close.3 @@ -6,7 +6,7 @@ libssh2_sftp_close - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP ca .SH SYNOPSIS #include -libssh2_sftp_close(arguments) +int libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_closedir.3 b/docs/libssh2_sftp_closedir.3 index 3078c8bb..bcf9fff6 100644 --- a/docs/libssh2_sftp_closedir.3 +++ b/docs/libssh2_sftp_closedir.3 @@ -6,7 +6,7 @@ libssh2_sftp_closedir - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP .SH SYNOPSIS #include -libssh2_sftp_closedir(arguments) +int libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle) .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_fsetstat.3 b/docs/libssh2_sftp_fsetstat.3 index 36ce73ec..dde89372 100644 --- a/docs/libssh2_sftp_fsetstat.3 +++ b/docs/libssh2_sftp_fsetstat.3 @@ -6,7 +6,7 @@ libssh2_sftp_fsetstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP cal .SH SYNOPSIS #include -libssh2_sftp_fsetstat(arguments) +int libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_fstat.3 b/docs/libssh2_sftp_fstat.3 index c8d3775c..39120bb8 100644 --- a/docs/libssh2_sftp_fstat.3 +++ b/docs/libssh2_sftp_fstat.3 @@ -6,7 +6,7 @@ libssh2_sftp_fstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_fstat(arguments) +int libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_lstat.3 b/docs/libssh2_sftp_lstat.3 index 46f408bc..34df217e 100644 --- a/docs/libssh2_sftp_lstat.3 +++ b/docs/libssh2_sftp_lstat.3 @@ -6,7 +6,7 @@ libssh2_sftp_lstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_lstat(arguments) +int libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_mkdir.3 b/docs/libssh2_sftp_mkdir.3 index 126627f9..fc632bec 100644 --- a/docs/libssh2_sftp_mkdir.3 +++ b/docs/libssh2_sftp_mkdir.3 @@ -6,7 +6,7 @@ libssh2_sftp_mkdir - convenience macro for \fIlibssh2_sftp_mkdir_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_mkdir(arguments) +int libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_open.3 b/docs/libssh2_sftp_open.3 index 0e70560a..9524a80d 100644 --- a/docs/libssh2_sftp_open.3 +++ b/docs/libssh2_sftp_open.3 @@ -6,7 +6,8 @@ libssh2_sftp_open - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_open(arguments) +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_open(LIBSSH2_SFTP *sftp, const char *path, unsigned long flags, long mode); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_opendir.3 b/docs/libssh2_sftp_opendir.3 index a73f93dc..2c66a3e2 100644 --- a/docs/libssh2_sftp_opendir.3 +++ b/docs/libssh2_sftp_opendir.3 @@ -6,7 +6,8 @@ libssh2_sftp_opendir - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_opendir(arguments) +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_opendir(LIBSSH2_SFTP *sftp, const char *path); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_readdir.3 b/docs/libssh2_sftp_readdir.3 index 1133bf72..bd6d0d99 100644 --- a/docs/libssh2_sftp_readdir.3 +++ b/docs/libssh2_sftp_readdir.3 @@ -6,7 +6,7 @@ libssh2_sftp_readdir - convenience macro for \fIlibssh2_sftp_readdir_ex(3)\fP ca .SH SYNOPSIS #include -libssh2_sftp_readdir(arguments) +int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_rename.3 b/docs/libssh2_sftp_rename.3 index cf8f5683..fa9e8576 100644 --- a/docs/libssh2_sftp_rename.3 +++ b/docs/libssh2_sftp_rename.3 @@ -6,7 +6,7 @@ libssh2_sftp_rename - convenience macro for \fIlibssh2_sftp_rename_ex(3)\fP call .SH SYNOPSIS #include -libssh2_sftp_rename(arguments) +int libssh2_sftp_rename(LIBSSH2_SFTP *sftp, const char *source_filename, const char *destination_filename); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_rewind.3 b/docs/libssh2_sftp_rewind.3 index 1e65a67e..ae602b7d 100644 --- a/docs/libssh2_sftp_rewind.3 +++ b/docs/libssh2_sftp_rewind.3 @@ -6,7 +6,7 @@ libssh2_sftp_rewind - convenience macro for \fIlibssh2_sftp_seek64(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_rewind(arguments) +int libssh2_sftp_rewind(LINBSSH2_SFTP_HANDLE *handle); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_setstat.3 b/docs/libssh2_sftp_setstat.3 index 21658f29..8b870470 100644 --- a/docs/libssh2_sftp_setstat.3 +++ b/docs/libssh2_sftp_setstat.3 @@ -6,7 +6,7 @@ libssh2_sftp_setstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_setstat(arguments) +int libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attr); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_stat.3 b/docs/libssh2_sftp_stat.3 index 84e77ca8..00f31b3e 100644 --- a/docs/libssh2_sftp_stat.3 +++ b/docs/libssh2_sftp_stat.3 @@ -6,7 +6,7 @@ libssh2_sftp_stat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls .SH SYNOPSIS #include -libssh2_sftp_stat(arguments) +int libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_STFP_ATTRIBUTES *attrs); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_sftp_unlink.3 b/docs/libssh2_sftp_unlink.3 index 4dc9e68c..4b35ba28 100644 --- a/docs/libssh2_sftp_unlink.3 +++ b/docs/libssh2_sftp_unlink.3 @@ -6,7 +6,7 @@ libssh2_sftp_unlink - convenience macro for \fIlibssh2_sftp_unlink_ex(3)\fP call .SH SYNOPSIS #include -libssh2_sftp_unlink(arguments) +int libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_userauth_hostbased_fromfile.3 b/docs/libssh2_userauth_hostbased_fromfile.3 index 7f217717..409384d0 100644 --- a/docs/libssh2_userauth_hostbased_fromfile.3 +++ b/docs/libssh2_userauth_hostbased_fromfile.3 @@ -6,7 +6,7 @@ libssh2_userauth_hostbased_fromfile - convenience macro for \fIlibssh2_userauth_ .SH SYNOPSIS #include -libssh2_userauth_hostbased_fromfile(arguments) +int libssh2_userauth_hostbased_fromfile(LIBSSH2_SESSION *session, const char *username, const char *publickey, const char *privatekey, const char *passphrase, const char *hostname); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_userauth_keyboard_interactive.3 b/docs/libssh2_userauth_keyboard_interactive.3 index 5b05c409..2abe40ae 100644 --- a/docs/libssh2_userauth_keyboard_interactive.3 +++ b/docs/libssh2_userauth_keyboard_interactive.3 @@ -6,7 +6,11 @@ libssh2_userauth_keyboard_interactive - convenience macro for \fIlibssh2_useraut .SH SYNOPSIS #include -libssh2_userauth_keyboard_interactive(arguments) +int +libssh2_userauth_keyboard_interactive(LIBSSH2_SESSION* session, + const char *username, + LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC((*response_callback))); + .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_userauth_password.3 b/docs/libssh2_userauth_password.3 index 00e23a40..220103f4 100644 --- a/docs/libssh2_userauth_password.3 +++ b/docs/libssh2_userauth_password.3 @@ -6,7 +6,9 @@ libssh2_userauth_password - convenience macro for \fIlibssh2_userauth_password_e .SH SYNOPSIS #include -libssh2_userauth_password(arguments) +int libssh2_userauth_password(LIBSSH2_SESSION *session, + const char *username, + const char *password); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the diff --git a/docs/libssh2_userauth_publickey_fromfile.3 b/docs/libssh2_userauth_publickey_fromfile.3 index 08aa50d2..69d26412 100644 --- a/docs/libssh2_userauth_publickey_fromfile.3 +++ b/docs/libssh2_userauth_publickey_fromfile.3 @@ -6,7 +6,12 @@ libssh2_userauth_publickey_fromfile - convenience macro for \fIlibssh2_userauth_ .SH SYNOPSIS #include -libssh2_userauth_publickey_fromfile(arguments) +int +libssh2_userauth_publickey_fromfile(LIBSSH2_SESSION *session, + const char *username, + const char *publickey, + const char *privatekey, + const char *passphrase); .SH DESCRIPTION This is a macro defined in a public libssh2 header file that is using the