From ec699ef684d3a94478cfac3140cc1d0df04ba0ba Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 15 Feb 2010 14:24:40 +0100 Subject: [PATCH] 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. --- docs/Makefile.am | 48 +++++++++++++++++++- docs/libssh2_channel_direct_tcpip.3 | 19 ++++++++ docs/libssh2_channel_exec.3 | 19 ++++++++ docs/libssh2_channel_flush.3 | 19 ++++++++ docs/libssh2_channel_flush_stderr.3 | 19 ++++++++ docs/libssh2_channel_forward_listen.3 | 19 ++++++++ docs/libssh2_channel_ignore_extended_data.3 | 19 ++++++++ docs/libssh2_channel_open_session.3 | 19 ++++++++ docs/libssh2_channel_read.3 | 19 ++++++++ docs/libssh2_channel_read_stderr.3 | 19 ++++++++ docs/libssh2_channel_request_pty.3 | 19 ++++++++ docs/libssh2_channel_request_pty_size.3 | 19 ++++++++ docs/libssh2_channel_setenv.3 | 19 ++++++++ docs/libssh2_channel_shell.3 | 19 ++++++++ docs/libssh2_channel_subsystem.3 | 19 ++++++++ docs/libssh2_channel_window_read.3 | 19 ++++++++ docs/libssh2_channel_window_write.3 | 19 ++++++++ docs/libssh2_channel_write.3 | 19 ++++++++ docs/libssh2_channel_write_stderr.3 | 19 ++++++++ docs/libssh2_channel_x11_req.3 | 19 ++++++++ docs/libssh2_publickey_add.3 | 19 ++++++++ docs/libssh2_publickey_remove.3 | 19 ++++++++ docs/libssh2_scp_send.3 | 19 ++++++++ docs/libssh2_session_disconnect.3 | 19 ++++++++ docs/libssh2_session_init.3 | 19 ++++++++ docs/libssh2_sftp_close.3 | 19 ++++++++ docs/libssh2_sftp_closedir.3 | 19 ++++++++ docs/libssh2_sftp_fsetstat.3 | 19 ++++++++ docs/libssh2_sftp_fstat.3 | 19 ++++++++ docs/libssh2_sftp_lstat.3 | 19 ++++++++ docs/libssh2_sftp_mkdir.3 | 19 ++++++++ docs/libssh2_sftp_open.3 | 19 ++++++++ docs/libssh2_sftp_opendir.3 | 19 ++++++++ docs/libssh2_sftp_readdir.3 | 19 ++++++++ docs/libssh2_sftp_readlink.3 | 19 ++++++++ docs/libssh2_sftp_realpath.3 | 19 ++++++++ docs/libssh2_sftp_rename.3 | 19 ++++++++ docs/libssh2_sftp_rewind.3 | 19 ++++++++ docs/libssh2_sftp_rmdir.3 | 19 ++++++++ docs/libssh2_sftp_setstat.3 | 19 ++++++++ docs/libssh2_sftp_stat.3 | 19 ++++++++ docs/libssh2_sftp_symlink.3 | 19 ++++++++ docs/libssh2_sftp_unlink.3 | 19 ++++++++ docs/libssh2_userauth_hostbased_fromfile.3 | 19 ++++++++ docs/libssh2_userauth_keyboard_interactive.3 | 19 ++++++++ docs/libssh2_userauth_password.3 | 19 ++++++++ docs/libssh2_userauth_publickey_fromfile.3 | 19 ++++++++ 47 files changed, 921 insertions(+), 1 deletion(-) create mode 100644 docs/libssh2_channel_direct_tcpip.3 create mode 100644 docs/libssh2_channel_exec.3 create mode 100644 docs/libssh2_channel_flush.3 create mode 100644 docs/libssh2_channel_flush_stderr.3 create mode 100644 docs/libssh2_channel_forward_listen.3 create mode 100644 docs/libssh2_channel_ignore_extended_data.3 create mode 100644 docs/libssh2_channel_open_session.3 create mode 100644 docs/libssh2_channel_read.3 create mode 100644 docs/libssh2_channel_read_stderr.3 create mode 100644 docs/libssh2_channel_request_pty.3 create mode 100644 docs/libssh2_channel_request_pty_size.3 create mode 100644 docs/libssh2_channel_setenv.3 create mode 100644 docs/libssh2_channel_shell.3 create mode 100644 docs/libssh2_channel_subsystem.3 create mode 100644 docs/libssh2_channel_window_read.3 create mode 100644 docs/libssh2_channel_window_write.3 create mode 100644 docs/libssh2_channel_write.3 create mode 100644 docs/libssh2_channel_write_stderr.3 create mode 100644 docs/libssh2_channel_x11_req.3 create mode 100644 docs/libssh2_publickey_add.3 create mode 100644 docs/libssh2_publickey_remove.3 create mode 100644 docs/libssh2_scp_send.3 create mode 100644 docs/libssh2_session_disconnect.3 create mode 100644 docs/libssh2_session_init.3 create mode 100644 docs/libssh2_sftp_close.3 create mode 100644 docs/libssh2_sftp_closedir.3 create mode 100644 docs/libssh2_sftp_fsetstat.3 create mode 100644 docs/libssh2_sftp_fstat.3 create mode 100644 docs/libssh2_sftp_lstat.3 create mode 100644 docs/libssh2_sftp_mkdir.3 create mode 100644 docs/libssh2_sftp_open.3 create mode 100644 docs/libssh2_sftp_opendir.3 create mode 100644 docs/libssh2_sftp_readdir.3 create mode 100644 docs/libssh2_sftp_readlink.3 create mode 100644 docs/libssh2_sftp_realpath.3 create mode 100644 docs/libssh2_sftp_rename.3 create mode 100644 docs/libssh2_sftp_rewind.3 create mode 100644 docs/libssh2_sftp_rmdir.3 create mode 100644 docs/libssh2_sftp_setstat.3 create mode 100644 docs/libssh2_sftp_stat.3 create mode 100644 docs/libssh2_sftp_symlink.3 create mode 100644 docs/libssh2_sftp_unlink.3 create mode 100644 docs/libssh2_userauth_hostbased_fromfile.3 create mode 100644 docs/libssh2_userauth_keyboard_interactive.3 create mode 100644 docs/libssh2_userauth_password.3 create mode 100644 docs/libssh2_userauth_publickey_fromfile.3 diff --git a/docs/Makefile.am b/docs/Makefile.am index 40a8938..e810dc2 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -13,31 +13,50 @@ dist_man_MANS = \ libssh2_banner_set.3 \ libssh2_base64_decode.3 \ libssh2_channel_close.3 \ + libssh2_channel_direct_tcpip.3 \ libssh2_channel_direct_tcpip_ex.3 \ libssh2_channel_eof.3 \ + libssh2_channel_exec.3 \ + libssh2_channel_flush.3 \ libssh2_channel_flush_ex.3 \ + libssh2_channel_flush_stderr.3 \ libssh2_channel_forward_accept.3 \ libssh2_channel_forward_cancel.3 \ + libssh2_channel_forward_listen.3 \ libssh2_channel_forward_listen_ex.3 \ libssh2_channel_free.3 \ libssh2_channel_get_exit_status.3 \ libssh2_channel_handle_extended_data.3 \ libssh2_channel_handle_extended_data2.3 \ + libssh2_channel_ignore_extended_data.3 \ libssh2_channel_open_ex.3 \ + libssh2_channel_open_session.3 \ libssh2_channel_process_startup.3 \ + libssh2_channel_read.3 \ libssh2_channel_read_ex.3 \ + libssh2_channel_read_stderr.3 \ libssh2_channel_receive_window_adjust.3 \ libssh2_channel_receive_window_adjust2.3 \ + libssh2_channel_request_pty.3 \ libssh2_channel_request_pty_ex.3 \ + libssh2_channel_request_pty_size.3 \ libssh2_channel_request_pty_size_ex.3 \ libssh2_channel_send_eof.3 \ libssh2_channel_set_blocking.3 \ + libssh2_channel_setenv.3 \ libssh2_channel_setenv_ex.3 \ + libssh2_channel_shell.3 \ + libssh2_channel_subsystem.3 \ libssh2_channel_wait_closed.3 \ libssh2_channel_wait_eof.3 \ + libssh2_channel_window_read.3 \ libssh2_channel_window_read_ex.3 \ + libssh2_channel_window_write.3 \ libssh2_channel_window_write_ex.3 \ + libssh2_channel_write.3 \ libssh2_channel_write_ex.3 \ + libssh2_channel_write_stderr.3 \ + libssh2_channel_x11_req.3 \ libssh2_channel_x11_req_ex.3 \ libssh2_free_host_entry.3 \ libssh2_host_entry_match.3 \ @@ -45,9 +64,9 @@ dist_man_MANS = \ libssh2_knownhost_add.3 \ libssh2_knownhost_check.3 \ libssh2_knownhost_del.3 \ + libssh2_knownhost_free.3 \ libssh2_knownhost_get.3 \ libssh2_knownhost_init.3 \ - libssh2_knownhost_free.3 \ libssh2_knownhost_readfile.3 \ libssh2_knownhost_readline.3 \ libssh2_knownhost_writefile.3 \ @@ -55,22 +74,27 @@ dist_man_MANS = \ libssh2_new_host_entry.3 \ libssh2_poll.3 \ libssh2_poll_channel_read.3 \ + libssh2_publickey_add.3 \ libssh2_publickey_add_ex.3 \ libssh2_publickey_init.3 \ libssh2_publickey_list_fetch.3 \ libssh2_publickey_list_free.3 \ + libssh2_publickey_remove.3 \ libssh2_publickey_remove_ex.3 \ libssh2_publickey_shutdown.3 \ libssh2_scp_recv.3 \ + libssh2_scp_send.3 \ libssh2_scp_send_ex.3 \ libssh2_session_abstract.3 \ libssh2_session_block_directions.3 \ libssh2_session_callback_set.3 \ + libssh2_session_disconnect.3 \ libssh2_session_disconnect_ex.3 \ libssh2_session_flag.3 \ libssh2_session_free.3 \ libssh2_session_get_blocking.3 \ libssh2_session_hostkey.3 \ + libssh2_session_init.3 \ libssh2_session_init_ex.3 \ libssh2_session_last_errno.3 \ libssh2_session_last_error.3 \ @@ -78,30 +102,52 @@ dist_man_MANS = \ libssh2_session_methods.3 \ libssh2_session_set_blocking.3 \ libssh2_session_startup.3 \ + libssh2_sftp_close.3 \ libssh2_sftp_close_handle.3 \ + libssh2_sftp_closedir.3 \ + libssh2_sftp_fsetstat.3 \ + libssh2_sftp_fstat.3 \ libssh2_sftp_fstat_ex.3 \ libssh2_sftp_init.3 \ libssh2_sftp_last_error.3 \ + libssh2_sftp_lstat.3 \ + libssh2_sftp_mkdir.3 \ libssh2_sftp_mkdir_ex.3 \ + libssh2_sftp_open.3 \ libssh2_sftp_open_ex.3 \ + libssh2_sftp_opendir.3 \ libssh2_sftp_read.3 \ + libssh2_sftp_readdir.3 \ libssh2_sftp_readdir_ex.3 \ + libssh2_sftp_readlink.3 \ + libssh2_sftp_realpath.3 \ + libssh2_sftp_rename.3 \ libssh2_sftp_rename_ex.3 \ + libssh2_sftp_rewind.3 \ + libssh2_sftp_rmdir.3 \ libssh2_sftp_rmdir_ex.3 \ libssh2_sftp_seek.3 \ + libssh2_sftp_setstat.3 \ libssh2_sftp_shutdown.3 \ + libssh2_sftp_stat.3 \ libssh2_sftp_stat_ex.3 \ + libssh2_sftp_symlink.3 \ libssh2_sftp_symlink_ex.3 \ libssh2_sftp_tell.3 \ libssh2_sftp_tell64.3 \ + libssh2_sftp_unlink.3 \ libssh2_sftp_unlink_ex.3 \ libssh2_sftp_write.3 \ libssh2_trace.3 \ libssh2_trace_sethandler.3 \ libssh2_userauth_authenticated.3 \ + libssh2_userauth_hostbased_fromfile.3 \ libssh2_userauth_hostbased_fromfile_ex.3 \ + libssh2_userauth_keyboard_interactive.3 \ libssh2_userauth_keyboard_interactive_ex.3 \ libssh2_userauth_list.3 \ + libssh2_userauth_password.3 \ libssh2_userauth_password_ex.3 \ + libssh2_userauth_publickey_fromfile.3 \ libssh2_userauth_publickey_fromfile_ex.3 \ libssh2_version.3 diff --git a/docs/libssh2_channel_direct_tcpip.3 b/docs/libssh2_channel_direct_tcpip.3 new file mode 100644 index 0000000..75caa43 --- /dev/null +++ b/docs/libssh2_channel_direct_tcpip.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_direct_tcpip 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_direct_tcpip(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_direct_tcpip_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_direct_tcpip_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_direct_tcpip_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_direct_tcpip_ex(3)\fP diff --git a/docs/libssh2_channel_exec.3 b/docs/libssh2_channel_exec.3 new file mode 100644 index 0000000..57c856a --- /dev/null +++ b/docs/libssh2_channel_exec.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_exec 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_exec(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_process_startup(3)\fP diff --git a/docs/libssh2_channel_flush.3 b/docs/libssh2_channel_flush.3 new file mode 100644 index 0000000..967aa49 --- /dev/null +++ b/docs/libssh2_channel_flush.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_flush 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_flush(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_flush_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_flush_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_flush_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_flush_ex(3)\fP diff --git a/docs/libssh2_channel_flush_stderr.3 b/docs/libssh2_channel_flush_stderr.3 new file mode 100644 index 0000000..32b0716 --- /dev/null +++ b/docs/libssh2_channel_flush_stderr.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_flush_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_flush_stderr(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_flush_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_flush_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_flush_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_flush_ex(3)\fP diff --git a/docs/libssh2_channel_forward_listen.3 b/docs/libssh2_channel_forward_listen.3 new file mode 100644 index 0000000..2b0c200 --- /dev/null +++ b/docs/libssh2_channel_forward_listen.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_forward_listen 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_forward_listen(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_forward_listen_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_forward_listen_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_forward_listen_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_forward_listen_ex(3)\fP diff --git a/docs/libssh2_channel_ignore_extended_data.3 b/docs/libssh2_channel_ignore_extended_data.3 new file mode 100644 index 0000000..f205950 --- /dev/null +++ b/docs/libssh2_channel_ignore_extended_data.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_ignore_extended_data 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_ignore_extended_data(arguments) + +.SH DESCRIPTION +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 +See \fIlibssh2_channel_handle_extended_data(3)\fP +.SH ERRORS +See \fIlibssh2_channel_handle_extended_data(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_handle_extended_data(3)\fP diff --git a/docs/libssh2_channel_open_session.3 b/docs/libssh2_channel_open_session.3 new file mode 100644 index 0000000..1e558f0 --- /dev/null +++ b/docs/libssh2_channel_open_session.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_open_session 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_open_session(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_open_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_open_ex(3)\fP diff --git a/docs/libssh2_channel_read.3 b/docs/libssh2_channel_read.3 new file mode 100644 index 0000000..13f7b3c --- /dev/null +++ b/docs/libssh2_channel_read.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_read(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_read_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_read_ex(3)\fP diff --git a/docs/libssh2_channel_read_stderr.3 b/docs/libssh2_channel_read_stderr.3 new file mode 100644 index 0000000..1f7c500 --- /dev/null +++ b/docs/libssh2_channel_read_stderr.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_read_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_read_stderr(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_read_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_read_ex(3)\fP diff --git a/docs/libssh2_channel_request_pty.3 b/docs/libssh2_channel_request_pty.3 new file mode 100644 index 0000000..0c60f91 --- /dev/null +++ b/docs/libssh2_channel_request_pty.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_request_pty 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_request_pty(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_request_pty_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_request_pty_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_request_pty_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_request_pty_ex(3)\fP diff --git a/docs/libssh2_channel_request_pty_size.3 b/docs/libssh2_channel_request_pty_size.3 new file mode 100644 index 0000000..361f260 --- /dev/null +++ b/docs/libssh2_channel_request_pty_size.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_request_pty_size 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_request_pty_size(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_request_pty_size_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_request_pty_size_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_request_pty_size_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_request_pty_size_ex(3)\fP diff --git a/docs/libssh2_channel_setenv.3 b/docs/libssh2_channel_setenv.3 new file mode 100644 index 0000000..57d6b70 --- /dev/null +++ b/docs/libssh2_channel_setenv.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_setenv 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_setenv(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_setenv_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_setenv_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_setenv_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_setenv_ex(3)\fP diff --git a/docs/libssh2_channel_shell.3 b/docs/libssh2_channel_shell.3 new file mode 100644 index 0000000..d3daad6 --- /dev/null +++ b/docs/libssh2_channel_shell.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_shell 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_shell(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_process_startup(3)\fP diff --git a/docs/libssh2_channel_subsystem.3 b/docs/libssh2_channel_subsystem.3 new file mode 100644 index 0000000..9233e86 --- /dev/null +++ b/docs/libssh2_channel_subsystem.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_subsystem 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_subsystem(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_process_startup(3)\fP diff --git a/docs/libssh2_channel_window_read.3 b/docs/libssh2_channel_window_read.3 new file mode 100644 index 0000000..c2a0912 --- /dev/null +++ b/docs/libssh2_channel_window_read.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_window_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_window_read(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_window_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_window_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_window_read_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_window_read_ex(3)\fP diff --git a/docs/libssh2_channel_window_write.3 b/docs/libssh2_channel_window_write.3 new file mode 100644 index 0000000..e541b9a --- /dev/null +++ b/docs/libssh2_channel_window_write.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_window_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_window_write(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_window_write_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_window_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_window_write_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_window_write_ex(3)\fP diff --git a/docs/libssh2_channel_write.3 b/docs/libssh2_channel_write.3 new file mode 100644 index 0000000..588de3c --- /dev/null +++ b/docs/libssh2_channel_write.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_write(arguments) + +.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. +.SH RETURN VALUE +See \fIlibssh2_channel_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_write_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_write_ex(3)\fP diff --git a/docs/libssh2_channel_write_stderr.3 b/docs/libssh2_channel_write_stderr.3 new file mode 100644 index 0000000..7ac6876 --- /dev/null +++ b/docs/libssh2_channel_write_stderr.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_write_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_write_stderr(arguments) + +.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. +.SH RETURN VALUE +See \fIlibssh2_channel_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_write_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_write_ex(3)\fP diff --git a/docs/libssh2_channel_x11_req.3 b/docs/libssh2_channel_x11_req.3 new file mode 100644 index 0000000..b1db8d9 --- /dev/null +++ b/docs/libssh2_channel_x11_req.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_channel_x11_req 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_channel_x11_req(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_x11_req_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_x11_req_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_x11_req_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_channel_x11_req_ex(3)\fP diff --git a/docs/libssh2_publickey_add.3 b/docs/libssh2_publickey_add.3 new file mode 100644 index 0000000..0557316 --- /dev/null +++ b/docs/libssh2_publickey_add.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_publickey_add 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_publickey_add(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_publickey_add_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_publickey_add_ex(3)\fP +.SH ERRORS +See \fIlibssh2_publickey_add_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_publickey_add_ex(3)\fP diff --git a/docs/libssh2_publickey_remove.3 b/docs/libssh2_publickey_remove.3 new file mode 100644 index 0000000..77a6e28 --- /dev/null +++ b/docs/libssh2_publickey_remove.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_publickey_remove 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_publickey_remove(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_publickey_remove_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_publickey_remove_ex(3)\fP +.SH ERRORS +See \fIlibssh2_publickey_remove_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_publickey_remove_ex(3)\fP diff --git a/docs/libssh2_scp_send.3 b/docs/libssh2_scp_send.3 new file mode 100644 index 0000000..b4e17ca --- /dev/null +++ b/docs/libssh2_scp_send.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_scp_send 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_scp_send(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_scp_send_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_scp_send_ex(3)\fP +.SH ERRORS +See \fIlibssh2_scp_send_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_scp_send_ex(3)\fP diff --git a/docs/libssh2_session_disconnect.3 b/docs/libssh2_session_disconnect.3 new file mode 100644 index 0000000..c74a3fb --- /dev/null +++ b/docs/libssh2_session_disconnect.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_session_disconnect 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_session_disconnect(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_session_disconnect_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_session_disconnect_ex(3)\fP +.SH ERRORS +See \fIlibssh2_session_disconnect_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_session_disconnect_ex(3)\fP diff --git a/docs/libssh2_session_init.3 b/docs/libssh2_session_init.3 new file mode 100644 index 0000000..f369fd9 --- /dev/null +++ b/docs/libssh2_session_init.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_session_init 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_session_init - convenience macro for \fIlibssh2_session_init_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_session_init(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_session_init_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_session_init_ex(3)\fP +.SH ERRORS +See \fIlibssh2_session_init_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_session_init_ex(3)\fP diff --git a/docs/libssh2_sftp_close.3 b/docs/libssh2_sftp_close.3 new file mode 100644 index 0000000..051035a --- /dev/null +++ b/docs/libssh2_sftp_close.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_close 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_close - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_close(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_close_handle(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_close_handle(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_close_handle(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_close_handle(3)\fP diff --git a/docs/libssh2_sftp_closedir.3 b/docs/libssh2_sftp_closedir.3 new file mode 100644 index 0000000..caca158 --- /dev/null +++ b/docs/libssh2_sftp_closedir.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_closedir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_closedir - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_closedir(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_close_handle(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_close_handle(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_close_handle(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_close_handle(3)\fP diff --git a/docs/libssh2_sftp_fsetstat.3 b/docs/libssh2_sftp_fsetstat.3 new file mode 100644 index 0000000..9ba8df5 --- /dev/null +++ b/docs/libssh2_sftp_fsetstat.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_fsetstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_fsetstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_fsetstat(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_fstat_ex(3)\fP diff --git a/docs/libssh2_sftp_fstat.3 b/docs/libssh2_sftp_fstat.3 new file mode 100644 index 0000000..7155a28 --- /dev/null +++ b/docs/libssh2_sftp_fstat.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_fstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_fstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_fstat(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_fstat_ex(3)\fP diff --git a/docs/libssh2_sftp_lstat.3 b/docs/libssh2_sftp_lstat.3 new file mode 100644 index 0000000..c251b2b --- /dev/null +++ b/docs/libssh2_sftp_lstat.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_lstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_lstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_lstat(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_stat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_stat_ex(3)\fP diff --git a/docs/libssh2_sftp_mkdir.3 b/docs/libssh2_sftp_mkdir.3 new file mode 100644 index 0000000..c7ad5bb --- /dev/null +++ b/docs/libssh2_sftp_mkdir.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_mkdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_mkdir - convenience macro for \fIlibssh2_sftp_mkdir_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_mkdir(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_mkdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_mkdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_mkdir_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_mkdir_ex(3)\fP diff --git a/docs/libssh2_sftp_open.3 b/docs/libssh2_sftp_open.3 new file mode 100644 index 0000000..02bffee --- /dev/null +++ b/docs/libssh2_sftp_open.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_open 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_open - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_open(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_open_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_open_ex(3)\fP diff --git a/docs/libssh2_sftp_opendir.3 b/docs/libssh2_sftp_opendir.3 new file mode 100644 index 0000000..7e9605f --- /dev/null +++ b/docs/libssh2_sftp_opendir.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_opendir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_opendir - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_opendir(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_open_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_open_ex(3)\fP diff --git a/docs/libssh2_sftp_readdir.3 b/docs/libssh2_sftp_readdir.3 new file mode 100644 index 0000000..a3d57c4 --- /dev/null +++ b/docs/libssh2_sftp_readdir.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_readdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_readdir - convenience macro for \fIlibssh2_sftp_readdir_exa(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_readdir(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_readdir_exa(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_readdir_exa(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_readdir_exa(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_readdir_exa(3)\fP diff --git a/docs/libssh2_sftp_readlink.3 b/docs/libssh2_sftp_readlink.3 new file mode 100644 index 0000000..0aea3eb --- /dev/null +++ b/docs/libssh2_sftp_readlink.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_readlink(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_symlink_ex(3)\fP diff --git a/docs/libssh2_sftp_realpath.3 b/docs/libssh2_sftp_realpath.3 new file mode 100644 index 0000000..59fd65d --- /dev/null +++ b/docs/libssh2_sftp_realpath.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_realpath 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_realpath - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_realpath(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_symlink_ex(3)\fP diff --git a/docs/libssh2_sftp_rename.3 b/docs/libssh2_sftp_rename.3 new file mode 100644 index 0000000..ab2cd59 --- /dev/null +++ b/docs/libssh2_sftp_rename.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_rename 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_rename - convenience macro for \fIlibssh2_sftp_rename_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_rename(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_rename_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_rename_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_rename_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_rename_ex(3)\fP diff --git a/docs/libssh2_sftp_rewind.3 b/docs/libssh2_sftp_rewind.3 new file mode 100644 index 0000000..2e2f345 --- /dev/null +++ b/docs/libssh2_sftp_rewind.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_rewind 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_rewind - convenience macro for \fIlibssh2_sftp_seek64(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_rewind(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_seek64(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_seek64(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_seek64(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_seek64(3)\fP diff --git a/docs/libssh2_sftp_rmdir.3 b/docs/libssh2_sftp_rmdir.3 new file mode 100644 index 0000000..9de1074 --- /dev/null +++ b/docs/libssh2_sftp_rmdir.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_rmdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_rmdir - convenience macro for \fIlibssh2_sftp_rmdir_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_rmdir(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_rmdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_rmdir_ex(3)\fP diff --git a/docs/libssh2_sftp_setstat.3 b/docs/libssh2_sftp_setstat.3 new file mode 100644 index 0000000..0040843 --- /dev/null +++ b/docs/libssh2_sftp_setstat.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_setstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_setstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_setstat(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_stat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_stat_ex(3)\fP diff --git a/docs/libssh2_sftp_stat.3 b/docs/libssh2_sftp_stat.3 new file mode 100644 index 0000000..d4395f4 --- /dev/null +++ b/docs/libssh2_sftp_stat.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_stat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_stat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_stat(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_fstat_ex(3)\fP diff --git a/docs/libssh2_sftp_symlink.3 b/docs/libssh2_sftp_symlink.3 new file mode 100644 index 0000000..2cabe2d --- /dev/null +++ b/docs/libssh2_sftp_symlink.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_symlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_symlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_symlink(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_symlink_ex(3)\fP diff --git a/docs/libssh2_sftp_unlink.3 b/docs/libssh2_sftp_unlink.3 new file mode 100644 index 0000000..4666b35 --- /dev/null +++ b/docs/libssh2_sftp_unlink.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_sftp_unlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_unlink - convenience macro for \fIlibssh2_sftp_unlink_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_sftp_unlink(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_unlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_unlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_unlink_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_sftp_unlink_ex(3)\fP diff --git a/docs/libssh2_userauth_hostbased_fromfile.3 b/docs/libssh2_userauth_hostbased_fromfile.3 new file mode 100644 index 0000000..9fef666 --- /dev/null +++ b/docs/libssh2_userauth_hostbased_fromfile.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_userauth_hostbased_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_userauth_hostbased_fromfile - convenience macro for \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_userauth_hostbased_fromfile(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP diff --git a/docs/libssh2_userauth_keyboard_interactive.3 b/docs/libssh2_userauth_keyboard_interactive.3 new file mode 100644 index 0000000..fde8aff --- /dev/null +++ b/docs/libssh2_userauth_keyboard_interactive.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.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_userauth_keyboard_interactive(arguments) + +.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 +.BR \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP diff --git a/docs/libssh2_userauth_password.3 b/docs/libssh2_userauth_password.3 new file mode 100644 index 0000000..2d3782a --- /dev/null +++ b/docs/libssh2_userauth_password.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_userauth_password 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_userauth_password - convenience macro for \fIlibssh2_userauth_password_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_userauth_password(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_password_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_password_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_password_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_userauth_password_ex(3)\fP diff --git a/docs/libssh2_userauth_publickey_fromfile.3 b/docs/libssh2_userauth_publickey_fromfile.3 new file mode 100644 index 0000000..513322d --- /dev/null +++ b/docs/libssh2_userauth_publickey_fromfile.3 @@ -0,0 +1,19 @@ +.\" $Id: template.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" +.TH libssh2_userauth_publickey_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_userauth_publickey_fromfile - convenience macro for \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP calls +.SH SYNOPSIS +#include + +libssh2_userauth_publickey_fromfile(arguments) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP +.SH SEE ALSO +.BR \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP