diff --git a/docs/Makefile.am b/docs/Makefile.am index 10af2dfd..515e1b69 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.16 2007/06/13 23:02:08 jehousley Exp $ +# $Id: Makefile.am,v 1.17 2007/06/14 14:56:32 jehousley Exp $ EXTRA_DIST = template.3 @@ -23,6 +23,9 @@ dist_man_MANS = libssh2_channel_setenv_ex.3 \ libssh2_channel_wait_eof.3 \ libssh2_channel_x11_req_ex.3 \ + libssh2_hostkey_hash.3 \ + libssh2_scp_recv.3 \ + libssh2_scp_send_ex.3 \ libssh2_session_free.3 \ libssh2_session_disconnect_ex.3 \ libssh2_session_init.3 \ diff --git a/docs/libssh2_hostkey_hash.3 b/docs/libssh2_hostkey_hash.3 new file mode 100644 index 00000000..0345d280 --- /dev/null +++ b/docs/libssh2_hostkey_hash.3 @@ -0,0 +1,29 @@ +.\" $Id: libssh2_hostkey_hash.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $ +.\" +.TH libssh2_hostkey_hash 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_hostkey_hash - return a hash of the remote host's key +.SH SYNOPSIS +#include + +const char * +libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init(3) + +\fIhash_type\fP - One of: \fBLIBSSH2_HOSTKEY_HASH_MD5\fP or +\fBLIBSSH2_HOSTKEY_HASH_SHA1\fP. + +Returns the computed digest of the remote system's hostkey. The length of +the returned string is hash_type specific (e.g. 16 bytes for MD5, +20 bytes for SHA1). + +.SH RETURN VALUE +Computed hostkey hash value. or NULL if the session has not yet been started +up. (The hash consists of raw binary bytes, not hex digits, so is not +directly printable.) + +.SH SEE ALSO +.BR libssh2_session_init(3) diff --git a/docs/libssh2_scp_recv.3 b/docs/libssh2_scp_recv.3 new file mode 100644 index 00000000..99f8cad0 --- /dev/null +++ b/docs/libssh2_scp_recv.3 @@ -0,0 +1,40 @@ +.\" $Id: libssh2_scp_recv.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $ +.\" +.TH libssh2_scp_recv 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_scp_recv - request a remote file via SCP +.SH SYNOPSIS +#include + +LIBSSH2_CHANNEL * +libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init(3) + +\fIpath\fP - Full path and filename of file to transfer + +\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. + +.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. + +.SH SEE ALSO +.BR libssh2_session_init(3) +.BR libssh2_channel_open_session(3) +.BR libssh2_channel_exec(3) diff --git a/docs/libssh2_scp_send_ex.3 b/docs/libssh2_scp_send_ex.3 new file mode 100644 index 00000000..1b128938 --- /dev/null +++ b/docs/libssh2_scp_send_ex.3 @@ -0,0 +1,52 @@ +.\" $Id: libssh2_scp_send_ex.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $ +.\" +.TH libssh2_scp_send_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_scp_send_ex - Send a file via SCP +.SH SYNOPSIS +#include + +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) + +\fIpath\fP - Full path and filename of file to transfer + +\fImode\fP - File access mode to create file with + +\fIsize\fP - Size of file being transmitted (Must be known +ahead of time precisely) + +\fImtime\fP - mtime to assign to file being created + +\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. + +.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_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SCP_PROTOCOL\fP - + +\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)