5ffc595d0d
Summary: * Note that SSH_ERROR can be returned on error in `ssh_channel_get_exit_status` and `ssh_channel_get_session`. * Note the return codes for `channel_open` and `grow_window`; although these are internal APIs, it's best to document their behavior. * Replace `@returns` use with `@return`. While Doxygen supports the former as a synonym for `@return`, it isn't documented in the manual (and might not be supported by other downstream documentation tools). Signed-off-by: Enji Cooper <yaneurabeya@gmail.com> Reviewed-by: Andreas Schneider <asn@cryptomilk.org> Reviewed-by: Jakub Jelen <jjelen@redhat.com> Test Plan: n/a Reviewers: #libssh, asn Differential Revision: https://bugs.libssh.org/D15
_ _ _ _
(_) (_) (_) (_)
(_) _ (_) _ _ _ _ _ (_) _
(_) (_) (_)(_) _ (_)(_) (_)(_) (_)(_) _
(_) (_) (_) (_) _ (_) _ (_) (_) (_)
(_) (_) (_)(_)(_) (_)(_) (_)(_) (_) (_).org
The SSH library
Why?
Why not ? :) I've began to work on my own implementation of the ssh protocol because i didn't like the currently public ones. Not any allowed you to import and use the functions as a powerful library, and so i worked on a library-based SSH implementation which was non-existing in the free and open source software world.
How/Who?
If you downloaded this file, you must know what it is : a library for accessing ssh client services through C libraries calls in a simple manner. Everybody can use this software under the terms of the LGPL - see the COPYING file
If you ask yourself how to compile libssh, please read INSTALL before anything.
Where ?
Contributing
Please read the file 'SubmittingPatches' next to this README file. It explains our copyright policy and how you should send patches for upstream inclusion.
Have fun and happy libssh hacking!
The libssh Team