From 8096b459d442c773df4ec5557a78ca9a82aa6a56 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 16 Mar 2009 23:25:14 +0000 Subject: [PATCH] cleanup round --- docs/libssh2_channel_close.3 | 4 ++-- docs/libssh2_channel_eof.3 | 6 +++--- docs/libssh2_channel_forward_accept.3 | 6 +++--- docs/libssh2_channel_forward_cancel.3 | 6 +++--- docs/libssh2_channel_process_startup.3 | 9 +++------ docs/libssh2_channel_receive_window_adjust.3 | 4 ++-- docs/libssh2_channel_request_pty_ex.3 | 9 +++------ docs/libssh2_channel_setenv_ex.3 | 12 ++++++------ docs/libssh2_channel_window_read_ex.3 | 6 +++--- docs/libssh2_channel_window_write_ex.3 | 6 +++--- docs/libssh2_channel_write_ex.3 | 9 +++++---- docs/libssh2_channel_x11_req_ex.3 | 10 +++++----- docs/libssh2_scp_recv.3 | 19 ++++++------------- docs/libssh2_scp_send_ex.3 | 20 +++++--------------- docs/libssh2_session_free.3 | 9 ++++----- docs/libssh2_session_set_blocking.3 | 6 +++--- docs/libssh2_session_startup.3 | 6 +++--- docs/libssh2_sftp_close_handle.3 | 11 +++++------ docs/libssh2_sftp_fstat_ex.3 | 9 +++------ docs/libssh2_sftp_init.3 | 8 ++++---- docs/libssh2_sftp_mkdir_ex.3 | 8 ++------ docs/libssh2_sftp_open_ex.3 | 8 ++++---- docs/libssh2_sftp_read.3 | 18 ++++++++---------- docs/libssh2_sftp_readdir_ex.3 | 13 ++++++------- docs/libssh2_sftp_seek.3 | 4 ++-- 25 files changed, 96 insertions(+), 130 deletions(-) diff --git a/docs/libssh2_channel_close.3 b/docs/libssh2_channel_close.3 index 5d85c3d7..74581cee 100644 --- a/docs/libssh2_channel_close.3 +++ b/docs/libssh2_channel_close.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_close.3,v 1.2 2007/11/29 09:57:22 bagder Exp $ +.\" $Id: libssh2_channel_close.3,v 1.3 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -28,4 +28,4 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. .SH SEE ALSO -.BR libssh2_channel_open(3) +.BR libssh2_channel_open_ex(3) diff --git a/docs/libssh2_channel_eof.3 b/docs/libssh2_channel_eof.3 index 50667316..c5a6092a 100644 --- a/docs/libssh2_channel_eof.3 +++ b/docs/libssh2_channel_eof.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_eof.3,v 1.1 2007/06/13 17:22:15 jehousley Exp $ +.\" $Id: libssh2_channel_eof.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -8,11 +8,11 @@ libssh2_channel_eof - check a channel's EOF status int libssh2_channel_eof(LIBSSH2_CHANNEL *channel); - .SH DESCRIPTION \fIchannel\fP - active channel stream to set closed status on. Check if the remote host has sent an EOF status for the selected stream. - .SH RETURN VALUE Returns 1 if the remote host has sent EOF, otherwise 0. +.SH SEE ALSO +.BR libssh2_channel_close(3) diff --git a/docs/libssh2_channel_forward_accept.3 b/docs/libssh2_channel_forward_accept.3 index 43232e5d..f3f7bb86 100644 --- a/docs/libssh2_channel_forward_accept.3 +++ b/docs/libssh2_channel_forward_accept.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_forward_accept.3,v 1.5 2007/06/13 16:41:33 jehousley Exp $ +.\" $Id: libssh2_channel_forward_accept.3,v 1.6 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -11,11 +11,11 @@ libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener); .SH DESCRIPTION \fIlistener\fP is a forwarding listener instance as returned by -\fBlibssh2_channel_forward_listen(3)\fP. +\fBlibssh2_channel_forward_listen_ex(3)\fP. .SH RETURN VALUE A newly allocated channel instance or NULL on failure. .SH ERRORS \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. .SH SEE ALSO -.BR libssh2_channel_forward_listen(3) +.BR libssh2_channel_forward_listen_ex(3) diff --git a/docs/libssh2_channel_forward_cancel.3 b/docs/libssh2_channel_forward_cancel.3 index 822e0086..ab7622a3 100644 --- a/docs/libssh2_channel_forward_cancel.3 +++ b/docs/libssh2_channel_forward_cancel.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_forward_cancel.3,v 1.1 2007/06/13 19:53:09 jehousley Exp $ +.\" $Id: libssh2_channel_forward_cancel.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -11,7 +11,7 @@ libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); .SH DESCRIPTION /fIlistener/fP - Forwarding listener instance as returned by -.BR libssh2_channel_forward_listen(3) +.BR libssh2_channel_forward_listen_ex(3) Instruct the remote host to stop listening for new connections on a previously requested host/port. @@ -26,4 +26,4 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. .SH SEE ALSO -.BR libssh2_channel_forward_listen(3) +.BR libssh2_channel_forward_listen_ex(3) diff --git a/docs/libssh2_channel_process_startup.3 b/docs/libssh2_channel_process_startup.3 index 99342fdf..f645fe00 100644 --- a/docs/libssh2_channel_process_startup.3 +++ b/docs/libssh2_channel_process_startup.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_process_startup.3,v 1.1 2007/06/13 20:54:25 jehousley Exp $ +.\" $Id: libssh2_channel_process_startup.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -31,19 +31,16 @@ defines shell, exec, and subsystem as standard process services. \fImessage_len\fP - Length of message parameter. Initiate a request on a session type channel such as returned by -.BR libssh2_channel_open_session(3) - +.BR libssh2_channel_open_ex(3) .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - - .SH SEE ALSO -.BR libssh2_channel_open_session(3) +.BR libssh2_channel_open_ex(3) diff --git a/docs/libssh2_channel_receive_window_adjust.3 b/docs/libssh2_channel_receive_window_adjust.3 index ceabfaf7..361b8cde 100644 --- a/docs/libssh2_channel_receive_window_adjust.3 +++ b/docs/libssh2_channel_receive_window_adjust.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_receive_window_adjust.3,v 1.1 2009/03/15 22:59:46 bagder Exp $ +.\" $Id: libssh2_channel_receive_window_adjust.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -25,4 +25,4 @@ non-blocking channels where it would otherwise block. However, that is a negative number and this function only returns an unsigned value and this then leads to a very strange value being returned. .SH SEE ALSO -libssh2_channel_window_read_ex(3) +.BR libssh2_channel_window_read_ex(3) diff --git a/docs/libssh2_channel_request_pty_ex.3 b/docs/libssh2_channel_request_pty_ex.3 index ba69a2df..6e2504c4 100644 --- a/docs/libssh2_channel_request_pty_ex.3 +++ b/docs/libssh2_channel_request_pty_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_request_pty_ex.3,v 1.1 2007/06/13 21:07:59 jehousley Exp $ +.\" $Id: libssh2_channel_request_pty_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -14,7 +14,7 @@ libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term); .SH DESCRIPTION \fIchannel\fP - Previously opened channel instance such as returned by -.BR libssh2_channel_open_session(3) +.BR libssh2_channel_open_ex(3) \fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...) @@ -35,18 +35,15 @@ libssh2_channel_request_pty(LIBSSH2_CHANNEL *channel, char *term); Request a PTY on an established channel. Note that this does not make sense for all channel types and may be ignored by the server despite returning success. - .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - - .SH SEE ALSO -.BR libssh2_channel_open_session(3) +.BR libssh2_channel_open_ex(3) diff --git a/docs/libssh2_channel_setenv_ex.3 b/docs/libssh2_channel_setenv_ex.3 index 76889039..aa1bed12 100644 --- a/docs/libssh2_channel_setenv_ex.3 +++ b/docs/libssh2_channel_setenv_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_setenv_ex.3,v 1.1 2007/06/13 21:30:15 jehousley Exp $ +.\" $Id: libssh2_channel_setenv_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -14,7 +14,7 @@ libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *valu .SH DESCRIPTION \fIchannel\fP - Previously opened channel instance such as returned by -.BR libssh2_channel_open_session(3) +.BR libssh2_channel_open_ex(3) \fIvarname\fP - Name of environment variable to set on the remote channel instance. @@ -25,8 +25,9 @@ channel instance. \fIvalue_len\fP - Length of value parameter. -Set an environment variable in the remote channel's process space. Note that this does not make sense for all channel types and may be ignored by the server despite returning success. - +Set an environment variable in the remote channel's process space. Note that +this does not make sense for all channel types and may be ignored by the +server despite returning success. .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While @@ -38,6 +39,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - - .SH SEE ALSO -.BR libssh2_channel_open_session(3) +.BR libssh2_channel_open_ex(3) diff --git a/docs/libssh2_channel_window_read_ex.3 b/docs/libssh2_channel_window_read_ex.3 index 4b70b658..4cb0d267 100644 --- a/docs/libssh2_channel_window_read_ex.3 +++ b/docs/libssh2_channel_window_read_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_window_read_ex.3,v 1.1 2009/03/15 22:59:46 bagder Exp $ +.\" $Id: libssh2_channel_window_read_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_window_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -22,5 +22,5 @@ window limit .SH ERRORS .SH SEE ALSO -libssh2_channel_receive_window_adjust(3), -libssh2_channel_window_write_ex(3) +.BR libssh2_channel_receive_window_adjust(3), +.BR libssh2_channel_window_write_ex(3) diff --git a/docs/libssh2_channel_window_write_ex.3 b/docs/libssh2_channel_window_write_ex.3 index 7bcf15f8..3ed728df 100644 --- a/docs/libssh2_channel_window_write_ex.3 +++ b/docs/libssh2_channel_window_write_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_window_write_ex.3,v 1.1 2009/03/15 22:59:46 bagder Exp $ +.\" $Id: libssh2_channel_window_write_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_window_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -19,5 +19,5 @@ Number of bytes which may be safely writen on the channel without blocking. .SH ERRORS .SH SEE ALSO -libssh2_channel_window_read_ex(3), -libssh2_channel_receive_window_adjust(3) +.BR libssh2_channel_window_read_ex(3), +.BR libssh2_channel_receive_window_adjust(3) diff --git a/docs/libssh2_channel_write_ex.3 b/docs/libssh2_channel_write_ex.3 index 9a3cba15..a776f7f5 100644 --- a/docs/libssh2_channel_write_ex.3 +++ b/docs/libssh2_channel_write_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_write_ex.3,v 1.5 2007/06/13 16:41:33 jehousley Exp $ +.\" $Id: libssh2_channel_write_ex.3,v 1.6 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -41,7 +41,8 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed. -\fILIBSSH2_ERROR_CHANNEL_EOF_SENT\fP - The channel has been requested to be closed. +\fILIBSSH2_ERROR_CHANNEL_EOF_SENT\fP - The channel has been requested to be +closed. .SH SEE ALSO -.BR libssh2_channel_open_session(3) -.BR libssh2_channel_read(3) +.BR libssh2_channel_open_ex(3) +.BR libssh2_channel_read_ex(3) diff --git a/docs/libssh2_channel_x11_req_ex.3 b/docs/libssh2_channel_x11_req_ex.3 index 7a457223..2101af20 100644 --- a/docs/libssh2_channel_x11_req_ex.3 +++ b/docs/libssh2_channel_x11_req_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_channel_x11_req_ex.3,v 1.1 2007/06/13 21:30:15 jehousley Exp $ +.\" $Id: libssh2_channel_x11_req_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -14,7 +14,7 @@ libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); .SH DESCRIPTION \fIchannel\fP - Previously opened channel instance such as returned by -.BR libssh2_channel_open_session(3) +.BR libssh2_channel_open_ex(3) \fIsingle_connection\fP - non-zero to only forward a single connection. @@ -26,8 +26,8 @@ libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); Request an X11 forwarding on \fIchannel\fP. To use X11 forwarding, .BR libssh2_session_callback_set(3) -must first be called to set \fBLIBSSH2_CALLBACK_X11/fP. This callback will -be invoked when the remote host accepts the X11 forwarding. +must first be called to set \fBLIBSSH2_CALLBACK_X11\fP. This callback will be +invoked when the remote host accepts the X11 forwarding. .SH RETURN VALUE Return 0 on success or negative on failure. It returns @@ -42,5 +42,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_CHANNEL_REQUEST_DENIED\fP - .SH SEE ALSO -.BR libssh2_channel_open_session(3) +.BR libssh2_channel_open_ex(3) .BR libssh2_session_callback_set(3) diff --git a/docs/libssh2_scp_recv.3 b/docs/libssh2_scp_recv.3 index 99f8cad0..a77fbf4f 100644 --- a/docs/libssh2_scp_recv.3 +++ b/docs/libssh2_scp_recv.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_scp_recv.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $ +.\" $Id: libssh2_scp_recv.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -17,24 +17,17 @@ libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb); \fIsb\fP - Populated with remote file's size, mode, mtime, and atime -Request a file from the remote host via SCP. This -function acts as a wrapper calling -.BR libssh2_channel_open_session(3) -, -.BR libssh2_channel_exec(3) -, and negotiating rcp protocol handshakes. - +Request a file from the remote host via SCP. .SH RETURN VALUE Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_SCP_PROTOCOL\fP - -\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. - +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. .SH SEE ALSO .BR libssh2_session_init(3) -.BR libssh2_channel_open_session(3) -.BR libssh2_channel_exec(3) +.BR libssh2_channel_open_ex(3) + diff --git a/docs/libssh2_scp_send_ex.3 b/docs/libssh2_scp_send_ex.3 index 1b128938..a5bd4332 100644 --- a/docs/libssh2_scp_send_ex.3 +++ b/docs/libssh2_scp_send_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_scp_send_ex.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $ +.\" $Id: libssh2_scp_send_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_scp_send_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -8,10 +8,6 @@ libssh2_scp_send_ex - Send a file via SCP LIBSSH2_CHANNEL * libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size, long mtime, long atime); - -LIBSSH2_CHANNEL * -libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size); - .SH DESCRIPTION \fIsession\fP - Session instance as returned by .BR libssh2_session_init(3) @@ -28,13 +24,7 @@ ahead of time precisely) \fIatime\fP - atime to assign to file being created (Set this and mtime to zero to instruct remote host to use current time). -Send a file to the remote host via SCP. This function -acts as a wrapper calling -.BR libssh2_channel_open_session(3) -, -.BR libssh2_channel_exec(3) -, and negotiating rcp protocol handshakes. - +Send a file to the remote host via SCP. .SH RETURN VALUE Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. @@ -45,8 +35,8 @@ Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. \fILIBSSH2_ERROR_SCP_PROTOCOL\fP - -\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. .SH SEE ALSO -.BR libssh2_channel_open_session(3) -.BR libssh2_channel_exec(3) +.BR libssh2_channel_open_ex(3) diff --git a/docs/libssh2_session_free.3 b/docs/libssh2_session_free.3 index 0ea781d1..75c68560 100644 --- a/docs/libssh2_session_free.3 +++ b/docs/libssh2_session_free.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_session_free.3,v 1.4 2007/06/13 16:41:33 jehousley Exp $ +.\" $Id: libssh2_session_free.3,v 1.5 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -10,12 +10,11 @@ int libssh2_session_free(LIBSSH2_SESSION *session); .SH DESCRIPTION Frees resources associated with a session instance. Typically called after -.BR libssh2_session_disconnect(3) - +.BR libssh2_session_disconnect_ex(3) .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. .SH SEE ALSO -.BR libssh2_session_init(3) -.BR libssh2_session_disconnect(3) +.BR libssh2_session_init_ex(3) +.BR libssh2_session_disconnect_ex(3) diff --git a/docs/libssh2_session_set_blocking.3 b/docs/libssh2_session_set_blocking.3 index 6fabae6f..1e53ed78 100644 --- a/docs/libssh2_session_set_blocking.3 +++ b/docs/libssh2_session_set_blocking.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_session_set_blocking.3,v 1.2 2008/07/03 10:58:53 bagder Exp $ +.\" $Id: libssh2_session_set_blocking.3,v 1.3 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -11,7 +11,7 @@ libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking); .SH DESCRIPTION \fIsession\fP - session instance as returned by -.BR libssh2_session_init(3) +.BR libssh2_session_init_ex(3) \fIblocking\fP - Set to a non-zero value to make the channel block, or zero to make it non-blocking. @@ -29,4 +29,4 @@ anything. None .SH SEE ALSO -.BR libssh2_session_init(3) +.BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_session_startup.3 b/docs/libssh2_session_startup.3 index 42c3bbef..44bbb5d9 100644 --- a/docs/libssh2_session_startup.3 +++ b/docs/libssh2_session_startup.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_session_startup.3,v 1.6 2007/06/13 16:41:33 jehousley Exp $ +.\" $Id: libssh2_session_startup.3,v 1.7 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -11,7 +11,7 @@ libssh2_session_startup(LIBSSH2_SESSION *session, int socket); .SH DESCRIPTION \fIsession\fP - Session instance as returned by -.BR libssh2_session_init(3) +.BR libssh2_session_init_ex(3) \fIsocket\fP - Connected socket descriptor. Typically a TCP connection though the protocol allows for any reliable transport and the library will @@ -39,4 +39,4 @@ the socket. .SH SEE ALSO .BR libssh2_session_free(3) -.BR libssh2_session_init(3) +.BR libssh2_session_init_ex(3) diff --git a/docs/libssh2_sftp_close_handle.3 b/docs/libssh2_sftp_close_handle.3 index 37c87e23..7d3a0c9a 100644 --- a/docs/libssh2_sftp_close_handle.3 +++ b/docs/libssh2_sftp_close_handle.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_close_handle.3,v 1.1 2007/06/14 15:45:03 jehousley Exp $ +.\" $Id: libssh2_sftp_close_handle.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -25,11 +25,11 @@ or Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the same underlying storage mechanism these methods may be used interchangably. It is recommended that -.BR libssh2_sftp_close() +.BR libssh2_sftp_closedir() be used for files and that .BR libssh2_sftp_closedir() -be used for directories so that future changes in the library -may cause minimal disruption. +be used for directories so that future changes in the library may cause +minimal disruption. Both are macros for \fBlibssh2_sftp_close_handle\fP. .SH RETURN VALUE Return 0 on success or negative on failure. It returns @@ -48,5 +48,4 @@ received on the socket, or an SFTP operation caused an errorcode to be returned by the server. .SH SEE ALSO -.BR libssh2_sftp_open(3) -.BR libssh2_sftp_opendir(3) +.BR libssh2_sftp_open_ex(3) diff --git a/docs/libssh2_sftp_fstat_ex.3 b/docs/libssh2_sftp_fstat_ex.3 index 45e4f4fe..28adb55d 100644 --- a/docs/libssh2_sftp_fstat_ex.3 +++ b/docs/libssh2_sftp_fstat_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_fstat_ex.3,v 1.1 2007/06/14 15:45:03 jehousley Exp $ +.\" $Id: libssh2_sftp_fstat_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -18,7 +18,7 @@ libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attr .SH DESCRIPTION \fIhandle\fP - SFTP File Handle as returned by -.BR libssh2_sftp_open(3) +.BR libssh2_sftp_open_ex(3) \fIattrs\fP - Pointer to attribute structure to set file metadata from or into depending on the value of setstat. @@ -28,12 +28,10 @@ with the data found in attrs according to the values of attrs->flags and other relevant member attributes. Get or Set statbuf type data for a given LIBSSH2_SFTP_HANDLE instance. - .SH RETURN VALUE Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. @@ -44,6 +42,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO -.BR libssh2_sftp_open(3) +.BR libssh2_sftp_open_ex(3) diff --git a/docs/libssh2_sftp_init.3 b/docs/libssh2_sftp_init.3 index 7d738312..ec90ef1c 100644 --- a/docs/libssh2_sftp_init.3 +++ b/docs/libssh2_sftp_init.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_init.3,v 1.7 2007/11/21 14:07:32 dottedmag Exp $ +.\" $Id: libssh2_sftp_init.3,v 1.8 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -12,7 +12,7 @@ libssh2_sftp_init(LIBSSH2_SESSION *session); .SH DESCRIPTION \fIsession\fP - Session instance as returned by -.BR libssh2_session_init(3) +.BR libssh2_session_init_ex(3) Open a channel and initialize the SFTP subsystem. Although the SFTP subsystem operates over the same type of channel as those exported by the Channel API, @@ -34,8 +34,8 @@ A pointer to the newly allocated SFTP instance or NULL on failure. received on the socket, or an SFTP operation caused an errorcode to be returned by the server. -\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. - +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. .SH SEE ALSO .BR libssh2_sftp_shutdown(3) .BR libssh2_sftp_open_ex(3) diff --git a/docs/libssh2_sftp_mkdir_ex.3 b/docs/libssh2_sftp_mkdir_ex.3 index b0936f0c..2e9e34b9 100644 --- a/docs/libssh2_sftp_mkdir_ex.3 +++ b/docs/libssh2_sftp_mkdir_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.6 2007/06/13 16:41:33 jehousley Exp $ +.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.7 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -12,7 +12,6 @@ libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_le int libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode); - .SH DESCRIPTION \fIsftp\fP - SFTP instance as returned by .BR libssh2_sftp_init(3) @@ -25,12 +24,10 @@ directory's parents must all exist priot to making this call. \fImode\fP - directory creation mode (e.g. 0755). Create a directory on the remote file system. - .SH RETURN VALUE Return 0 on success or negative on failure. LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. - .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. @@ -41,6 +38,5 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO -.BR libssh2_sftp_opendir(3) +.BR libssh2_sftp_open_ex(3) diff --git a/docs/libssh2_sftp_open_ex.3 b/docs/libssh2_sftp_open_ex.3 index 6617e787..981c32dc 100644 --- a/docs/libssh2_sftp_open_ex.3 +++ b/docs/libssh2_sftp_open_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_open_ex.3,v 1.9 2007/11/21 14:07:32 dottedmag Exp $ +.\" $Id: libssh2_sftp_open_ex.3,v 1.10 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -46,8 +46,8 @@ failure. received on the socket, or an SFTP operation caused an errorcode to be returned by the server. -\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. - +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. .SH SEE ALSO -.BR libssh_sftp_close(3) +.BR libssh2_sftp_close_handle(3) diff --git a/docs/libssh2_sftp_read.3 b/docs/libssh2_sftp_read.3 index 15d7473f..cc07c719 100644 --- a/docs/libssh2_sftp_read.3 +++ b/docs/libssh2_sftp_read.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_read.3,v 1.8 2007/06/13 16:41:33 jehousley Exp $ +.\" $Id: libssh2_sftp_read.3,v 1.9 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_read 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -23,10 +23,9 @@ after the POSIX .BR read(2) function and uses the same calling semantics. .BR libssh2_sftp_read(3) -will attempt to read as much as possible however it may not fill all of -buffer if the file pointer reaches the end or -if further reads would cause the socket to block. - +will attempt to read as much as possible however it may not fill all of buffer +if the file pointer reaches the end or if further reads would cause the socket +to block. .SH RETURN VALUE Number of bytes actually populated into buffer, or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While @@ -38,10 +37,9 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - -\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was -received on the socket, or an SFTP operation caused an errorcode to be +\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was +received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO -.BR libssh2_sftp_open(3) -.BR libssh2_sftp_readnb(3) +.BR libssh2_sftp_open_ex(3) +.BR libssh2_sftp_read(3) diff --git a/docs/libssh2_sftp_readdir_ex.3 b/docs/libssh2_sftp_readdir_ex.3 index 7ab7cee5..bc704e4b 100644 --- a/docs/libssh2_sftp_readdir_ex.3 +++ b/docs/libssh2_sftp_readdir_ex.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_readdir_ex.3,v 1.1 2009/03/16 14:28:37 bagder Exp $ +.\" $Id: libssh2_sftp_readdir_ex.3,v 1.2 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_readdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" .SH NAME @@ -15,7 +15,7 @@ libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_ma .SH DESCRIPTION \fIhandle\fP - is the SFTP File Handle as returned by -.BR libssh2_sftp_diropen(3) +.BR libssh2_sftp_open_ex(3) \fIbuffer\fP - is a pointer to a pre-allocated buffer of at least \fIbuffer_maxlen\fP bytes to read data into. @@ -41,8 +41,8 @@ however, it uses a variable sized directory entry (filename) buffer and returns statbuf type data in the same call. .SH RETURN VALUE -Number of bytes actually populated into buffer, or negative on failure. It returns -LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +Number of bytes actually populated into buffer, or negative on failure. It +returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. .SH ERRORS \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. @@ -54,7 +54,6 @@ LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was received on the socket, or an SFTP operation caused an errorcode to be returned by the server. - .SH SEE ALSO -.BR libssh2_sftp_opendir(3) -.BR libssh2_sftp_closedir(3) +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_close_handle(3) diff --git a/docs/libssh2_sftp_seek.3 b/docs/libssh2_sftp_seek.3 index f371d82a..6dd695e5 100644 --- a/docs/libssh2_sftp_seek.3 +++ b/docs/libssh2_sftp_seek.3 @@ -1,4 +1,4 @@ -.\" $Id: libssh2_sftp_seek.3,v 1.3 2008/12/22 13:18:36 bagder Exp $ +.\" $Id: libssh2_sftp_seek.3,v 1.4 2009/03/16 23:25:14 bagder Exp $ .\" .TH libssh2_sftp_seek 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual" .SH NAME @@ -27,4 +27,4 @@ convenience offset during read/write operations. .SH AVAILABILITY libssh2_sftp_seek64(3) was added in 1.0 .SH SEE ALSO -.BR libssh2_sftp_open(3) +.BR libssh2_sftp_open_ex(3)