1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-31 00:03:08 +03:00

wrote up a first libssh2_base64_decode man page, added a few missing man

pages to the tarball
This commit is contained in:
Daniel Stenberg
2008-12-23 13:23:45 +00:00
parent 11330ee6da
commit 6b38e21fa7
2 changed files with 29 additions and 2 deletions

View File

@ -1,4 +1,4 @@
# $Id: Makefile.am,v 1.29 2008/11/24 13:31:00 bagder Exp $
# $Id: Makefile.am,v 1.30 2008/12/23 13:23:45 bagder Exp $
EXTRA_DIST = template.3
@ -24,6 +24,7 @@ dist_man_MANS = \
libssh2_channel_setenv_ex.3 \
libssh2_channel_wait_eof.3 \
libssh2_channel_wait_closed.3 \
libssh2_channel_write_ex.3 \
libssh2_channel_x11_req_ex.3 \
libssh2_hostkey_hash.3 \
libssh2_scp_recv.3 \
@ -57,10 +58,12 @@ dist_man_MANS = \
libssh2_sftp_stat_ex.3 \
libssh2_sftp_symlink_ex.3 \
libssh2_sftp_tell.3 \
libssh2_sftp_tell64.3 \
libssh2_sftp_unlink_ex.3 \
libssh2_sftp_write.3 \
libssh2_userauth_authenticated.3 \
libssh2_userauth_keyboard_interactive_ex.3 \
libssh2_userauth_list.3 \
libssh2_userauth_password_ex.3 \
libssh2_userauth_publickey_fromfile.3
libssh2_userauth_publickey_fromfile.3 \
libssh2_base64_decode.3

View File

@ -0,0 +1,24 @@
.\" $Id: libssh2_base64_decode.3,v 1.1 2008/12/23 13:23:45 bagder Exp $
.\"
.TH libssh2_base64_decode 3 "23 Dec 2008" "libssh2 1.0" "libssh2 manual"
.SH NAME
libssh2_base64_decode - decode a base64 encoded string
.SH SYNOPSIS
#include <libssh2.h>
int libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest,
unsigned int *dest_len, const char *src,
unsigned int src_len);
.SH DESCRIPTION
Decode a base64 chunk and store it into a newly allocated buffer. 'dest_len'
will be set to hold the length of the returned buffer that '*dest' will point
to.
NOTE: the returned buffer is allocated by this function, but it is not clear
how that memory is freed!
.SH BUGS
The memory that *dest points to is allocated by the malloc function libssh2
uses, but there's no way for an appliction to free this data in a safe and
reliable way!
.SH RETURN VALUE
0 if successful, -1 if any error occurred.