6bd584d293
s/1.3.1/1.4.0
...
We're bumping the minor number
2012-01-31 23:22:30 +01:00
511a972a95
session_supported_algs docs: added an example
2012-01-31 23:05:03 +01:00
f4e5ca2f14
libssh2_session_supported_algs: added
2011-10-25 23:50:44 +02:00
6d9d44a550
libssh2_userauth_keyboard_interactive.3: fix man warning
...
It seemed to occur due to the excessive line length
2011-09-12 15:41:28 +02:00
d2dc600be7
libssh2_banner_set.3: fix nroff syntax mistake
2011-09-11 19:25:03 +02:00
7ed53e21fd
libssh2_session_startup(3) => libssh2_session_handshake(3)
...
Propagate for the current function in docs and examples.
libssh2_session_startup() is deprecated.
2011-09-09 23:17:04 +02:00
7229d989e7
libssh2_banner_set => libssh2_session_banner_get
...
Marked the old function as deprecated. Added the new name in the correct
name space with the same arguments and functionality.
2011-09-09 23:11:42 +02:00
f2c21f6f84
new function: libssh2_session_banner_get
...
Returns the banner from the server handshake
Fixes #226
2011-09-09 23:00:05 +02:00
87f79f177f
remove embedded CVS/svn tags
2011-09-09 16:12:04 +02:00
30ac056cb0
API add:libssh2_sftp_get_channel
...
Return the channel of sftp, then caller can
control the channel's behavior.
Signed-off-by: liuzl <xieepp@gmail.com >
2011-09-09 16:00:11 +02:00
7aa4bfc671
Custom callbacks for performing low level socket I/O
2011-08-21 15:19:44 +02:00
95d69d3a81
Document prototypes for macro defined functions
2011-08-16 10:29:07 +02:00
01d199180a
man page cleanups: non-existing functions need no man pages
2011-07-16 00:22:00 +02:00
7e18862eae
libssh2_new_host_entry.3: removed
...
This is just junk leftovers.
2011-07-16 00:17:12 +02:00
dadc05fdfd
keyboard-interactive man page: cleaned up
2011-06-29 20:49:35 +02:00
0723dab4d7
libssh2_channel_process_startup.3: clean up
...
Remove the references to the macro-fied shortcuts as they have their own
individual man pages.
Made the prototype different and more readable.
2011-05-30 09:28:31 +02:00
67ba8713a6
man page: fix .BR lines
...
We don't use \fI etc on .BR lines
2011-05-30 09:26:34 +02:00
6e8229a221
libssh2_channel_forward_accept.3: mention how to get error
...
Since this returns a pointer, libssh2_session_last_errno() must be used
to get the actual error code and it wasn't that clear before.
2011-05-17 19:32:56 +02:00
821fb6ca71
timeout docs: mention they're added in 1.2.9
2011-05-13 22:47:22 +02:00
26dad4590b
timeout: added man pages
2011-05-04 23:26:26 +02:00
c01737e679
libssh2_session_block_directions: fix mistake
...
The last LIBSSH2_SESSION_BLOCK_INBOUND should be
LIBSSH2_SESSION_BLOCK_OUTBOUND
And I shortened the short description
Reported by: "drswinghead"
2011-04-17 12:40:43 +02:00
78498e0588
keepalive: add first basic man pages
...
Someone on IRC pointed out that we don't have these documented so I
wrote up a first set based on the information in the wiki:
http://trac.libssh2.org/wiki/KeepAlive
2011-04-13 00:11:41 +02:00
aa07cdee9a
s/\.NF/.nf/ to fix wrong macro name caught by man --warnings
2011-04-09 16:25:19 +02:00
ec934f6dab
libssh2_knownhost_readfile.3: clarify return value
...
This function returns the number of parsed hosts on success, not just
zero as previously documented.
2011-02-26 10:57:56 +01:00
7015488150
libssh2_sftp_stat_ex.3: cleaned up, extended
...
Removed the macros from it as they have their own man pages.
Added the LIBSSH2_SFTP_ATTRIBUTES struct in here for easier reference.
2011-01-06 00:30:32 +01:00
164838c7dd
sftp_readdir: return error if buffer is too small
...
If asked to read data into a buffer and the buffer is too small to hold
the data, this function now returns an error instead of as previously
just copy as much as fits.
2011-01-04 14:30:04 +01:00
f9b1b95059
sftp_symlink: return error if receive buffer too small
...
and clean up some variable type mismatches
Discussion: http://www.libssh2.org/mail/libssh2-devel-archive-2011-01/0001.shtml
2011-01-04 14:15:57 +01:00
59207291fc
docs: clarify what happens with a too small buffer
...
This flaw is subject to change, but I figured it might be valuable to
users of existing code to know how it works.
2011-01-03 00:07:44 +01:00
20da09932e
libssh2_userauth_list: language fix
...
"faily" is not a good English word, and I also cleaned up some other minor
mistakes
2010-12-20 14:22:07 +01:00
75909e05a9
libssh2_sftp_open_ex: man page extended and cleaned up
...
I added the missing documentation for the 'flags' argument.
2010-12-14 15:06:04 +01:00
6875285b71
libssh2_sftp_seek64: new man page
...
Split off libssh2_sftp_seek64 from the libssh2_sftp_seek man page, and
mentioned that we consider the latter deprecated. Also added a mention
about the dangers of doing seek during writing or reading.
2010-12-11 00:03:42 +01:00
f4ad3e0120
LIBSSH2_CALLBACK_MACERROR: clarify return code use
2010-11-10 14:41:56 +01:00
610a8ab919
libssh2_userauth_publickey_fromfile_ex.3: cleaned up looks
2010-10-25 23:44:39 +02:00
8ec21e0afe
libssh2_userauth_publickey: add man page
...
I found an undocumented public function and we can't have it like
that. The description here is incomplete, but should serve as a template
to allow filling in...
2010-10-25 23:18:50 +02:00
8e0983347b
libssh2_sftp_write.3: added blurb about the "write ahead"
...
Documented the new SFTP write concept
2010-10-25 16:38:37 +02:00
3a391f6cf2
compress: compression disabled by default
...
We now allow libssh2_session_flag() to enable compression with a new
flag and I added documentation for the previous LIBSSH2_FLAG_SIGPIPE
flag which I wasn't really aware of!
2010-10-22 13:37:13 +02:00
4d15e0c9d1
Add libssh2_channel_get_exit_signal man page.
...
Signed-off-by: Simon Josefsson <simon@josefsson.org >
2010-10-13 15:31:53 +02:00
6140ec2de3
Add libssh2_channel_get_exit_signal.
...
Signed-off-by: Simon Josefsson <simon@josefsson.org >
2010-10-13 15:31:06 +02:00
70d6bd6c6f
Add libssh2_free man page and fix typo.
2010-10-13 15:24:18 +02:00
c36f379b88
libssh2_session_methods.3: detail what can be asked for
2010-10-10 23:51:22 +02:00
0d58af6aec
libssh2_session_handshake: replaces libssh2_session_startup()
...
The function libssh2_session_startup() is now considered deprecated due
to the portability issue with the socket argument.
libssh2_session_handshake() is the name of the replacement.
2010-10-07 19:56:12 +02:00
eec7f2fb63
Document the three sftp stat constants
2010-08-25 17:10:06 -07:00
537a00ee4b
libssh2_session_callback_set: extended the man page
2010-06-16 00:12:24 +02:00
897f8463d8
sftp docs: show macro on macro page, only function on function page
...
The individual man pages for macros now show the full convenience
macro as defined, and then the man page for the actual function
only shows the function.
2010-06-14 20:04:29 +02:00
20e969d2e0
libssh2_channel_write_ex: remove macros, added wording on buffer size
2010-06-13 17:00:43 +02:00
33e2bc8785
libssh2_sftp_write: document buffer size and changed some ordering
2010-06-13 17:00:14 +02:00
d7e6f9cf27
libssh2_channel_write_stderr: show how the macro is defined
2010-06-13 16:59:40 +02:00
be7cee1b3e
libssh2_channel_write: show how the macro is defined
2010-06-13 16:59:18 +02:00
cce6ebbee7
libssh2_channel_eof: clarify that it returns negative on errors
2010-06-11 13:02:00 +02:00
0ad1a52a09
libssh2_poll: refer to poll(3) and select(3) instead
2010-06-08 08:37:37 +02:00
