diff options
Diffstat (limited to 'libssh2-sys/libssh2-1.5.0/docs')
174 files changed, 6352 insertions, 0 deletions
diff --git a/libssh2-sys/libssh2-1.5.0/docs/AUTHORS b/libssh2-sys/libssh2-1.5.0/docs/AUTHORS new file mode 100644 index 0000000..5c7445b --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/AUTHORS @@ -0,0 +1,79 @@ + libssh2 is the result of many friendly people. This list is an attempt to + mention all contributors. If we've missed anyone, tell us! + + This list of names is a-z sorted. + +Adam Gobiowski +Alexander Holyapin +Alexander Lamaison +Alfred Gebert +Ben Kibbey +Bjorn Stenborg +Carlo Bramini +Cristian RodrÃguez +Daiki Ueno +Dan Casey +Dan Fandrich +Daniel Stenberg +Dave Hayden +Dave McCaldon +David J Sullivan +David Robins +Dmitry Smirnov +Douglas Masterson +Edink Kadribasic +Erik Brossler +Francois Dupoux +Gellule Xg +Grubsky Grigory +Guenter Knauf +Heiner Steven +Henrik Nordstrom +James Housleys +Jasmeet Bagga +Jean-Louis Charton +Jernej Kovacic +Joey Degges +John Little +Jose Baars +Jussi Mononen +Kamil Dudka +Lars Nordin +Mark McPherson +Mark Smith +Markus Moeller +Matt Lilley +Matthew Booth +Maxime Larocque +Mike Protts +Mikhail Gusarov +Neil Gierman +Olivier Hervieu +Paul Howarth +Paul Querna +Paul Veldkamp +Peter Krempa +Peter O'Gorman +Peter Stuge +Pierre Joye +Rafael Kitover +Romain Bondue +Sara Golemon +Satish Mittal +Sean Peterson +Selcuk Gueney +Simon Hart +Simon Josefsson +Sofian Brabez +Steven Ayre +Steven Dake +Steven Van Ingelgem +TJ Saunders +Tommy Lindgren +Tor Arntsen +Vincent Jaulin +Vincent Torri +Vlad Grachov +Wez Furlong +Yang Tse +Zl Liu diff --git a/libssh2-sys/libssh2-1.5.0/docs/BINDINGS b/libssh2-sys/libssh2-1.5.0/docs/BINDINGS new file mode 100644 index 0000000..b97758f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/BINDINGS @@ -0,0 +1,29 @@ + +Creative people have written bindings or interfaces for various environments +and programming languages. Using one of these bindings allows you to take +advantage of libssh2 directly from within your favourite language. + +The bindings listed below are not part of the libssh2 distribution archives, +but must be downloaded and installed separately. + +Cocoa/Objective-C + https://github.com/karelia/libssh2_sftp-Cocoa-wrapper + +Haskell + FFI bindings - http://hackage.haskell.org/package/libssh2 + +Perl + Net::SSH2 - http://search.cpan.org/~rkitover/Net-SSH2-0.45/lib/Net/SSH2.pm + +PHP + ssh2 - http://pecl.php.net/package/ssh2 + +Python + pylibssh2 - http://www.wallix.org/pylibssh2-project/ + +Python-ctypes + + PySsh2 - https://github.com/gellule/PySsh2 + +Ruby + libssh2-ruby - https://github.com/mitchellh/libssh2-ruby diff --git a/libssh2-sys/libssh2-1.5.0/docs/HACKING b/libssh2-sys/libssh2-1.5.0/docs/HACKING new file mode 100644 index 0000000..5da8e66 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/HACKING @@ -0,0 +1,13 @@ + +libssh2 source code style guide: + + - 4 level indent + - spaces-only (no tabs) + - open braces on the if/for line: + + if (banana) { + go_nuts(); + } + + - keep source lines shorter than 80 columns + - See libssh2-style.el for how to achieve this within Emacs diff --git a/libssh2-sys/libssh2-1.5.0/docs/INSTALL b/libssh2-sys/libssh2-1.5.0/docs/INSTALL new file mode 100644 index 0000000..bc5a0eb --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/INSTALL @@ -0,0 +1,325 @@ +Installation Instructions +************************* + +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free +Software Foundation, Inc. + +This file is free documentation; the Free Software Foundation gives +unlimited permission to copy, distribute and modify it. + +Basic Installation +================== + +These are generic installation instructions. + + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory of the package. +It may also create one or more `.h' files containing system-dependent +definitions. Finally, it creates a shell script `config.status' that +you can run in the future to recreate the current configuration, and a +file `config.log' containing compiler output (useful mainly for +debugging `configure'). + + It can also use an optional file (typically called `config.cache' +and enabled with `--cache-file=config.cache' or simply `-C') that saves +the results of its tests to speed up reconfiguring. (Caching is +disabled by default to prevent problems with accidental use of stale +cache files.) + + If you need to do unusual things to compile the package, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to the address given in the `README' so they can +be considered for the next release. If you are using the cache, and at +some point `config.cache' contains results you don't want to keep, you +may remove or edit it. + + The file `configure.ac' (or `configure.in') is used to create +`configure' by a program called `autoconf'. You only need +`configure.ac' if you want to change it or regenerate `configure' using +a newer version of `autoconf'. + +The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. If you're + using `csh' on an old version of System V, you might need to type + `sh ./configure' instead to prevent `csh' from trying to execute + `configure' itself. + + Running `configure' takes awhile. While running, it prints some + messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Optionally, type `make check' to run any self-tests that come with + the package. + + 4. Type `make install' to install the programs and any data files and + documentation. + + 5. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the package's developers. If you use it, you may have to get + all sorts of other programs in order to regenerate files that came + with the distribution. + +Compilers and Options +===================== + +Some systems require unusual options for compilation or linking that the +`configure' script does not know about. Run `./configure --help' for +details on some of the pertinent environment variables. + + You can give `configure' initial values for configuration parameters +by setting variables in the command line or in the environment. Here +is an example: + + ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix + + *Note Defining Variables::, for more details. + +Compiling For Multiple Architectures +==================================== + +You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you must use a version of `make' that +supports the `VPATH' variable, such as GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. + + If you have to use a `make' that does not support the `VPATH' +variable, you have to compile the package for one architecture at a +time in the source code directory. After you have installed the +package for one architecture, use `make distclean' before reconfiguring +for another architecture. + +Installation Names +================== + +By default, `make install' installs the package's commands under +`/usr/local/bin', include files under `/usr/local/include', etc. You +can specify an installation prefix other than `/usr/local' by giving +`configure' the option `--prefix=PREFIX'. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +pass the option `--exec-prefix=PREFIX' to `configure', the package uses +PREFIX as the prefix for installing programs and libraries. +Documentation and other data files still use the regular prefix. + + In addition, if you use an unusual directory layout you can give +options like `--bindir=DIR' to specify different values for particular +kinds of files. Run `configure --help' for a list of the directories +you can set and what kinds of files go in them. + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure' the +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. + +Optional Features +================= + +Some packages pay attention to `--enable-FEATURE' options to +`configure', where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE' options, where PACKAGE +is something like `gnu-as' or `x' (for the X Window System). The +`README' should mention any `--enable-' and `--with-' options that the +package recognizes. + + For packages that use the X Window System, `configure' can usually +find the X include and library files automatically, but if it doesn't, +you can use the `configure' options `--x-includes=DIR' and +`--x-libraries=DIR' to specify their locations. + +Specifying the System Type +========================== + +There may be some features `configure' cannot figure out automatically, +but needs to determine by the type of machine the package will run on. +Usually, assuming the package is built to be run on the _same_ +architectures, `configure' can figure that out, but if it prints a +message saying it cannot guess the machine type, give it the +`--build=TYPE' option. TYPE can either be a short name for the system +type, such as `sun4', or a canonical name which has the form: + + CPU-COMPANY-SYSTEM + +where SYSTEM can have one of these forms: + + OS KERNEL-OS + + See the file `config.sub' for the possible values of each field. If +`config.sub' isn't included in this package, then this package doesn't +need to know the machine type. + + If you are _building_ compiler tools for cross-compiling, you should +use the option `--target=TYPE' to select the type of system they will +produce code for. + + If you want to _use_ a cross compiler, that generates code for a +platform different from the build platform, you should specify the +"host" platform (i.e., that on which the generated programs will +eventually be run) with `--host=TYPE'. + +Sharing Defaults +================ + +If you want to set default values for `configure' scripts to share, you +can create a site shell script called `config.site' that gives default +values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: not all `configure' scripts look for a site script. + +Defining Variables +================== + +Variables not defined in a site shell script can be set in the +environment passed to `configure'. However, some packages may run +configure again during the build, and the customized values of these +variables may be lost. In order to avoid this problem, you should set +them in the `configure' command line, using `VAR=value'. For example: + + ./configure CC=/usr/local2/bin/gcc + +causes the specified `gcc' to be used as the C compiler (unless it is +overridden in the site shell script). Here is a another example: + + /bin/bash ./configure CONFIG_SHELL=/bin/bash + +Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent +configuration-related scripts to be executed by `/bin/bash'. + +`configure' Invocation +====================== + +`configure' recognizes the following options to control how it operates. + +`--help' +`-h' + Print a summary of the options to `configure', and exit. + +`--version' +`-V' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`--cache-file=FILE' + Enable the cache: use and save the results of the tests in FILE, + traditionally `config.cache'. FILE defaults to `/dev/null' to + disable caching. + +`--config-cache' +`-C' + Alias for `--cache-file=config.cache'. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. To + suppress all normal output, redirect it to `/dev/null' (any error + messages will still be shown). + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`configure' also accepts some other, not widely useful, options. Run +`configure --help' for more details. + +More configure options +====================== + +Some ./configure options deserve additional comments: + + * --enable-crypt-none + + The SSH2 Transport allows for unencrypted data + transmission using the "none" cipher. Because this is + such a huge security hole, it is typically disabled on + SSH2 implementations and is disabled in libssh2 by + default as well. + + Enabling this option will allow for "none" as a + negotiable method, however it still requires that the + method be advertized by the remote end and that no + more-preferable methods are available. + + * --enable-mac-none + + The SSH2 Transport also allows implementations to + forego a message authentication code. While this is + less of a security risk than using a "none" cipher, it + is still not recommended as disabling MAC hashes + removes a layer of security. + + Enabling this option will allow for "none" as a + negotiable method, however it still requires that the + method be advertized by the remote end and that no + more-preferable methods are available. + + * --disable-gex-new + + The diffie-hellman-group-exchange-sha1 (dh-gex) key + exchange method originally defined an exchange + negotiation using packet type 30 to request a + generation pair based on a single target value. Later + refinement of dh-gex provided for range and target + values. By default libssh2 will use the newer range + method. + + If you experience trouble connecting to an old SSH + server using dh-gex, try this option to fallback on + the older more reliable method. + + * --with-libgcrypt + * --without-libgcrypt + * --with-libgcrypt-prefix=DIR + + libssh2 can use the Libgcrypt library + (http://www.gnupg.org/) for cryptographic operations. + Either Libgcrypt or OpenSSL is required. + + Configure will attempt to locate Libgcrypt + automatically. + + If your installation of Libgcrypt is in another + location, specify it using --with-libgcrypt-prefix. + + * --with-openssl + * --without-openssl + * --with-libssl-prefix=[DIR] + + libssh2 can use the OpenSSL library + (http://www.openssl.org) for cryptographic operations. + Either Libgcrypt or OpenSSL is required. + + Configure will attempt to locate OpenSSL in the + default location. + + If your installation of OpenSSL is in another + location, specify it using --with-libssl-prefix. + + * --with-libz + * --without-libz + * --with-libz-prefix=[DIR] + + If present, libssh2 will attempt to use the zlib + (http://www.zlib.org) for payload compression, however + zlib is not required. + + If your installation of Libz is in another location, + specify it using --with-libz-prefix. + + * --enable-debug + + Will make the build use more pedantic and strict compiler + options as well as enable the libssh2_trace() function (for + showing debug traces). diff --git a/libssh2-sys/libssh2-1.5.0/docs/Makefile.am b/libssh2-sys/libssh2-1.5.0/docs/Makefile.am new file mode 100644 index 0000000..8ad8eb5 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/Makefile.am @@ -0,0 +1,171 @@ +# $Id: Makefile.am,v 1.37 2009/03/26 15:41:15 bagder Exp $ + +EXTRA_DIST = template.3 BINDINGS INSTALL HACKING TODO AUTHORS + +dist_man_MANS = \ + libssh2_agent_connect.3 \ + libssh2_agent_disconnect.3 \ + libssh2_agent_free.3 \ + libssh2_agent_get_identity.3 \ + libssh2_agent_init.3 \ + libssh2_agent_list_identities.3 \ + libssh2_agent_userauth.3 \ + libssh2_banner_set.3 \ + libssh2_base64_decode.3 \ + libssh2_channel_close.3 \ + libssh2_channel_direct_tcpip.3 \ + libssh2_channel_direct_tcpip_ex.3 \ + libssh2_channel_eof.3 \ + libssh2_channel_exec.3 \ + libssh2_channel_flush.3 \ + libssh2_channel_flush_ex.3 \ + libssh2_channel_flush_stderr.3 \ + libssh2_channel_forward_accept.3 \ + libssh2_channel_forward_cancel.3 \ + libssh2_channel_forward_listen.3 \ + libssh2_channel_forward_listen_ex.3 \ + libssh2_channel_free.3 \ + libssh2_channel_get_exit_signal.3 \ + libssh2_channel_get_exit_status.3 \ + libssh2_channel_handle_extended_data.3 \ + libssh2_channel_handle_extended_data2.3 \ + libssh2_channel_ignore_extended_data.3 \ + libssh2_channel_open_ex.3 \ + libssh2_channel_open_session.3 \ + libssh2_channel_process_startup.3 \ + libssh2_channel_read.3 \ + libssh2_channel_read_ex.3 \ + libssh2_channel_read_stderr.3 \ + libssh2_channel_receive_window_adjust.3 \ + libssh2_channel_receive_window_adjust2.3 \ + libssh2_channel_request_pty.3 \ + libssh2_channel_request_pty_ex.3 \ + libssh2_channel_request_pty_size.3 \ + libssh2_channel_request_pty_size_ex.3 \ + libssh2_channel_send_eof.3 \ + libssh2_channel_set_blocking.3 \ + libssh2_channel_setenv.3 \ + libssh2_channel_setenv_ex.3 \ + libssh2_channel_shell.3 \ + libssh2_channel_subsystem.3 \ + libssh2_channel_wait_closed.3 \ + libssh2_channel_wait_eof.3 \ + libssh2_channel_window_read.3 \ + libssh2_channel_window_read_ex.3 \ + libssh2_channel_window_write.3 \ + libssh2_channel_window_write_ex.3 \ + libssh2_channel_write.3 \ + libssh2_channel_write_ex.3 \ + libssh2_channel_write_stderr.3 \ + libssh2_channel_x11_req.3 \ + libssh2_channel_x11_req_ex.3 \ + libssh2_exit.3 \ + libssh2_free.3 \ + libssh2_hostkey_hash.3 \ + libssh2_init.3 \ + libssh2_keepalive_config.3 \ + libssh2_keepalive_send.3 \ + libssh2_knownhost_add.3 \ + libssh2_knownhost_addc.3 \ + libssh2_knownhost_check.3 \ + libssh2_knownhost_checkp.3 \ + libssh2_knownhost_del.3 \ + libssh2_knownhost_free.3 \ + libssh2_knownhost_get.3 \ + libssh2_knownhost_init.3 \ + libssh2_knownhost_readfile.3 \ + libssh2_knownhost_readline.3 \ + libssh2_knownhost_writefile.3 \ + libssh2_knownhost_writeline.3 \ + libssh2_poll.3 \ + libssh2_poll_channel_read.3 \ + libssh2_publickey_add.3 \ + libssh2_publickey_add_ex.3 \ + libssh2_publickey_init.3 \ + libssh2_publickey_list_fetch.3 \ + libssh2_publickey_list_free.3 \ + libssh2_publickey_remove.3 \ + libssh2_publickey_remove_ex.3 \ + libssh2_publickey_shutdown.3 \ + libssh2_scp_recv.3 \ + libssh2_scp_send.3 \ + libssh2_scp_send64.3 \ + libssh2_scp_send_ex.3 \ + libssh2_session_abstract.3 \ + libssh2_session_banner_get.3 \ + libssh2_session_banner_set.3 \ + libssh2_session_block_directions.3 \ + libssh2_session_callback_set.3 \ + libssh2_session_disconnect.3 \ + libssh2_session_disconnect_ex.3 \ + libssh2_session_flag.3 \ + libssh2_session_free.3 \ + libssh2_session_get_blocking.3 \ + libssh2_session_get_timeout.3 \ + libssh2_session_handshake.3 \ + libssh2_session_hostkey.3 \ + libssh2_session_init.3 \ + libssh2_session_init_ex.3 \ + libssh2_session_last_errno.3 \ + libssh2_session_last_error.3 \ + libssh2_session_method_pref.3 \ + libssh2_session_methods.3 \ + libssh2_session_set_blocking.3 \ + libssh2_session_set_timeout.3 \ + libssh2_session_startup.3 \ + libssh2_session_supported_algs.3 \ + libssh2_sftp_close.3 \ + libssh2_sftp_close_handle.3 \ + libssh2_sftp_closedir.3 \ + libssh2_sftp_fsetstat.3 \ + libssh2_sftp_fstat.3 \ + libssh2_sftp_fstat_ex.3 \ + libssh2_sftp_fstatvfs.3 \ + libssh2_sftp_fsync.3 \ + libssh2_sftp_get_channel.3 \ + libssh2_sftp_init.3 \ + libssh2_sftp_last_error.3 \ + libssh2_sftp_lstat.3 \ + libssh2_sftp_mkdir.3 \ + libssh2_sftp_mkdir_ex.3 \ + libssh2_sftp_open.3 \ + libssh2_sftp_open_ex.3 \ + libssh2_sftp_opendir.3 \ + libssh2_sftp_read.3 \ + libssh2_sftp_readdir.3 \ + libssh2_sftp_readdir_ex.3 \ + libssh2_sftp_readlink.3 \ + libssh2_sftp_realpath.3 \ + libssh2_sftp_rename.3 \ + libssh2_sftp_rename_ex.3 \ + libssh2_sftp_rewind.3 \ + libssh2_sftp_rmdir.3 \ + libssh2_sftp_rmdir_ex.3 \ + libssh2_sftp_seek.3 \ + libssh2_sftp_seek64.3 \ + libssh2_sftp_setstat.3 \ + libssh2_sftp_shutdown.3 \ + libssh2_sftp_stat.3 \ + libssh2_sftp_stat_ex.3 \ + libssh2_sftp_statvfs.3 \ + libssh2_sftp_symlink.3 \ + libssh2_sftp_symlink_ex.3 \ + libssh2_sftp_tell.3 \ + libssh2_sftp_tell64.3 \ + libssh2_sftp_unlink.3 \ + libssh2_sftp_unlink_ex.3 \ + libssh2_sftp_write.3 \ + libssh2_trace.3 \ + libssh2_trace_sethandler.3 \ + libssh2_userauth_authenticated.3 \ + libssh2_userauth_hostbased_fromfile.3 \ + libssh2_userauth_hostbased_fromfile_ex.3 \ + libssh2_userauth_keyboard_interactive.3 \ + libssh2_userauth_keyboard_interactive_ex.3 \ + libssh2_userauth_list.3 \ + libssh2_userauth_password.3 \ + libssh2_userauth_password_ex.3 \ + libssh2_userauth_publickey.3 \ + libssh2_userauth_publickey_fromfile.3 \ + libssh2_userauth_publickey_fromfile_ex.3 \ + libssh2_version.3 diff --git a/libssh2-sys/libssh2-1.5.0/docs/Makefile.in b/libssh2-sys/libssh2-1.5.0/docs/Makefile.in new file mode 100644 index 0000000..fc04499 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/Makefile.in @@ -0,0 +1,702 @@ +# Makefile.in generated by automake 1.14.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2013 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# $Id: Makefile.am,v 1.37 2009/03/26 15:41:15 bagder Exp $ +VPATH = @srcdir@ +am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)' +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = docs +DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \ + $(dist_man_MANS) AUTHORS INSTALL TODO +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/autobuild.m4 \ + $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \ + $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/acinclude.m4 $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/src/libssh2_config.h \ + $(top_builddir)/example/libssh2_config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } +man3dir = $(mandir)/man3 +am__installdirs = "$(DESTDIR)$(man3dir)" +NROFF = nroff +MANS = $(dist_man_MANS) +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ALLOCA = @ALLOCA@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AS = @AS@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GREP = @GREP@ +HAVE_LIBBCRYPT = @HAVE_LIBBCRYPT@ +HAVE_LIBCRYPT32 = @HAVE_LIBCRYPT32@ +HAVE_LIBGCRYPT = @HAVE_LIBGCRYPT@ +HAVE_LIBSSL = @HAVE_LIBSSL@ +HAVE_LIBZ = @HAVE_LIBZ@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBBCRYPT = @LIBBCRYPT@ +LIBBCRYPT_PREFIX = @LIBBCRYPT_PREFIX@ +LIBCRYPT32 = @LIBCRYPT32@ +LIBCRYPT32_PREFIX = @LIBCRYPT32_PREFIX@ +LIBGCRYPT = @LIBGCRYPT@ +LIBGCRYPT_PREFIX = @LIBGCRYPT_PREFIX@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBSREQUIRED = @LIBSREQUIRED@ +LIBSSH2VER = @LIBSSH2VER@ +LIBSSL = @LIBSSL@ +LIBSSL_PREFIX = @LIBSSL_PREFIX@ +LIBTOOL = @LIBTOOL@ +LIBZ = @LIBZ@ +LIBZ_PREFIX = @LIBZ_PREFIX@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBBCRYPT = @LTLIBBCRYPT@ +LTLIBCRYPT32 = @LTLIBCRYPT32@ +LTLIBGCRYPT = @LTLIBGCRYPT@ +LTLIBOBJS = @LTLIBOBJS@ +LTLIBSSL = @LTLIBSSL@ +LTLIBZ = @LTLIBZ@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +SSHD = @SSHD@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +EXTRA_DIST = template.3 BINDINGS INSTALL HACKING TODO AUTHORS +dist_man_MANS = \ + libssh2_agent_connect.3 \ + libssh2_agent_disconnect.3 \ + libssh2_agent_free.3 \ + libssh2_agent_get_identity.3 \ + libssh2_agent_init.3 \ + libssh2_agent_list_identities.3 \ + libssh2_agent_userauth.3 \ + libssh2_banner_set.3 \ + libssh2_base64_decode.3 \ + libssh2_channel_close.3 \ + libssh2_channel_direct_tcpip.3 \ + libssh2_channel_direct_tcpip_ex.3 \ + libssh2_channel_eof.3 \ + libssh2_channel_exec.3 \ + libssh2_channel_flush.3 \ + libssh2_channel_flush_ex.3 \ + libssh2_channel_flush_stderr.3 \ + libssh2_channel_forward_accept.3 \ + libssh2_channel_forward_cancel.3 \ + libssh2_channel_forward_listen.3 \ + libssh2_channel_forward_listen_ex.3 \ + libssh2_channel_free.3 \ + libssh2_channel_get_exit_signal.3 \ + libssh2_channel_get_exit_status.3 \ + libssh2_channel_handle_extended_data.3 \ + libssh2_channel_handle_extended_data2.3 \ + libssh2_channel_ignore_extended_data.3 \ + libssh2_channel_open_ex.3 \ + libssh2_channel_open_session.3 \ + libssh2_channel_process_startup.3 \ + libssh2_channel_read.3 \ + libssh2_channel_read_ex.3 \ + libssh2_channel_read_stderr.3 \ + libssh2_channel_receive_window_adjust.3 \ + libssh2_channel_receive_window_adjust2.3 \ + libssh2_channel_request_pty.3 \ + libssh2_channel_request_pty_ex.3 \ + libssh2_channel_request_pty_size.3 \ + libssh2_channel_request_pty_size_ex.3 \ + libssh2_channel_send_eof.3 \ + libssh2_channel_set_blocking.3 \ + libssh2_channel_setenv.3 \ + libssh2_channel_setenv_ex.3 \ + libssh2_channel_shell.3 \ + libssh2_channel_subsystem.3 \ + libssh2_channel_wait_closed.3 \ + libssh2_channel_wait_eof.3 \ + libssh2_channel_window_read.3 \ + libssh2_channel_window_read_ex.3 \ + libssh2_channel_window_write.3 \ + libssh2_channel_window_write_ex.3 \ + libssh2_channel_write.3 \ + libssh2_channel_write_ex.3 \ + libssh2_channel_write_stderr.3 \ + libssh2_channel_x11_req.3 \ + libssh2_channel_x11_req_ex.3 \ + libssh2_exit.3 \ + libssh2_free.3 \ + libssh2_hostkey_hash.3 \ + libssh2_init.3 \ + libssh2_keepalive_config.3 \ + libssh2_keepalive_send.3 \ + libssh2_knownhost_add.3 \ + libssh2_knownhost_addc.3 \ + libssh2_knownhost_check.3 \ + libssh2_knownhost_checkp.3 \ + libssh2_knownhost_del.3 \ + libssh2_knownhost_free.3 \ + libssh2_knownhost_get.3 \ + libssh2_knownhost_init.3 \ + libssh2_knownhost_readfile.3 \ + libssh2_knownhost_readline.3 \ + libssh2_knownhost_writefile.3 \ + libssh2_knownhost_writeline.3 \ + libssh2_poll.3 \ + libssh2_poll_channel_read.3 \ + libssh2_publickey_add.3 \ + libssh2_publickey_add_ex.3 \ + libssh2_publickey_init.3 \ + libssh2_publickey_list_fetch.3 \ + libssh2_publickey_list_free.3 \ + libssh2_publickey_remove.3 \ + libssh2_publickey_remove_ex.3 \ + libssh2_publickey_shutdown.3 \ + libssh2_scp_recv.3 \ + libssh2_scp_send.3 \ + libssh2_scp_send64.3 \ + libssh2_scp_send_ex.3 \ + libssh2_session_abstract.3 \ + libssh2_session_banner_get.3 \ + libssh2_session_banner_set.3 \ + libssh2_session_block_directions.3 \ + libssh2_session_callback_set.3 \ + libssh2_session_disconnect.3 \ + libssh2_session_disconnect_ex.3 \ + libssh2_session_flag.3 \ + libssh2_session_free.3 \ + libssh2_session_get_blocking.3 \ + libssh2_session_get_timeout.3 \ + libssh2_session_handshake.3 \ + libssh2_session_hostkey.3 \ + libssh2_session_init.3 \ + libssh2_session_init_ex.3 \ + libssh2_session_last_errno.3 \ + libssh2_session_last_error.3 \ + libssh2_session_method_pref.3 \ + libssh2_session_methods.3 \ + libssh2_session_set_blocking.3 \ + libssh2_session_set_timeout.3 \ + libssh2_session_startup.3 \ + libssh2_session_supported_algs.3 \ + libssh2_sftp_close.3 \ + libssh2_sftp_close_handle.3 \ + libssh2_sftp_closedir.3 \ + libssh2_sftp_fsetstat.3 \ + libssh2_sftp_fstat.3 \ + libssh2_sftp_fstat_ex.3 \ + libssh2_sftp_fstatvfs.3 \ + libssh2_sftp_fsync.3 \ + libssh2_sftp_get_channel.3 \ + libssh2_sftp_init.3 \ + libssh2_sftp_last_error.3 \ + libssh2_sftp_lstat.3 \ + libssh2_sftp_mkdir.3 \ + libssh2_sftp_mkdir_ex.3 \ + libssh2_sftp_open.3 \ + libssh2_sftp_open_ex.3 \ + libssh2_sftp_opendir.3 \ + libssh2_sftp_read.3 \ + libssh2_sftp_readdir.3 \ + libssh2_sftp_readdir_ex.3 \ + libssh2_sftp_readlink.3 \ + libssh2_sftp_realpath.3 \ + libssh2_sftp_rename.3 \ + libssh2_sftp_rename_ex.3 \ + libssh2_sftp_rewind.3 \ + libssh2_sftp_rmdir.3 \ + libssh2_sftp_rmdir_ex.3 \ + libssh2_sftp_seek.3 \ + libssh2_sftp_seek64.3 \ + libssh2_sftp_setstat.3 \ + libssh2_sftp_shutdown.3 \ + libssh2_sftp_stat.3 \ + libssh2_sftp_stat_ex.3 \ + libssh2_sftp_statvfs.3 \ + libssh2_sftp_symlink.3 \ + libssh2_sftp_symlink_ex.3 \ + libssh2_sftp_tell.3 \ + libssh2_sftp_tell64.3 \ + libssh2_sftp_unlink.3 \ + libssh2_sftp_unlink_ex.3 \ + libssh2_sftp_write.3 \ + libssh2_trace.3 \ + libssh2_trace_sethandler.3 \ + libssh2_userauth_authenticated.3 \ + libssh2_userauth_hostbased_fromfile.3 \ + libssh2_userauth_hostbased_fromfile_ex.3 \ + libssh2_userauth_keyboard_interactive.3 \ + libssh2_userauth_keyboard_interactive_ex.3 \ + libssh2_userauth_list.3 \ + libssh2_userauth_password.3 \ + libssh2_userauth_password_ex.3 \ + libssh2_userauth_publickey.3 \ + libssh2_userauth_publickey_fromfile.3 \ + libssh2_userauth_publickey_fromfile_ex.3 \ + libssh2_version.3 + +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign docs/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign docs/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +install-man3: $(dist_man_MANS) + @$(NORMAL_INSTALL) + @list1=''; \ + list2='$(dist_man_MANS)'; \ + test -n "$(man3dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man3dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man3dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.3[a-z]*$$/p'; \ + fi; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^3][0-9a-z]*$$,3,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man3dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man3dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man3dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man3dir)" || exit $$?; }; \ + done; } + +uninstall-man3: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man3dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.3[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^3][0-9a-z]*$$,3,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man3dir)'; $(am__uninstall_files_from_dir) +tags TAGS: + +ctags CTAGS: + +cscope cscopelist: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(MANS) +installdirs: + for dir in "$(DESTDIR)$(man3dir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-man + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: install-man3 + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-man + +uninstall-man: uninstall-man3 + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + cscopelist-am ctags-am distclean distclean-generic \ + distclean-libtool distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-man3 install-pdf install-pdf-am install-ps \ + install-ps-am install-strip installcheck installcheck-am \ + installdirs maintainer-clean maintainer-clean-generic \ + mostlyclean mostlyclean-generic mostlyclean-libtool pdf pdf-am \ + ps ps-am tags-am uninstall uninstall-am uninstall-man \ + uninstall-man3 + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/libssh2-sys/libssh2-1.5.0/docs/TODO b/libssh2-sys/libssh2-1.5.0/docs/TODO new file mode 100644 index 0000000..cae1afa --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/TODO @@ -0,0 +1,174 @@ +Things TODO +=========== + +* Fix the numerous malloc+copy operations for sending data, see "Buffering + Improvements" below for details + +* make sure the windowing code adapts better to slow situations so that it + doesn't then use as much memory as today. Possibly by an app-controllable + "Window mode"? + +* Decrease the number of mallocs. Everywhere. Will get easier once the + buffering improvements have been done. + +* Use SO_NOSIGPIPE for Mac OS/BSD systems where MSG_NOSIGNAL doesn't + exist/work + +* Extend the test suite to actually test lots of aspects of libssh2 + +* Fix all compiler warnings (some can't be done without API changes) + +* Expose error messages sent by the server + +* select() is troublesome with libssh2 when using multiple channels over + the same session. See "New Transport API" below for more details. + +At next SONAME bump +=================== + +* stop using #defined macros as part of the official API. The macros should + either be turned into real functions or discarded from the API. + +* fix the parts of the API where object pointers and function pointers are + mixed like libssh2_session_callback_set() + +* remove the following functions from the API/ABI + + libssh2_base64_decode() + libssh2_session_flag() + libssh2_channel_handle_extended_data() + libssh2_channel_receive_window_adjust() + libssh2_poll() + libssh2_poll_channel_read() + libssh2_session_startup() (libssh2_session_handshake() is the replacement) + libssh2_banner_set() (libssh2_session_banner_set() is the repacement) + +* Rename a few function: + + libssh2_hostkey_hash => libssh2_session_hostkey_hash + libssh2_banner_set => libssh2_session_banner_set + +* change 'int' to 'libssh2_socket_t' in the public API for sockets. + +* Use 'size_t' for string lengths in all functions. + +* Add a comment field to struct libssh2_knownhost. + +* remove the existing libssh2_knownhost_add() function and rename + libssh2_knownhost_addc to become the new libssh2_knownhost_add instead + +* remove the existing libssh2_scp_send_ex() function and rename + libssh2_scp_send64 to become the new libssh2_scp_send instead. + +* remove the existing libssh2_knownhost_check() functin and rename + libssh2_knownhost_checkp() to become the new libssh2_knownhost_check instead + +Buffering Improvements +====================== + +transport_write + + - If this function gets called with a total packet size that is larger than + 32K, it should create more than one SSH packet so that it keeps the largest + one below 32K + +sftp_write + + - should not copy/allocate anything for the data, only create a header chunk + and pass on the payload data to channel_write "pointed to" + +New Transport API +================= + +THE PROBLEM + +The problem in a nutshell is that when an application opens up multiple +channels over a single session, those are all using the same socket. If the +application is then using select() to wait for traffic (like any sensible app +does) and wants to act on the data when select() tells there is something to +for example read, what does an application do? + +With our current API, you have to loop over all the channels and read from +them to see if they have data. This effectively makes blocking reads +impossible. If the app has many channels in a setup like this, it even becomes +slow. (The original API had the libssh2_poll_channel_read() and libssh2_poll() +to somewhat overcome this hurdle, but they too have pretty much the same +problems plus a few others.) + +Traffic in the other direction is similarly limited: the app has to try +sending to all channels, even though some of them may very well not accept any +data at that point. + +A SOLUTION + +I suggest we introduce two new helper functions: + + libssh2_transport_read() + + - Read "a bunch" of data from the given socket and returns information to the + app about what channels that are now readable (ie they will not block when + read from). The function can be called over and over and it will repeatedly + return info about what channels that are readable at that moment. + + libssh2_transport_write() + + - Returns information about what channels that are writable, in the sense + that they have windows set from the remote side that allows data to get + sent. Writing to one of those channels will not block. Of course, the + underlying socket may only accept a certain amount of data, so at the first + short return, nothing more should be attempted to get sent until select() + (or equivalent) has been used on the master socket again. + +I haven't yet figured out a sensible API for how these functions should return +that info, but if we agree on the general principles I guess we can work that +out. + +VOLUNTARY + + I wanted to mention that these two helper functions would not be mandatory + in any way. They would just be there for those who want them, and existing + programs can remain using the old functions only if they prefer to. + +New SFTP API +============ + +PURPOSE + + Provide API functions that explicitly tells at once that a (full) SFTP file + transfer is wanted, to allow libssh2 to leverage on that knowledge to speed + up things internally. It can for example do read ahead, buffer writes (merge + small writes into larger chunks), better tune the SSH window and more. This + sort of API is already provided for SCP transfers. + +API + + New functions: + + LIBSSH2_SFTP_HANDLE *libssh2_sftp_send(SFTP_SESSION *sftp, + uint64_t filesize, + char *remote_path, + size_t remote_path_len, + long mode); + + Tell libssh2 that a local file with a given size is about to get sent to + the SFTP server. + + LIBSSH2_SFTP_HANDLE *libssh2_sftp_recv(); + + Tell libssh2 that a remote file is requested to get downloaded from the SFTP + server. + + Only the setup of the file transfer is different from an application's point + of view. Depending on direction of the transfer(s), the following already + existing functions should then be used until the transfer is complete: + + libssh2_sftp_read() + libssh2_sftp_write() + +HOW TO USE + + 1. Setup the transfer using one of the two new functions. + + 2. Loop through the reading or writing of data. + + 3. Cleanup the transfer diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_connect.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_connect.3 new file mode 100644 index 0000000..1c6ff6d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_connect.3 @@ -0,0 +1,23 @@ +.\" +.\" Copyright (c) 2009 by Daiki Ueno +.\" +.TH libssh2_agent_connect 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_agent_connect - connect to an ssh-agent +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_agent_connect(LIBSSH2_AGENT *agent); +.SH DESCRIPTION +Connect to an ssh-agent running on the system. + +Call \fBlibssh2_agent_disconnect(3)\fP to close the connection after +you're doing using it. +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_disconnect(3) + diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_disconnect.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_disconnect.3 new file mode 100644 index 0000000..f9f9ef0 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_disconnect.3 @@ -0,0 +1,20 @@ +.\" +.\" Copyright (c) 2009 by Daiki Ueno +.\" +.TH libssh2_agent_disconnect 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_agent_disconnect - close a connection to an ssh-agent +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_agent_disconnect(LIBSSH2_AGENT *agent); +.SH DESCRIPTION +Close a connection to an ssh-agent. + +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_connect(3) +.BR libssh2_agent_free(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_free.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_free.3 new file mode 100644 index 0000000..197f87e --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_free.3 @@ -0,0 +1,20 @@ +.\" +.\" Copyright (c) 2009 by Daiki Ueno +.\" +.TH libssh2_agent_free 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_agent_free - free an ssh-agent handle +.SH SYNOPSIS +#include <libssh2.h> + +void libssh2_agent_free(LIBSSH2_AGENT *agent); +.SH DESCRIPTION +Free an ssh-agent handle. This function also frees the internal +collection of public keys. +.SH RETURN VALUE +None. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_disconnect(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_get_identity.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_get_identity.3 new file mode 100644 index 0000000..a944165 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_get_identity.3 @@ -0,0 +1,34 @@ +.\" +.\" Copyright (c) 2009 by Daiki Ueno +.\" +.TH libssh2_agent_get_identity 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_agent_get_identity - get a public key off the collection of public keys managed by ssh-agent +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_agent_get_identity(LIBSSH2_AGENT *agent, + struct libssh2_agent_publickey **store, + struct libssh2_agent_publickey *prev); +.SH DESCRIPTION +\fIlibssh2_agent_get_identity(3)\fP allows an application to iterate +over all public keys in the collection managed by ssh-agent. + +\fIstore\fP should point to a pointer that gets filled in to point to the +public key data. + +\fIprev\fP is a pointer to a previous 'struct libssh2_agent_publickey' +as returned by a previous invoke of this function, or NULL to get the +first entry in the internal collection. +.SH RETURN VALUE +Returns 0 if everything is fine and information about a host was stored in +the \fIstore\fP struct. + +Returns 1 if it reached the end of public keys. + +Returns negative values for error +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_list_identities(3) +.BR libssh2_agent_userauth(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_init.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_init.3 new file mode 100644 index 0000000..26e891e --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_init.3 @@ -0,0 +1,26 @@ +.\" +.\" Copyright (c) 2009 by Daiki Ueno +.\" +.TH libssh2_agent_init 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_agent_init - init an ssh-agent handle +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_AGENT *libssh2_agent_init(LIBSSH2_SESSION *session); +.SH DESCRIPTION +Init an ssh-agent handle. Returns the handle to an internal +representation of an ssh-agent connection. After the successful +initialization, an application can call \fBlibssh2_agent_connect(3)\fP +to connect to a running ssh-agent. + +Call \fBlibssh2_agent_free(3)\fP to free the handle again after you're +doing using it. +.SH RETURN VALUE +Returns a handle pointer or NULL if something went wrong. The returned handle +is used as input to all other ssh-agent related functions libssh2 provides. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_connect(3) +.BR libssh2_agent_free(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_list_identities.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_list_identities.3 new file mode 100644 index 0000000..e1e4b54 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_list_identities.3 @@ -0,0 +1,24 @@ +.\" +.\" Copyright (c) 2009 by Daiki Ueno +.\" +.TH libssh2_agent_list_identities 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_agent_list_identities - request an ssh-agent to list of public keys. +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_agent_list_identities(LIBSSH2_AGENT *agent); +.SH DESCRIPTION +Request an ssh-agent to list of public keys, and stores them in the +internal collection of the handle. Call +\fIlibssh2_agent_get_identity(3)\fP to get a public key off the +collection. + +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_connect(3) +.BR libssh2_agent_get_identity(3) + diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_userauth.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_userauth.3 new file mode 100644 index 0000000..3c956fe --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_agent_userauth.3 @@ -0,0 +1,29 @@ +.\" +.\" Copyright (c) 2009 by Daiki Ueno +.\" +.TH libssh2_agent_userauth 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_agent_userauth(LIBSSH2_AGENT *agent, + const char *username, + struct libssh2_agent_publickey *identity); +.SH DESCRIPTION +\fIagent\fP - ssh-agent handle as returned by +.BR libssh2_agent_init(3) + +\fIusername\fP - Remote user name to authenticate as. + +\fIidentity\fP - Public key to authenticate with, as returned by +.BR libssh2_agent_get_identity(3) + +Attempt public key authentication with the help of ssh-agent. +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_agent_init(3) +.BR libssh2_agent_get_identity(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_banner_set.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_banner_set.3 new file mode 100644 index 0000000..2baa121 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_banner_set.3 @@ -0,0 +1,32 @@ +.TH libssh2_banner_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_banner_set - set the SSH protocol banner for the local client +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner); + +.SH DESCRIPTION +This function is \fBDEPRECATED\fP. Use \fIlibssh2_session_banner_set(3)\fP +instead! + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIbanner\fP - A pointer to a user defined banner + +Set the banner that will be sent to the remote host when the SSH session is +started with +.BR libssh2_session_handshake(3) + This is optional; a banner corresponding to the protocol and libssh2 version will be sent by default. +.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 AVAILABILITY +Marked as deprecated since 1.4.0 +.SH ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. +.SH SEE ALSO +.BR libssh2_session_handshake(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3 new file mode 100644 index 0000000..932f03a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_base64_decode.3 @@ -0,0 +1,25 @@ +.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 +This function is deemed DEPRECATED and will be removed from libssh2 in a +future version. Don't use it! + +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. + +The returned buffer is allocated by this function, but it is not clear how to +free that memory! +.SH BUGS +The memory that *dest points to is allocated by the malloc function libssh2 +uses, but there's no way for an application to free this data in a safe and +reliable way! +.SH RETURN VALUE +0 if successful, \-1 if any error occurred. diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_close.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_close.3 new file mode 100644 index 0000000..2fe0a0d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_close.3 @@ -0,0 +1,29 @@ +.TH libssh2_channel_close 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_close - close a channel +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_close(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +\fIchannel\fP - active channel stream to set closed status on. + +Close an active data channel. In practice this means sending an SSH_MSG_CLOSE +packet to the remote host which serves as instruction that no further data +will be sent to it. The remote host may still send data back until it sends +its own close message in response. To wait for the remote end to close its +connection as well, follow this command with +.BR libssh2_channel_wait_closed(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_SOCKET_SEND\fP - Unable to send data on socket. + +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_direct_tcpip.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_direct_tcpip.3 new file mode 100644 index 0000000..742769d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_direct_tcpip.3 @@ -0,0 +1,18 @@ +.TH libssh2_channel_direct_tcpip 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_direct_tcpip - convenience macro for \fIlibssh2_channel_direct_tcpip_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_direct_tcpip_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_direct_tcpip_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_direct_tcpip_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_direct_tcpip_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_direct_tcpip_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_direct_tcpip_ex.3 new file mode 100644 index 0000000..481c55c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_direct_tcpip_ex.3 @@ -0,0 +1,35 @@ +.TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, const char *host, int port, const char *shost, int sport); + +LIBSSH2_CHANNEL * +libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIhost\fP - Third party host to connect to using the SSH host as a proxy. + +\fIport\fP - Port on third party host to connect to. + +\fIshost\fP - Host to tell the SSH server the connection originated on. + +\fIsport\fP - Port to tell the SSH server the connection originated from. + +Tunnel a TCP/IP connection through the SSH transport via the remote host to +a third party. Communication from the client to the SSH server remains +encrypted, communication from the server to the 3rd party host travels +in cleartext. + +.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. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_eof.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_eof.3 new file mode 100644 index 0000000..ed4a074 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_eof.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_eof - check a channel's EOF status +.SH SYNOPSIS +#include <libssh2.h> + +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. Negative on +failure. +.SH SEE ALSO +.BR libssh2_channel_close(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_exec.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_exec.3 new file mode 100644 index 0000000..3ab069d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_exec.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_exec 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_exec - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *command); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR libssh2_channel_process_startup(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush.3 new file mode 100644 index 0000000..b449945 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_flush 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_flush - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_flush(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_flush_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_flush_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_flush_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_flush_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush_ex.3 new file mode 100644 index 0000000..1885176 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush_ex.3 @@ -0,0 +1,32 @@ +.TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_flush_ex - flush a channel +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid); + +int +libssh2_channel_flush(LIBSSH2_CHANNEL *channel); + +int +libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +\fIchannel\fP - Active channel stream to flush. + +\fIstreamid\fP - Specific substream number to flush. Groups of substreams may +be flushed by passing on of the following Constants. +.br +\fBLIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA\fP: Flush all extended data substreams +.br +\fBLIBSSH2_CHANNEL_FLUSH_ALL\fP: Flush all substreams + +Flush the read buffer for a given channel instance. Individual substreams may +be flushed by number or using one of the provided macros. + +.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. diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush_stderr.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush_stderr.3 new file mode 100644 index 0000000..156bb06 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_flush_stderr.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_flush_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_flush_stderr - convenience macro for \fIlibssh2_channel_flush_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_flush_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_flush_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_flush_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_flush_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_accept.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_accept.3 new file mode 100644 index 0000000..176ac1c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_accept.3 @@ -0,0 +1,20 @@ +.TH libssh2_channel_forward_accept 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_forward_accept - accept a queued connection +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener); + +.SH DESCRIPTION +\fIlistener\fP is a forwarding listener instance as returned by +\fBlibssh2_channel_forward_listen_ex(3)\fP. +.SH RETURN VALUE +A newly allocated channel instance or NULL on failure. +.SH ERRORS +When this function returns NULL use \fIlibssh2_session_last_errno(3)\fP to +extract the error code. If that code is \fILIBSSH2_ERROR_EAGAIN\fP, the +session is set to do non-blocking I/O but the call would block. +.SH SEE ALSO +.BR libssh2_channel_forward_listen_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3 new file mode 100644 index 0000000..16f826f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_cancel.3 @@ -0,0 +1,27 @@ +.TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_forward_cancel - cancel a forwarded TCP port +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); + +.SH DESCRIPTION +\fIlistener\fP - Forwarding listener instance as returned by +.BR libssh2_channel_forward_listen_ex(3) + +Instruct the remote host to stop listening for new connections on a previously requested host/port. + +.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. + +.SH SEE ALSO +.BR libssh2_channel_forward_listen_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_listen.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_listen.3 new file mode 100644 index 0000000..6cb54e7 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_listen.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_forward_listen 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_forward_listen - convenience macro for \fIlibssh2_channel_forward_listen_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_forward_listen_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_forward_listen_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_forward_listen_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_forward_listen_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_listen_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_listen_ex.3 new file mode 100644 index 0000000..a358f6c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_forward_listen_ex.3 @@ -0,0 +1,46 @@ +.TH libssh2_channel_forward_listen_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_forward_listen_ex - listen to inbound connections +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_LISTENER * +libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, char *host, int port, int *bound_port, int queue_maxsize); + +LIBSSH2_LISTENER * +libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); + +.SH DESCRIPTION +Instruct the remote SSH server to begin listening for inbound TCP/IP +connections. New connections will be queued by the library until accepted by +\fIlibssh2_channel_forward_accept(3)\fP. + +\fIsession\fP - instance as returned by libssh2_session_init(). + +\fIhost\fP - specific address to bind to on the remote host. Binding to +0.0.0.0 (default when NULL is passed) will bind to all available addresses. + +\fIport\fP - port to bind to on the remote host. When 0 is passed, the remote +host will select the first available dynamic port. + +\fIbound_port\fP - Populated with the actual port bound on the remote +host. Useful when requesting dynamic port numbers. + +\fIqueue_maxsize\fP - Maximum number of pending connections to queue before +rejecting further attempts. + +\fIlibssh2_channel_forward_listen(3)\fP is a macro. +.SH RETURN VALUE +A newly allocated LIBSSH2_LISTENER instance or NULL on failure. +.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_PROTO\fP - An invalid SSH protocol response was received on the socket. + +\fILIBSSH2_ERROR_REQUEST_DENIED\fP - The remote server refused the request. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +.SH SEE ALSO +.BR libssh2_channel_forward_accept(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_free.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_free.3 new file mode 100644 index 0000000..fc76f5a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_free.3 @@ -0,0 +1,25 @@ +.TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_free - free all resources associated with a channel +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_free(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +\fIchannel\fP - Channel stream to free. + +Release all resources associated with a channel stream. If the channel has +not yet been closed with +.BR libssh2_channel_close(3) +, it will be called automatically so that the remote end may know that it +can safely free its own resources. + +.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_channel_close(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_get_exit_signal.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_get_exit_signal.3 new file mode 100644 index 0000000..138e7c7 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_get_exit_signal.3 @@ -0,0 +1,34 @@ +.TH libssh2_channel_get_exit_signal 3 "4 Oct 2010" "libssh2 1.2.8" "libssh2 manual" +.SH NAME +libssh2_channel_get_exit_signal - get the remote exit signal +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel, char **exitsignal, size_t *exitsignal_len, char **errmsg, size_t *errmsg_len, char **langtag, size_t *langtag_len); + +.SH DESCRIPTION +\fIchannel\fP - Closed channel stream to retrieve exit signal from. + +\fIexitsignal\fP - If not NULL, is populated by reference with the exit signal +(without leading "SIG"). Note that the string is stored in a newly allocated +buffer. If the remote program exited cleanly, the referenced string pointer +will be set to NULL. + +\fIexitsignal_len\fP - If not NULL, is populated by reference with the length +of exitsignal. + +\fIerrmsg\fP - If not NULL, is populated by reference with the error message +(if provided by remote server, if not it will be set to NULL). Note that the +string is stored in a newly allocated buffer. + +\fIerrmsg_len\fP - If not NULL, is populated by reference with the length of errmsg. + +\fIlangtag\fP - If not NULL, is populated by reference with the language tag +(if provided by remote server, if not it will be set to NULL). Note that the +string is stored in a newly allocated buffer. + +\fIlangtag_len\fP - If not NULL, is populated by reference with the length of langtag. + +.SH RETURN VALUE +Numeric error code corresponding to the the Error Code constants. diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_get_exit_status.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_get_exit_status.3 new file mode 100644 index 0000000..4a8c9e2 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_get_exit_status.3 @@ -0,0 +1,18 @@ +.TH libssh2_channel_get_exit_status 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_get_exit_status - get the remote exit code +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_get_exit_status(LIBSSH2_CHANNEL* channel) + +.SH DESCRIPTION +\fIchannel\fP - Closed channel stream to retrieve exit status from. + +Returns the exit code raised by the process running on the remote host at +the other end of the named channel. Note that the exit status may not be +available if the remote end has not yet set its status to closed. + +.SH RETURN VALUE +Returns 0 on failure, otherwise the \fIExit Status\fP reported by remote host diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_handle_extended_data.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_handle_extended_data.3 new file mode 100644 index 0000000..8ab2488 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_handle_extended_data.3 @@ -0,0 +1,35 @@ +.TH libssh2_channel_handle_extended_data 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_handle_extended_data - set extended data handling mode +.SH SYNOPSIS +#include <libssh2.h> + +void +libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode); + +.SH DESCRIPTION +This function is deprecated. Use the +\fIlibssh2_channel_handle_extended_data2(3)\fP function instead! + +\fIchannel\fP - Active channel stream to change extended data handling on. + +\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual +reading +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary +data the same. Merge all substreams such that calls to +\fIlibssh2_channel_read(3)\fP will pull from all substreams on a +first-in/first-out basis. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it +arrives. + +Change how a channel deals with extended data packets. By default all extended +data is queued until read by \fIlibssh2_channel_read_ex(3)\fP +.SH RETURN VALUE +None. +.SH SEE ALSO +.BR libssh2_channel_handle_extended_data2(3) +.BR libssh2_channel_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_handle_extended_data2.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_handle_extended_data2.3 new file mode 100644 index 0000000..8910d8c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_handle_extended_data2.3 @@ -0,0 +1,35 @@ +.TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_handle_extended_data2 - set extended data handling mode +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int ignore_mode); + +.SH DESCRIPTION +\fIchannel\fP - Active channel stream to change extended data handling on. + +\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual +reading +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary +data the same. Merge all substreams such that calls to +.BR libssh2_channel_read(3) +will pull from all substreams on a first-in/first-out basis. +.br +\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it +arrives. + +Change how a channel deals with extended data packets. By default all +extended data is queued until read by +.BR libssh2_channel_read_ex(3) + +.SH RETURN VALUE +Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block. + +.SH SEE ALSO +.BR libssh2_channel_handle_extended_data(3) +.BR libssh2_channel_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_ignore_extended_data.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_ignore_extended_data.3 new file mode 100644 index 0000000..342c620 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_ignore_extended_data.3 @@ -0,0 +1,20 @@ +.TH libssh2_channel_ignore_extended_data 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_ignore_extended_data - convenience macro for \fIlibssh2_channel_handle_extended_data(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +libssh2_channel_ignore_extended_data(arguments) + +.SH DESCRIPTION +This function is deprecated. Use the +\fIlibssh2_channel_handle_extended_data2(3)\fP function instead! + +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_handle_extended_data(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_handle_extended_data(3)\fP +.SH ERRORS +See \fIlibssh2_channel_handle_extended_data(3)\fP +.SH SEE ALSO +.BR libssh2_channel_handle_extended_data(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_open_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_open_ex.3 new file mode 100644 index 0000000..7dec294 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_open_ex.3 @@ -0,0 +1,54 @@ +.TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_open_ex - establish a generic session channel +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, unsigned int channel_type_len, unsigned int window_size, unsigned int packet_size, const char *message, unsigned int message_len); + +LIBSSH2_CHANNEL * +libssh2_channel_open_session(session); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIchannel_type\fP - Channel type to open. Typically one of session, +direct-tcpip, or tcpip-forward. The SSH2 protocol allowed for additional +types including local, custom channel types. + +\fIchannel_type_len\fP - Length of channel_type + +\fIwindow_size\fP - Maximum amount of unacknowledged data remote host is +allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST packet. + +\fIpacket_size\fP - Maximum number of bytes remote host is allowed to send +in a single SSH_MSG_CHANNEL_DATA or SSG_MSG_CHANNEL_EXTENDED_DATA packet. + +\fImessage\fP - Additional data as required by the selected channel_type. + +\fImessage_len\fP - Length of message parameter. + +Allocate a new channel for exchanging data with the server. This method is +typically called through its macroized form: +.BR libssh2_channel_open_session(3) +or via +.BR libssh2_channel_direct_tcpip(3) +or +.BR libssh2_channel_forward_listen(3) + +.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_CHANNEL_FAILURE\fP - + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. + +.SH SEE ALSO +Add related functions diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_open_session.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_open_session.3 new file mode 100644 index 0000000..4306f4c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_open_session.3 @@ -0,0 +1,18 @@ +.TH libssh2_channel_open_session 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_open_session - convenience macro for \fIlibssh2_channel_open_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_channel_open_session(LIBSSH2_SESSION *session); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_open_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_process_startup.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_process_startup.3 new file mode 100644 index 0000000..7c27982 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_process_startup.3 @@ -0,0 +1,38 @@ +.TH libssh2_channel_process_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_process_startup - request a shell on a channel +.SH SYNOPSIS +.nf +#include <libssh2.h> + +int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, + const char *request, + unsigned int request_len, + const char *message, + unsigned int message_len); +.SH DESCRIPTION +\fIchannel\fP - Active session channel instance. + +\fIrequest\fP - Type of process to startup. The SSH2 protocol currently +defines shell, exec, and subsystem as standard process services. + +\fIrequest_len\fP - Length of request parameter. + +\fImessage\fP - Request specific message data to include. + +\fImessage_len\fP - Length of message parameter. + +Initiate a request on a session type channel such as returned by +.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_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read.3 new file mode 100644 index 0000000..f185716 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_read - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +ssize_t libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_read_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read_ex.3 new file mode 100644 index 0000000..83d7c3e --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read_ex.3 @@ -0,0 +1,45 @@ +.TH libssh2_channel_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_read_ex - read data from a channel stream +.SH SYNOPSIS +#include <libssh2.h> + +ssize_t +libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen); + +ssize_t +libssh2_channel_read(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); + +ssize_t +libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); + +.SH DESCRIPTION +Attempt to read data from an active channel stream. All channel streams have +one standard I/O substream (stream_id == 0), and may have up to 2^32 extended +data streams as identified by the selected \fIstream_id\fP. The SSH2 protocol +currently defines a stream ID of 1 to be the stderr substream. + +\fIchannel\fP - active channel stream to read from. + +\fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR) + +\fIbuf\fP - pointer to storage buffer to read data into + +\fIbuflen\fP - size of the buf storage + +\fIlibssh2_channel_read(3)\fP and \fIlibssh2_channel_read_stderr(3)\fP are +macros. +.SH RETURN VALUE +Actual number of bytes read 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. + +Note that a return value of zero (0) can in fact be a legitimate value and +only signals that no payload data was read. It is not an error. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed. + +.SH SEE ALSO +.BR libssh2_poll_channel_read(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read_stderr.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read_stderr.3 new file mode 100644 index 0000000..9324410 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_read_stderr.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_read_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_read_stderr - convenience macro for \fIlibssh2_channel_read_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +ssize_t libssh2_channel_read_stderr(LIBSSH2_CHANNEL *channel, char *buf, size_t buflen); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_read_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_receive_window_adjust.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_receive_window_adjust.3 new file mode 100644 index 0000000..a728811 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_receive_window_adjust.3 @@ -0,0 +1,29 @@ +.TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_receive_window_adjust - adjust the channel window +.SH SYNOPSIS +#include <libssh2.h> + +unsigned long +libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel, + unsigned long adjustment, + unsigned char force); + +.SH DESCRIPTION +This function is deprecated in 1.1. Use +\fIlibssh2_channel_receive_window_adjust2(3)\fP! + +Adjust the receive window for a channel by adjustment bytes. If the amount to +be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the +adjustment amount will be queued for a later packet. +.SH RETURN VALUE +Returns the new size of the receive window (as understood by remote end). Note +that the window value sent over the wire is strictly 32bit, but this API is +made to return a 'long' which may not be 32 bit on all platforms. +.SH ERRORS +In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for +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 +.BR libssh2_channel_window_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_receive_window_adjust2.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_receive_window_adjust2.3 new file mode 100644 index 0000000..dd2fcc1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_receive_window_adjust2.3 @@ -0,0 +1,27 @@ +.TH libssh2_channel_receive_window_adjust2 3 "26 Mar 2009" "libssh2 1.1" "libssh2 manual" +.SH NAME +libssh2_channel_receive_window_adjust2 - adjust the channel window +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel, + unsigned long adjustment, + unsigned char force, + unsigned int *window); + +.SH DESCRIPTION +Adjust the receive window for a channel by adjustment bytes. If the amount to +be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the +adjustment amount will be queued for a later packet. + +This function stores the new size of the receive window (as understood by +remote end) in the variable 'window' points to. +.SH RETURN VALUE +Return 0 on success and a negative value on error. If used in non-blocking +mode it will return LIBSSH2_ERROR_EAGAIN when it would otherwise block. +.SH ERRORS +.SH AVAILABILITY +Added in libssh2 1.1 since the previous API has deficiencies. +.SH SEE ALSO +.BR libssh2_channel_window_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty.3 new file mode 100644 index 0000000..f57352b --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_request_pty 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_request_pty - convenience macro for \fIlibssh2_channel_request_pty_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_request_pty(LIBSSH2_SESSION *session, const char *term); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_request_pty_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_request_pty_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_request_pty_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_request_pty_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_ex.3 new file mode 100644 index 0000000..35b5840 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_ex.3 @@ -0,0 +1,47 @@ +.TH libssh2_channel_request_pty_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_request_pty_ex - short function description +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, const char *term, unsigned int term_len, const char *modes, unsigned int modes_len, int width, int height, int width_px, int height_px); + +int +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_ex(3) + +\fIterm\fP - Terminal emulation (e.g. vt102, ansi, etc...) + +\fIterm_len\fP - Length of term parameter + +\fImodes\fP - Terminal mode modifier values + +\fImodes_len\fP - Length of modes parameter. + +\fIwidth\fP - Width of pty in characters + +\fIheight\fP - Height of pty in characters + +\fIwidth_px\fP - Width of pty in pixels + +\fIheight_px\fP - Height of pty in pixels + +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_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_size.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_size.3 new file mode 100644 index 0000000..4b0c12d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_size.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_request_pty_size 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_request_pty_size - convenience macro for \fIlibssh2_channel_request_pty_size_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_request_pty_size(LIBSSH2_CHANNEL *channel, int width, int height); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_request_pty_size_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_request_pty_size_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_request_pty_size_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_request_pty_size_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_size_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_size_ex.3 new file mode 100644 index 0000000..b3cd619 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_request_pty_size_ex.3 @@ -0,0 +1,12 @@ +.TH libssh2_channel_request_pty_size_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_request_pty_size_ex - TODO +.SH SYNOPSIS + +.SH DESCRIPTION + +.SH RETURN VALUE + +.SH ERRORS + +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_send_eof.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_send_eof.3 new file mode 100644 index 0000000..0e5975a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_send_eof.3 @@ -0,0 +1,24 @@ +.TH libssh2_channel_send_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_send_eof - send EOF to remote server +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +Tell the remote host that no further data will be sent on the specified +channel. Processes typically interpret this as a closed stdin descriptor. + +.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_SOCKET_SEND\fP - Unable to send data on socket. + +.SH SEE ALSO +.BR libssh2_channel_wait_eof(3) +.BR libssh2_channel_eof(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_set_blocking.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_set_blocking.3 new file mode 100644 index 0000000..55ee4ff --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_set_blocking.3 @@ -0,0 +1,23 @@ +.TH libssh2_channel_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_set_blocking - set or clear blocking mode on channel +.SH SYNOPSIS +#include <libssh2.h> + +void +libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking); +.SH DESCRIPTION +\fIchannel\fP - channel stream to set or clean blocking status on. + +\fIblocking\fP - Set to a non-zero value to make the channel block, or zero to +make it non-blocking. + +Currently this is just a short cut call to +.BR libssh2_session_set_blocking(3) +and therefore will affect the session and all channels. +.SH RETURN VALUE +None +.SH SEE ALSO +.BR libssh2_session_set_blocking(3) +.BR libssh2_channel_read_ex(3) +.BR libssh2_channel_write_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_setenv.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_setenv.3 new file mode 100644 index 0000000..b30d471 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_setenv.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_setenv 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_setenv - convenience macro for \fIlibssh2_channel_setenv_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, const char *varname, const char *value); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_setenv_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_setenv_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_setenv_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_setenv_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_setenv_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_setenv_ex.3 new file mode 100644 index 0000000..4a5fd3e --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_setenv_ex.3 @@ -0,0 +1,41 @@ +.TH libssh2_channel_setenv_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_setenv_ex - set an environment variable on the channel +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, unsigned int varname_len, const char *value, unsigned int value_len); + +int +libssh2_channel_setenv(LIBSSH2_CHANNEL *channel, char *varname, const char *value); + +.SH DESCRIPTION +\fIchannel\fP - Previously opened channel instance such as returned by +.BR libssh2_channel_open_ex(3) + +\fIvarname\fP - Name of environment variable to set on the remote +channel instance. + +\fIvarname_len\fP - Length of passed varname parameter. + +\fIvalue\fP - Value to set varname to. + +\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. +.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_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_shell.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_shell.3 new file mode 100644 index 0000000..4ba6e69 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_shell.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_shell 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_shell - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_shell(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR libssh2_channel_process_startup(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_subsystem.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_subsystem.3 new file mode 100644 index 0000000..dd29f2c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_subsystem.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_subsystem 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_subsystem - convenience macro for \fIlibssh2_channel_process_startup(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_subsystem(LIBSSH2_CHANNEL *channel, const char *subsystem); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_process_startup(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_process_startup(3)\fP +.SH ERRORS +See \fIlibssh2_channel_process_startup(3)\fP +.SH SEE ALSO +.BR libssh2_channel_process_startup(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_wait_closed.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_wait_closed.3 new file mode 100644 index 0000000..4471736 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_wait_closed.3 @@ -0,0 +1,22 @@ +.TH libssh2_channel_wait_closed 3 "29 Nov 2007" "libssh2 0.19" "libssh2 manual" +.SH NAME +libssh2_channel_wait_closed - wait for the remote to close the channel +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_wait_closed(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +Enter a temporary blocking state until the remote host closes the named +channel. Typically sent after \fIlibssh2_channel_close(3)\fP in order to +examine the exit status. + +.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_channel_send_eof(3) +.BR libssh2_channel_eof(3) +.BR libssh2_channel_wait_eof(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_wait_eof.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_wait_eof.3 new file mode 100644 index 0000000..47587e6 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_wait_eof.3 @@ -0,0 +1,19 @@ +.TH libssh2_channel_wait_eof 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_wait_eof - wait for the remote to reply to an EOF request +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_wait_eof(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +Wait for the remote end to acknowledge an EOF request. + +.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_channel_send_eof(3) +.BR libssh2_channel_eof(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_read.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_read.3 new file mode 100644 index 0000000..70938d3 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_read.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_window_read 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_window_read - convenience macro for \fIlibssh2_channel_window_read_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +unsigned long libssh2_channel_window_read(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_window_read_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_window_read_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_window_read_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_window_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_read_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_read_ex.3 new file mode 100644 index 0000000..b528096 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_read_ex.3 @@ -0,0 +1,24 @@ +.TH libssh2_channel_window_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_window_read_ex - Check the status of the read window +.SH SYNOPSIS +#include <libssh2.h> + +unsigned long +libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel, + unsigned long *read_avail, + unsigned long *window_size_initial) +.SH DESCRIPTION +Check the status of the read window. Returns the number of bytes which the +remote end may send without overflowing the window limit read_avail (if +passed) will be populated with the number of bytes actually available to be +read window_size_initial (if passed) will be populated with the +window_size_initial as defined by the channel_open request +.SH RETURN VALUE +The number of bytes which the remote end may send without overflowing the +window limit +.SH ERRORS + +.SH SEE ALSO +.BR libssh2_channel_receive_window_adjust(3), +.BR libssh2_channel_window_write_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_write.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_write.3 new file mode 100644 index 0000000..d8c3993 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_write.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_window_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_window_write - convenience macro for \fIlibssh2_channel_window_write_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +unsigned long libssh2_channel_window_write(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_window_write_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_window_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_window_write_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_window_write_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_write_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_write_ex.3 new file mode 100644 index 0000000..d34cd40 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_window_write_ex.3 @@ -0,0 +1,21 @@ +.TH libssh2_channel_window_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_window_write_ex - Check the status of the write window +.SH SYNOPSIS +#include <libssh2.h> + +unsigned long +libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel, + unsigned long *window_size_initial) +.SH DESCRIPTION +Check the status of the write window Returns the number of bytes which may be +safely written on the channel without blocking. 'window_size_initial' (if +passed) will be populated with the size of the initial window as defined by +the channel_open request +.SH RETURN VALUE +Number of bytes which may be safely written on the channel without blocking. +.SH ERRORS + +.SH SEE ALSO +.BR libssh2_channel_window_read_ex(3), +.BR libssh2_channel_receive_window_adjust(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write.3 new file mode 100644 index 0000000..b9de747 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write.3 @@ -0,0 +1,18 @@ +.TH libssh2_channel_write 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_write - convenience macro for \fIlibssh2_channel_write_ex(3)\fP +.SH SYNOPSIS +.nf +#include <libssh2.h> + +ssize_t libssh2_channel_write(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_write_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_write_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_write_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write_ex.3 new file mode 100644 index 0000000..4ef7df1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write_ex.3 @@ -0,0 +1,47 @@ +.TH libssh2_channel_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_write_ex - write data to a channel stream blocking +.SH SYNOPSIS +.nf +#include <libssh2.h> + +ssize_t libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, + int stream_id, char *buf, + size_t buflen); +.SH DESCRIPTION +Write data to a channel stream. All channel streams have one standard I/O +substream (stream_id == 0), and may have up to 2^32 extended data streams as +identified by the selected \fIstream_id\fP. The SSH2 protocol currently +defines a stream ID of 1 to be the stderr substream. + +\fIchannel\fP - active channel stream to write to. + +\fIstream_id\fP - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR) + +\fIbuf\fP - pointer to buffer to write + +\fIbuflen\fP - size of the data to write + +\fIlibssh2_channel_write(3)\fP and \fIlibssh2_channel_write_stderr(3)\fP are +convenience macros for this function. + +\fIlibssh2_channel_write_ex(3)\fP will use as much as possible of the buffer +and put it into a single SSH protocol packet. This means that to get maximum +performance when sending larger files, you should try to always pass in at +least 32K of data to this function. +.SH RETURN VALUE +Actual number of bytes written 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. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_CHANNEL_CLOSED\fP - The channel has been closed. + +\fILIBSSH2_ERROR_CHANNEL_EOF_SENT\fP - The channel has been requested to be +closed. +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) +.BR libssh2_channel_read_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write_stderr.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write_stderr.3 new file mode 100644 index 0000000..ac4d387 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_write_stderr.3 @@ -0,0 +1,18 @@ +.TH libssh2_channel_write_stderr 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_write_stderr - convenience macro for \fIlibssh2_channel_write_ex(3)\fP +.SH SYNOPSIS +.nf +#include <libssh2.h> + +ssize_t libssh2_channel_write_stderr(LIBSSH2_CHANNEL *channel, const char *buf, size_t buflen); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_write_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_write_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_write_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_write_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_x11_req.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_x11_req.3 new file mode 100644 index 0000000..c558e40 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_x11_req.3 @@ -0,0 +1,17 @@ +.TH libssh2_channel_x11_req 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_channel_x11_req - convenience macro for \fIlibssh2_channel_x11_req_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_channel_x11_req(LIBSSH2_CHANNEL *channel, int screen_number); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_channel_x11_req_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_channel_x11_req_ex(3)\fP +.SH ERRORS +See \fIlibssh2_channel_x11_req_ex(3)\fP +.SH SEE ALSO +.BR libssh2_channel_x11_req_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_x11_req_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_x11_req_ex.3 new file mode 100644 index 0000000..e0121bd --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_channel_x11_req_ex.3 @@ -0,0 +1,44 @@ +.TH libssh2_channel_x11_req_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_x11_req_ex - request an X11 forwarding channel +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, const char *auth_proto, const char *auth_cookie, int screen_number); + +int +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_ex(3) + +\fIsingle_connection\fP - non-zero to only forward a single connection. + +\fIauth_proto\fP - X11 authentication protocol to use + +\fIauth_cookie\fP - the cookie (hexadecimal encoded). + +\fIscreen_number\fP - the XLL screen to forward + +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. + +.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_ex(3) +.BR libssh2_session_callback_set(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_exit.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_exit.3 new file mode 100644 index 0000000..2e7afd7 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_exit.3 @@ -0,0 +1,14 @@ +.TH libssh2_exit 3 "19 Mar 2010" "libssh2 1.2.5" "libssh2 manual" +.SH NAME +libssh2_exit - global library deinitialization +.SH SYNOPSIS +#include <libssh2.h> + +void +libssh2_exit(void); +.SH DESCRIPTION +Exit the libssh2 functions and free's all memory used internal. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_free.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_free.3 new file mode 100644 index 0000000..30176d5 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_free.3 @@ -0,0 +1,19 @@ +.TH libssh2_exit 3 "13 Oct 2010" "libssh2 1.2.8" "libssh2 manual" +.SH NAME +libssh2_free - deallocate libssh2 memory +.SH SYNOPSIS +#include <libssh2.h> + +void +libssh2_free(LIBSSH2_SESSION *session, void *ptr); +.SH DESCRIPTION +Deallocate memory allocated by earlier call to libssh2 functions. It +uses the memory allocation callbacks provided by the application, if +any. Otherwise, this will just call free(). + +This function is mostly useful under Windows when libssh2 is linked to +one run-time library and the application to another. +.SH AVAILABILITY +Added in libssh2 1.2.8 +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_hostkey_hash.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_hostkey_hash.3 new file mode 100644 index 0000000..c2f1644 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_hostkey_hash.3 @@ -0,0 +1,26 @@ +.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 <libssh2.h> + +const char * +libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(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 information is not available +(either the session has not yet been started up, or the requested hash +algorithm was not available). The hash consists of raw binary bytes, not hex +digits, so it is not directly printable. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_init.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_init.3 new file mode 100644 index 0000000..416a789 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_init.3 @@ -0,0 +1,20 @@ +.TH libssh2_init 3 "19 Mar 2010" "libssh2 1.2.5" "libssh2 manual" +.SH NAME +libssh2_init - global library initialization +.SH SYNOPSIS +#include <libssh2.h> + +#define LIBSSH2_INIT_NO_CRYPTO 0x0001 + +int +libssh2_init(int flags); +.SH DESCRIPTION +Initialize the libssh2 functions. This typically initialize the +crypto library. It uses a global state, and is not thread safe -- you +must make sure this function is not called concurrently. +.SH RETURN VALUE +Returns 0 if succeeded, or a negative value for error. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_exit(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_keepalive_config.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_keepalive_config.3 new file mode 100644 index 0000000..15e3ab9 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_keepalive_config.3 @@ -0,0 +1,27 @@ +.TH libssh2_keepalive_config 3 "12 Apr 2011" "libssh2 1.2.5" "libssh2 manual" +.SH NAME +libssh2_keepalive_config - short function description +.SH SYNOPSIS +#include <libssh2.h> +.nf + +void libssh2_keepalive_config(LIBSSH2_SESSION *session, + int want_reply, + unsigned interval); +.fi +.SH DESCRIPTION +Set how often keepalive messages should be sent. \fBwant_reply\fP indicates +whether the keepalive messages should request a response from the server. +\fBinterval\fP is number of seconds that can pass without any I/O, use 0 (the +default) to disable keepalives. To avoid some busy-loop corner-cases, if you +specify an interval of 1 it will be treated as 2. + +Note that non-blocking applications are responsible for sending the keepalive +messages using \fBlibssh2_keepalive_send(3)\fP. +.SH RETURN VALUE +Nothing +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_keepalive_send(3) + diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_keepalive_send.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_keepalive_send.3 new file mode 100644 index 0000000..f4f19d1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_keepalive_send.3 @@ -0,0 +1,18 @@ +.TH libssh2_keepalive_send 3 "13 Apr 2011" "libssh2 1.2.5" "libssh2 manual" +.SH NAME +libssh2_keepalive_send - short function description +.SH SYNOPSIS +#include <libssh2.h> +.nf + +int libssh2_keepalive_send(LIBSSH2_SESSION *session, + int *seconds_to_next); +.SH DESCRIPTION +Send a keepalive message if needed. \fBseconds_to_next\fP indicates how many +seconds you can sleep after this call before you need to call it again. +.SH RETURN VALUE +Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_keepalive_config(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_add.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_add.3 new file mode 100644 index 0000000..00a69e0 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_add.3 @@ -0,0 +1,66 @@ + +.\" Copyright (c) 2009, 2010 by Daniel Stenberg +.\" +.TH libssh2_knownhost_add 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_add - add a known host +.SH SYNOPSIS +.nf +#include <libssh2.h> + +int libssh2_knownhost_add(LIBSSH2_KNOWNHOSTS *hosts, + char *host, char *salt, + char *key, size_t keylen, + int typemask, + struct libssh2_knownhost **store); +.SH DESCRIPTION +We discourage use of this function as of libssh2 1.2.5. Instead we strongly +urge users to use \fIlibssh2_knownhost_addc(3)\fP instead, which as a more +complete API. \fIlibssh2_knownhost_add(3)\fP is subject for removal in a +future release. + +Adds a known host to the collection of known hosts identified by the 'hosts' +handle. + +\fIhost\fP is a pointer the host name in plain text or hashed. If hashed, it +must be provided base64 encoded. The host name can be the IP numerical address +of the host or the full name. + +\fIsalt\P is a pointer to the salt used for the host hashing, if the host is +provided hashed. If the host is provided in plain text, salt has no meaning. +The salt has to be provided base64 encoded with a trailing zero byte. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN, LIBSSH2_KNOWNHOST_TYPE_SHA1 or +LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +The key is using one of these algorithms: +LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or +LIBSSH2_KNOWNHOST_KEY_SSHDSS. + +\fIstore\fP should point to a pointer that gets filled in to point to the +known host data after the addition. NULL can be passed if you don't care about +this pointer. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2, deprecated since libssh2 1.2.5. Use +\fIlibssh2_knownhost_addc(3)\fP instead! +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_check(3) +.BR libssh2_knownhost_addc(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_addc.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_addc.3 new file mode 100644 index 0000000..73e262a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_addc.3 @@ -0,0 +1,68 @@ + +.\" Copyright (c) 2009, 2010 by Daniel Stenberg +.\" +.TH libssh2_knownhost_add 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_add - add a known host +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_addc(LIBSSH2_KNOWNHOSTS *hosts, + char *host, char *salt, + char *key, size_t keylen, + const char *comment, size_t commentlen, + int typemask, + struct libssh2_knownhost **store); +.SH DESCRIPTION +Adds a known host to the collection of known hosts identified by the 'hosts' +handle. + +\fIhost\fP is a pointer the host name in plain text or hashed. If hashed, it +must be provided base64 encoded. The host name can be the IP numerical address +of the host or the full name. + +If you want to add a key for a specific port number for the given host, you +must provide the host name like '[host]:port' with the actual characters '[' +and ']' enclosing the host name and a colon separating the host part from the +port number. For example: \&"[host.example.com]:222". + +\fIsalt\fP is a pointer to the salt used for the host hashing, if the host is +provided hashed. If the host is provided in plain text, salt has no meaning. +The salt has to be provided base64 encoded with a trailing zero byte. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fIcomment\fP is a pointer to a comment for the key. + +\fIcommentlen\fP is the total size in bytes of the comment pointed to by the \fIcomment\fP argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN, LIBSSH2_KNOWNHOST_TYPE_SHA1 or +LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +The key is using one of these algorithms: +LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or +LIBSSH2_KNOWNHOST_KEY_SSHDSS. + +\fIstore\fP should point to a pointer that gets filled in to point to the +known host data after the addition. NULL can be passed if you don't care about +this pointer. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2.5 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_check(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_check.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_check.3 new file mode 100644 index 0000000..889392c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_check.3 @@ -0,0 +1,58 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_check 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_check - check a host+key against the list of known hosts +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_check(LIBSSH2_KNOWNHOSTS *hosts, + const char *host, + const char *key, size_t keylen, + int typemask, + struct libssh2_knownhost **knownhost); +.SH DESCRIPTION +Checks a host and its associated key against the collection of known hosts, +and returns info back about the (partially) matched entry. + +\fIhost\fP is a pointer the host name in plain text. The host name can be the +IP numerical address of the host or the full name. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN or LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +\fIknownhost\fP if set to non-NULL, it must be a pointer to a 'struct +libssh2_knownhost' pointer that gets filled in to point to info about a known +host that matches or partially matches. +.SH RETURN VALUE +\fIlibssh2_knownhost_check(3)\fP returns info about how well the provided +host + key pair matched one of the entries in the list of known hosts. + +LIBSSH2_KNOWNHOST_CHECK_FAILURE - something prevented the check to be made + +LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found + +LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match. + +LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys didn't match! +.SH AVAILABILITY +Added in libssh2 1.2 +.SH EXAMPLE +See the ssh2_exec.c example as provided in the tarball. +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_checkp.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_checkp.3 new file mode 100644 index 0000000..434ed7b --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_checkp.3 @@ -0,0 +1,63 @@ +.\" +.\" Copyright (c) 2009-2010 by Daniel Stenberg +.\" +.TH libssh2_knownhost_check 3 "1 May 2010" "libssh2 1.2.6" "libssh2 manual" +.SH NAME +libssh2_knownhost_checkp - check a host+key against the list of known hosts +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_checkp(LIBSSH2_KNOWNHOSTS *hosts, + const char *host, int port, + const char *key, size_t keylen, + int typemask, + struct libssh2_knownhost **knownhost); +.SH DESCRIPTION +Checks a host and its associated key against the collection of known hosts, +and returns info back about the (partially) matched entry. + +\fIhost\fP is a pointer the host name in plain text. The host name can be the +IP numerical address of the host or the full name. + +\fIport\fP is the port number used by the host (or a negative number +to check the generic host). If the port number is given, libssh2 will +check the key for the specific host + port number combination in +addition to the plain host name only check. + +\fIkey\fP is a pointer to the key for the given host. + +\fIkeylen\fP is the total size in bytes of the key pointed to by the \fIkey\fP +argument + +\fItypemask\fP is a bitmask that specifies format and info about the data +passed to this function. Specifically, it details what format the host name is, +what format the key is and what key type it is. + +The host name is given as one of the following types: +LIBSSH2_KNOWNHOST_TYPE_PLAIN or LIBSSH2_KNOWNHOST_TYPE_CUSTOM. + +The key is encoded using one of the following encodings: +LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. + +\fIknownhost\fP if set to non-NULL, it must be a pointer to a 'struct +libssh2_knownhost' pointer that gets filled in to point to info about a known +host that matches or partially matches. +.SH RETURN VALUE +\fIlibssh2_knownhost_check(3)\fP returns info about how well the provided +host + key pair matched one of the entries in the list of known hosts. + +LIBSSH2_KNOWNHOST_CHECK_FAILURE - something prevented the check to be made + +LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found + +LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match. + +LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys didn't match! +.SH AVAILABILITY +Added in libssh2 1.2.6 +.SH EXAMPLE +See the ssh2_exec.c example as provided in the tarball. +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_del.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_del.3 new file mode 100644 index 0000000..75a8eaf --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_del.3 @@ -0,0 +1,26 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_del 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_del - delete a known host entry +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_del(LIBSSH2_KNOWNHOSTS *hosts, + struct libssh2_knownhost *entry); +.SH DESCRIPTION +Delete a known host entry from the collection of known hosts. + +\fIentry\fP is a pointer to a struct that you can extract with +\fIlibssh2_knownhost_check(3)\fP or \fIlibssh2_knownhost_get(3)\fP. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) +.BR libssh2_knownhost_check(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_free.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_free.3 new file mode 100644 index 0000000..8d8bcc2 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_free.3 @@ -0,0 +1,20 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_free 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_free - free a collection of known hosts +.SH SYNOPSIS +#include <libssh2.h> + +void libssh2_knownhost_free(LIBSSH2_KNOWNHOSTS *hosts); +.SH DESCRIPTION +Free a collection of known hosts. +.SH RETURN VALUE +None. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_add(3) +.BR libssh2_knownhost_check(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_get.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_get.3 new file mode 100644 index 0000000..d725f8d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_get.3 @@ -0,0 +1,35 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_get 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_get - get a known host off the collection of known hosts +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts, + struct libssh2_knownhost **store, + struct libssh2_knownhost *prev): +.SH DESCRIPTION +\fIlibssh2_knownhost_get(3)\fP allows an application to iterate over all known +hosts in the collection. + +\fIstore\fP should point to a pointer that gets filled in to point to the +known host data. + +\fIprev\fP is a pointer to a previous 'struct libssh2_knownhost' as returned +by a previous invoke of this function, or NULL to get the first entry in the +internal collection. +.SH RETURN VALUE +Returns 0 if everything is fine and information about a host was stored in +the \fIstore\fP struct. + +Returns 1 if it reached the end of hosts. + +Returns negative values for error +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_readfile(3) +.BR libssh2_knownhost_writefile(3) +.BR libssh2_knownhost_add(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_init.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_init.3 new file mode 100644 index 0000000..145f10c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_init.3 @@ -0,0 +1,25 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_init 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_init - init a collection of known hosts +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_KNOWNHOSTS *libssh2_knownhost_init(LIBSSH2_SESSION *session); +.SH DESCRIPTION +Init a collection of known hosts for this session. Returns the handle to an +internal representation of a known host collection. + +Call \fBlibssh2_knownhost_free(3)\fP to free the collection again after you're +doing using it. +.SH RETURN VALUE +Returns a handle pointer or NULL if something went wrong. The returned handle +is used as input to all other known host related functions libssh2 provides. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_add(3) +.BR libssh2_knownhost_check(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_readfile.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_readfile.3 new file mode 100644 index 0000000..68aa940 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_readfile.3 @@ -0,0 +1,29 @@ +.\" +.\" Copyright (c) 2009-2011 by Daniel Stenberg +.\" +.TH libssh2_knownhost_readfile 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_readfile - parse a file of known hosts +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts, + const char *filename, int type); +.SH DESCRIPTION +Reads a collection of known hosts from a specified file and adds them to the +collection of known hosts. + +\fIfilename\fP specifies which file to read + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. This file is normally found named ~/.ssh/known_hosts +.SH RETURN VALUE +Returns a negative value, a regular libssh2 error code for errors, or a +positive number as number of parsed known hosts in the file. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_free(3) +.BR libssh2_knownhost_check(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_readline.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_readline.3 new file mode 100644 index 0000000..a5881c4 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_readline.3 @@ -0,0 +1,30 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_readline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_readline - read a known host line +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts, + const char *line, size_t len, int type): +.SH DESCRIPTION +Tell libssh2 to read a buffer as it if is a line from a known hosts file. + +\fIline\fP points to the start of the line + +\fIlen\fP is the length of the line in bytes + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. This file is normally found named ~/.ssh/known_hosts +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_get(3) +.BR libssh2_knownhost_writeline(3) +.BR libssh2_knownhost_readfile(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_writefile.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_writefile.3 new file mode 100644 index 0000000..48335a0 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_writefile.3 @@ -0,0 +1,29 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_writefile 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_writefile - write a collection of known hosts to a file +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_knownhost_writefile(LIBSSH2_KNOWNHOSTS *hosts, + const char *filename, int type); +.SH DESCRIPTION +Writes all the known hosts to the specified file using the specified file +format. + +\fIfilename\fP specifies what filename to create + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_readfile(3) +.BR libssh2_knownhost_add(3) + diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_writeline.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_writeline.3 new file mode 100644 index 0000000..c014a6a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_knownhost_writeline.3 @@ -0,0 +1,46 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_writeline - convert a known host to a line for storage +.SH SYNOPSIS +#include <libssh2.h> + +libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts, + struct libssh2_knownhost *known, + char *buffer, size_t buflen, + size_t *outlen, + int type); +.SH DESCRIPTION +Converts a single known host to a single line of output for storage, using +the 'type' output format. + +\fIknown\fP identifies which particular known host + +\fIbuffer\fP points to an allocated buffer + +\fIbuflen\fP is the size of the \fIbuffer\fP. See RETURN VALUE about the size. + +\fIoutlen\fP must be a pointer to a size_t variable that will get the output +length of the stored data chunk. The number does not included the trailing +zero! + +\fItype\fP specifies what file type it is, and +\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported +format. +.SH RETURN VALUE +Returns a regular libssh2 error code, where negative values are error codes +and 0 indicates success. + +If the provided buffer is deemed too small to fit the data libssh2 wants to +store in it, LIBSSH2_ERROR_BUFFER_TOO_SMALL will be returned. The application +is then advised to call the function again with a larger buffer. The +\fIoutlen\fP size will then hold the requested size. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_get(3) +.BR libssh2_knownhost_readline(3) +.BR libssh2_knownhost_writefile(3) + diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_poll.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_poll.3 new file mode 100644 index 0000000..6656945 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_poll.3 @@ -0,0 +1,21 @@ +.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_poll - poll for activity on a socket, channel or listener +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout); +.SH DESCRIPTION +This function is deprecated. Do note use. We encourage users to instead use +the \fIpoll(3)\fP or \fIselect(3)\fP functions to check for socket activity or +when specific sockets are ready to get received from or send to. + +Poll for activity on a socket, channel, listener, or any combination of these +three types. The calling semantics for this function generally match +\fIpoll(2)\fP however the structure of fds is somewhat more complex in order +to accommodate the disparate datatypes, POLLFD constants have been namespaced +to avoid platform discrepancies, and revents has additional values defined. +.SH "RETURN VALUE" +Number of fds with interesting events. +.SH SEE ALSO +.BR libssh2_poll_channel_read(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_poll_channel_read.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_poll_channel_read.3 new file mode 100644 index 0000000..207275b --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_poll_channel_read.3 @@ -0,0 +1,18 @@ +.TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_poll_channel_read - check if data is available +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended); +.SH DESCRIPTION +This function is deprecated. Do note use. + +\fIlibssh2_poll_channel_read(3)\fP checks to see if data is available in the +\fIchannel\fP's read buffer. No attempt is made with this method to see if +packets are available to be processed. For full polling support, use +\fIlibssh2_poll(3)\fP. +.SH RETURN VALUE +Returns 1 when data is available and 0 otherwise. +.SH SEE ALSO +.BR libssh2_poll(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_add.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_add.3 new file mode 100644 index 0000000..666cd94 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_add.3 @@ -0,0 +1,20 @@ +.TH libssh2_publickey_add 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_publickey_add - convenience macro for \fIlibssh2_publickey_add_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey, + const unsigned char *name, + const unsigned char *blob, unsigned long blob_len, char overwrite, + unsigned long num_attrs, const libssh2_publickey_attribute attrs[]); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_publickey_add_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_publickey_add_ex(3)\fP +.SH ERRORS +See \fIlibssh2_publickey_add_ex(3)\fP +.SH SEE ALSO +.BR libssh2_publickey_add_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_add_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_add_ex.3 new file mode 100644 index 0000000..5c01d23 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_add_ex.3 @@ -0,0 +1,25 @@ +.TH libssh2_publickey_add_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_publickey_add_ex - Add a public key entry +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, + unsigned long name_len, const unsigned char *blob, + unsigned long blob_len, char overwrite, + unsigned long num_attrs, + const libssh2_publickey_attribute attrs[]) + +.SH DESCRIPTION +TBD +.SH RETURN VALUE +Returns 0 on success, negative on failure. +.SH ERRORS +LIBSSH2_ERROR_BAD_USE +LIBSSH2_ERROR_ALLOC, +LIBSSH2_ERROR_EAGAIN +LIBSSH2_ERROR_SOCKET_SEND, +LIBSSH2_ERROR_SOCKET_TIMEOUT, +LIBSSH2_ERROR_PUBLICKEY_PROTOCOL, +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_init.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_init.3 new file mode 100644 index 0000000..448eb71 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_init.3 @@ -0,0 +1,12 @@ +.TH libssh2_publickey_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_publickey_init - TODO +.SH SYNOPSIS + +.SH DESCRIPTION + +.SH RETURN VALUE + +.SH ERRORS + +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_list_fetch.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_list_fetch.3 new file mode 100644 index 0000000..07a7024 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_list_fetch.3 @@ -0,0 +1,12 @@ +.TH libssh2_publickey_list_fetch 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_publickey_list_fetch - TODO +.SH SYNOPSIS + +.SH DESCRIPTION + +.SH RETURN VALUE + +.SH ERRORS + +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_list_free.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_list_free.3 new file mode 100644 index 0000000..d50e935 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_list_free.3 @@ -0,0 +1,12 @@ +.TH libssh2_publickey_list_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_publickey_list_free - TODO +.SH SYNOPSIS + +.SH DESCRIPTION + +.SH RETURN VALUE + +.SH ERRORS + +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_remove.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_remove.3 new file mode 100644 index 0000000..874fdbe --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_remove.3 @@ -0,0 +1,19 @@ +.TH libssh2_publickey_remove 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_publickey_remove - convenience macro for \fIlibssh2_publickey_remove_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey, + const unsigned char *name, unsigned long name_len, + const unsigned char *blob, unsigned long blob_len); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_publickey_remove_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_publickey_remove_ex(3)\fP +.SH ERRORS +See \fIlibssh2_publickey_remove_ex(3)\fP +.SH SEE ALSO +.BR libssh2_publickey_remove_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_remove_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_remove_ex.3 new file mode 100644 index 0000000..a6cba50 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_remove_ex.3 @@ -0,0 +1,12 @@ +.TH libssh2_publickey_list_remove_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_publickey_list_remove_ex - TODO +.SH SYNOPSIS + +.SH DESCRIPTION + +.SH RETURN VALUE + +.SH ERRORS + +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_shutdown.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_shutdown.3 new file mode 100644 index 0000000..fe67a76 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_publickey_shutdown.3 @@ -0,0 +1,12 @@ +.TH libssh2_publickey_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_publickey_shutdown - TODO +.SH SYNOPSIS + +.SH DESCRIPTION + +.SH RETURN VALUE + +.SH ERRORS + +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_recv.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_recv.3 new file mode 100644 index 0000000..669d7e1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_recv.3 @@ -0,0 +1,32 @@ +.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.h> + +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_ex(3) + +\fIpath\fP - Full path and filename of file to transfer. That is the remote +file name. + +\fIsb\fP - Populated with remote file's size, mode, mtime, and atime + +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. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) +.BR libssh2_channel_open_ex(3) + diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send.3 new file mode 100644 index 0000000..5e29347 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send.3 @@ -0,0 +1,18 @@ +.TH libssh2_scp_send 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_scp_send - convenience macro for \fIlibssh2_scp_send_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, int mode, size_t size); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_scp_send_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_scp_send_ex(3)\fP +.SH ERRORS +See \fIlibssh2_scp_send_ex(3)\fP +.SH SEE ALSO +.BR libssh2_scp_send_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send64.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send64.3 new file mode 100644 index 0000000..98d7e74 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send64.3 @@ -0,0 +1,47 @@ +.TH libssh2_scp_send64 3 "17 Apr 2010" "libssh2 1.2.6" "libssh2 manual" +.SH NAME +libssh2_scp_send64 - Send a file via SCP +.SH SYNOPSIS +.nf +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode, + libssh2_uint64_t size, time_t mtime, time_t atime); +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIpath\fP - Full path and filename of file to transfer to. That is the remote +file name. + +\fImode\fP - File access mode to create file with + +\fIsize\fP - Size of file being transmitted (Must be known ahead of +time). Note that this needs to be passed on as variable type +libssh2_uint64_t. This type is 64 bit on modern operating systems and +compilers. + +\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. +.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 AVAILABILITY +This function was added in libssh2 1.2.6 and is meant to replace the former +\fIlibssh2_scp_send_ex(3)\fP function. +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send_ex.3 new file mode 100644 index 0000000..8de7083 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_scp_send_ex.3 @@ -0,0 +1,48 @@ +.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 +.nf +#include <libssh2.h> + +LIBSSH2_CHANNEL * +libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, + size_t size, long mtime, long atime); +.SH DESCRIPTION +This function has been deemed deprecated since libssh2 1.2.6. See +\fIlibssh2_scp_send64(3)\fP. + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIpath\fP - Full path and filename of file to transfer to. That is the remote +file name. + +\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. +.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 AVAILABILITY +This function was marked deprecated in libssh2 1.2.6 as + \fIlibssh2_scp_send64(3)\fP has been introduced to replace this function. +.SH SEE ALSO +.BR libssh2_channel_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_abstract.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_abstract.3 new file mode 100644 index 0000000..d880b09 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_abstract.3 @@ -0,0 +1,24 @@ +.TH libssh2_session_abstract 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_abstract - return a pointer to a session's abstract pointer +.SH SYNOPSIS +#include <libssh2.h> + +void ** +libssh2_session_abstract(LIBSSH2_SESSION *session); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +Return a pointer to where the abstract pointer provided to +\fBlibssh2_session_init_ex(3)\fP is stored. By providing a doubly +de-referenced pointer, the internal storage of the session instance may be +modified in place. + +.SH RETURN VALUE +A pointer to session internal storage who's contents point to previously +provided abstract data. + +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_banner_get.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_banner_get.3 new file mode 100644 index 0000000..e253aa1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_banner_get.3 @@ -0,0 +1,21 @@ +.TH libssh2_session_banner_get 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual" +.SH NAME +libssh2_session_banner_get - get the remote banner +.SH SYNOPSIS +#include <libssh2.h> + +const char *libssh2_session_banner_get(oLIBSSH2_SESSION *session); +.SH DESCRIPTION +Once the session has been setup and \fIlibssh2_session_handshake(3)\fP has +completed successfully, this function can be used to get the server id from +the banner each server presents. +.SH RETURN VALUE +A pointer to a string or NULL if something failed. The data pointed to will be +allocated and associated to the session handle and will be freed by libssh2 +when \fIlibssh2_session_free(3)\fP is used. +.SH AVAILABILITY +Added in 1.4.0 +.SH SEE ALSO +.BR libssh2_session_banner_set(3), +.BR libssh2_session_handshake(3), +.BR libssh2_session_free(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_banner_set.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_banner_set.3 new file mode 100644 index 0000000..5e4161e --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_banner_set.3 @@ -0,0 +1,32 @@ +.TH libssh2_session_banner_set 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual" +.SH NAME +libssh2_session_banner_set - set the SSH protocol banner for the local client +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIbanner\fP - A pointer to a zero-terminated string holding the user defined +banner + +Set the banner that will be sent to the remote host when the SSH session is +started with \fIlibssh2_session_handshake(3)\fP This is optional; a banner +corresponding to the protocol and libssh2 version will be sent by default. +.SH RETURN VALUE +Returns 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. +.SH AVAILABILITY +Added in 1.4.0. + +Before 1.4.0 this function was known as libssh2_banner_set(3) +.SH SEE ALSO +.BR libssh2_session_handshake(3), +.BR libssh2_session_banner_get(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_block_directions.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_block_directions.3 new file mode 100644 index 0000000..48ffca3 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_block_directions.3 @@ -0,0 +1,29 @@ +.TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2 1.0" "libssh2 manual" +.SH NAME +libssh2_session_block_directions - get directions to wait for +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_block_directions(LIBSSH2_SESSION *session); +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by \fBlibssh2_session_init_ex(3)\fP + +When any of libssh2 functions return \fBLIBSSH2_ERROR_EAGAIN\fP an application +should wait for the socket to have data available for reading or +writing. Depending on the return value of +\fIlibssh2_session_block_directions(3)\fP an application should wait for read, +write or both. +.SH RETURN VALUE +Returns the set of directions as a binary mask. Can be a combination of: + +LIBSSH2_SESSION_BLOCK_INBOUND: Inbound direction blocked. + +LIBSSH2_SESSION_BLOCK_OUTBOUND: Outbound direction blocked. + +Application should wait for data to be available for socket prior to calling a +libssh2 function again. If \fBLIBSSH2_SESSION_BLOCK_INBOUND\fP is set select +should contain the session socket in readfds set. Correspondingly in case of +\fBLIBSSH2_SESSION_BLOCK_OUTBOUND\fP writefds set should contain the socket. +.SH AVAILABILITY +Added in 1.0 diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_callback_set.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_callback_set.3 new file mode 100644 index 0000000..3901f88 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_callback_set.3 @@ -0,0 +1,44 @@ +.TH libssh2_session_callback_set 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_callback_set - set a callback function +.SH SYNOPSIS +.nf +#include <libssh2.h> + +void *libssh2_session_callback_set(LIBSSH2_SESSION *session, + int cbtype, void *callback); +.SH DESCRIPTION +Sets a custom callback handler for a previously initialized session +object. Callbacks are triggered by the receipt of special packets at the +Transport layer. To disable a callback, set it to NULL. + +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIcbtype\fP - Callback type. One of the types listed in Callback Types. + +\fIcallback\fP - Pointer to custom callback function. The prototype for +this function must match the associated callback declaration macro. +.SH CALLBACK TYPES +.IP LIBSSH2_CALLBACK_IGNORE +Called when a SSH_MSG_IGNORE message is received +.IP LIBSSH2_CALLBACK_DEBUG +Called when a SSH_MSG_DEBUG message is received +.IP LIBSSH2_CALLBACK_DISCONNECT +Called when a SSH_MSG_DISCONNECT message is received +.IP LIBSSH2_CALLBACK_MACERROR +Called when a mismatched MAC has been detected in the transport layer. If the +function returns 0, the packet will be accepted nonetheless. +.IP LIBSSH2_CALLBACK_X11 +Called when an X11 connection has been accepted +.IP LIBSSH2_CALLBACK_SEND +Called when libssh2 wants to send some data on the connection. +Can be set to a custom function to handle I/O your own way. +.IP LIBSSH2_CALLBACK_RECV +Called when libssh2 wants to receive some data from the connection. +Can be set to a custom function to handle I/O your own way. +.SH RETURN VALUE +Pointer to previous callback handler. Returns NULL if no prior callback +handler was set or the callback type was unknown. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_disconnect.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_disconnect.3 new file mode 100644 index 0000000..32d5e87 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_disconnect.3 @@ -0,0 +1,17 @@ +.TH libssh2_session_disconnect 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_session_disconnect - convenience macro for \fIlibssh2_session_disconnect_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_session_disconnect_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_session_disconnect_ex(3)\fP +.SH ERRORS +See \fIlibssh2_session_disconnect_ex(3)\fP +.SH SEE ALSO +.BR libssh2_session_disconnect_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_disconnect_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_disconnect_ex.3 new file mode 100644 index 0000000..82174f9 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_disconnect_ex.3 @@ -0,0 +1,38 @@ +.TH libssh2_session_disconnect_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_disconnect_ex - terminate transport layer +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, const char *description, const char *lang); + +int +libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIreason\fP - One of the Disconnect Reason constants. + +\fIdescription\fP - Human readable reason for disconnection. + +\fIlang\fP - Localization string describing the language/encoding of the description provided. + +Send a disconnect message to the remote host associated with \fIsession\fP, +along with a \fIreason\fP symbol and a verbose \fIdescription\fP. + +As a convenience, the macro +.BR libssh2_session_disconnect(3) +is provided. It calls +.BR libssh2_session_disconnect_ex(3) +with \fIreason\fP set to SSH_DISCONNECT_BY_APPLICATION +and \fIlang\fP set to an empty string. + +.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_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_flag.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_flag.3 new file mode 100644 index 0000000..3a9e5e5 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_flag.3 @@ -0,0 +1,23 @@ +.TH libssh2_session_flag 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_flag - TODO +.SH SYNOPSIS +int +libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value); +.SH DESCRIPTION +Set options for the created session. \fIflag\fP is the option to set, while +\fIvalue\fP is typically set to 1 or 0 to enable or disable the option. +.SH FLAGS +.IP LIBSSH2_FLAG_SIGPIPE +If set, libssh2 will not attempt to block SIGPIPEs but will let them trigger +from the underlying socket layer. +.IP LIBSSH2_FLAG_COMPRESS +If set - before the connection negotiation is performed - libssh2 will try to +negotiate compression enabling for this connection. By default libssh2 will +not attempt to use compression. +.SH RETURN VALUE +Returns regular libssh2 error code. +.SH AVAILABILITY +This function has existed since the age of dawn. LIBSSH2_FLAG_COMPRESS was +added in version 1.2.8. +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_free.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_free.3 new file mode 100644 index 0000000..96eff0c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_free.3 @@ -0,0 +1,18 @@ +.TH libssh2_session_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_free - frees resources associated with a session instance +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_free(LIBSSH2_SESSION *session); +.SH DESCRIPTION +Frees all resources associated with a session instance. Typically called after +.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_ex(3) +.BR libssh2_session_disconnect_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_get_blocking.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_get_blocking.3 new file mode 100644 index 0000000..8d98fa3 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_get_blocking.3 @@ -0,0 +1,12 @@ +.TH libssh2_session_get_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_get_blocking - TODO +.SH SYNOPSIS +int libssh2_session_get_blocking(LIBSSH2_SESSION *session); +.SH DESCRIPTION +Returns 0 if the state of the session has previously be set to non-blocking +and it returns 1 if the state was set to blocking. +.SH RETURN VALUE +See description. +.SH SEE ALSO +.BR libssh2_session_set_blocking(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_get_timeout.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_get_timeout.3 new file mode 100644 index 0000000..94aacd6 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_get_timeout.3 @@ -0,0 +1,19 @@ +.TH libssh2_session_get_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual" +.SH NAME +libssh2_session_get_timeout - get the timeout for blocking functions +.SH SYNOPSIS +#include <libssh2.h> +.nf +long libssh2_session_get_timeout(LIBSSH2_SESSION *session); +.SH DESCRIPTION +Returns the \fBtimeout\fP (in milliseconds) for how long a blocking the +libssh2 function calls may wait until they consider the situation an error and +return LIBSSH2_ERROR_TIMEOUT. + +By default libssh2 has no timeout (zero) for blocking functions. +.SH RETURN VALUE +The value of the timeout setting. +.SH AVAILABILITY +Added in 1.2.9 +.SH SEE ALSO +.BR libssh2_session_set_timeout(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_handshake.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_handshake.3 new file mode 100644 index 0000000..33908c6 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_handshake.3 @@ -0,0 +1,40 @@ +.TH libssh2_session_handshake 3 "7 Oct 2010" "libssh2 1.2.8" "libssh2 manual" +.SH NAME +libssh2_session_handshake - perform the SSH handshake +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_handshake(LIBSSH2_SESSION *session, libssh2_socket_t socket); +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.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 +attempt to use any berkeley socket. + +Begin transport layer protocol negotiation with the connected host. +.SH RETURN VALUE +Returns 0 on success, negative on failure. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid. + +\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host. + +\fILIBSSH2_ERROR_KEX_FAILURE\fP - >Encryption key exchange with the remote +host failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected. + +\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on +the socket. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. +.SH AVAILABILITY +Added in 1.2.8 +.SH SEE ALSO +.BR libssh2_session_free(3) +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_hostkey.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_hostkey.3 new file mode 100644 index 0000000..5d04440 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_hostkey.3 @@ -0,0 +1,21 @@ +.TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_hostkey - get the remote key +.SH SYNOPSIS +#include <libssh2.h> + +const char *libssh2_session_hostkey(LIBSSH2_SESSION *session, + size_t *len, int *type); +.SH DESCRIPTION +Returns a pointer to the current host key, the value \fIlen\fP points to will +get the length of the key. + +The value \fItype\fP points to the type of hostkey which is one of: +LIBSSH2_HOSTKEY_TYPE_RSA, LIBSSH2_HOSTKEY_TYPE_DSS, or +LIBSSH2_HOSTKEY_TYPE_UNKNOWN. + +.SH RETURN VALUE +A pointer, or NULL if something went wrong. +.SH SEE ALSO +.BR libssh2_knownhost_check(3) +.BR libssh2_knownhost_add(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_init.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_init.3 new file mode 100644 index 0000000..476a3b4 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_init.3 @@ -0,0 +1,18 @@ +.TH libssh2_session_init 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_session_init - convenience macro for \fIlibssh2_session_init_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_SESSION * +libssh2_session_init(void); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_session_init_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_session_init_ex(3)\fP +.SH ERRORS +See \fIlibssh2_session_init_ex(3)\fP +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_init_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_init_ex.3 new file mode 100644 index 0000000..5e4ef06 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_init_ex.3 @@ -0,0 +1,42 @@ +.TH libssh2_session_init_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_init_ex - initializes an SSH session object +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_SESSION * +libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myalloc)), LIBSSH2_FREE_FUNC((*myfree)), LIBSSH2_REALLOC_FUNC((*myrealloc)), void *abstract); + +LIBSSH2_SESSION * +libssh2_session_init(void); + +.SH DESCRIPTION +\fImyalloc\fP - Custom allocator function. Refer to the section on Callbacks +for implementing an allocator callback. Pass a value of NULL to use the +default system allocator. + +\fImyfree\fP - Custom de-allocator function. Refer to the section on Callbacks +for implementing a deallocator callback. Pass a value of NULL to use the +default system deallocator. + +\fImyrealloc\fP - Custom re-allocator function. Refer to the section on +Callbacks for implementing a reallocator callback. Pass a value of NULL to +use the default system reallocator. + +\fIabstract\fP - Arbitrary pointer to application specific callback data. +This value will be passed to any callback function associated with the named +session instance. + +Initializes an SSH session object. By default system memory allocators +(malloc(), free(), realloc()) will be used for any dynamically allocated memory +blocks. Alternate memory allocation functions may be specified using the +extended version of this API call, and/or optional application specific data +may be attached to the session object. + +This method must be called first, prior to configuring session options or +starting up an SSH session with a remote server. +.SH RETURN VALUE +Pointer to a newly allocated LIBSSH2_SESSION instance, or NULL on errors. +.SH SEE ALSO +.BR libssh2_session_free(3) +.BR libssh2_session_handshake(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_last_errno.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_last_errno.3 new file mode 100644 index 0000000..fb395ef --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_last_errno.3 @@ -0,0 +1,20 @@ +.TH libssh2_session_last_errno 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_last_errno - get the most recent error number +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_last_errno(LIBSSH2_SESSION *session); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +Determine the most recent error condition. + +.SH RETURN VALUE +Numeric error code corresponding to the the Error Code constants. + +.SH SEE ALSO +.BR libssh2_session_last_error(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_last_error.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_last_error.3 new file mode 100644 index 0000000..91663a0 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_last_error.3 @@ -0,0 +1,31 @@ +.TH libssh2_session_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_last_error - get the most recent error +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_last_error(LIBSSH2_SESSION *session, char **errmsg, int *errmsg_len, int want_buf); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIerrmsg\fP - If not NULL, is populated by reference with the human +readable form of the most recent error message. + +\fIerrmsg_len\fP - If not NULL, is populated by reference with the length +of errmsg. (The string is NUL-terminated, so the length is only useful as +an optimization, to avoid calling strlen.) + +\fIwant_buf\fP - If set to a non-zero value, "ownership" of the errmsg +buffer will be given to the calling scope. If necessary, the errmsg buffer +will be duplicated. + +Determine the most recent error condition and its cause. + +.SH RETURN VALUE +Numeric error code corresponding to the the Error Code constants. + +.SH SEE ALSO +.BR libssh2_session_last_errno(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_method_pref.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_method_pref.3 new file mode 100644 index 0000000..dcf77f6 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_method_pref.3 @@ -0,0 +1,40 @@ +.TH libssh2_session_method_pref 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_method_pref - set preferred key exchange method +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_method_pref(LIBSSH2_SESSION *session, int method_type, const char *prefs); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fImethod_type\fP - One of the Method Type constants. + +\fIprefs\fP - Coma delimited list of preferred methods to use with +the most preferred listed first and the least preferred listed last. +If a method is listed which is not supported by libssh2 it will be +ignored and not sent to the remote host during protocol negotiation. + +Set preferred methods to be negotiated. These +preferences must be set prior to calling +.BR libssh2_session_handshake(3) +as they are used during the protocol initiation phase. + +.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_INVAL\fP - The requested method type was invalid. + +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - The requested method is not supported. + +.SH SEE ALSO +.BR libssh2_session_init_ex(3) +.BR libssh2_session_handshake(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_methods.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_methods.3 new file mode 100644 index 0000000..cc4f6d4 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_methods.3 @@ -0,0 +1,27 @@ +.TH libssh2_session_methods 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_methods - return the currently active algorithms +.SH SYNOPSIS +#include <libssh2.h> + +const char * +libssh2_session_methods(LIBSSH2_SESSION *session, int method_type); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fImethod_type\fP - one of the method type constants: LIBSSH2_METHOD_KEX, +LIBSSH2_METHOD_HOSTKEY, LIBSSH2_METHOD_CRYPT_CS, LIBSSH2_METHOD_CRYPT_SC, +LIBSSH2_METHOD_MAC_CS, LIBSSH2_METHOD_MAC_SC, LIBSSH2_METHOD_COMP_CS, +LIBSSH2_METHOD_COMP_SC, LIBSSH2_METHOD_LANG_CS, LIBSSH2_METHOD_LANG_SC. + +Returns the actual method negotiated for a particular transport parameter. +.SH RETURN VALUE +Negotiated method or NULL if the session has not yet been started. +.SH ERRORS +\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid. + +\fILIBSSH2_ERROR_METHOD_NONE\fP - no method has been set +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_set_blocking.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_set_blocking.3 new file mode 100644 index 0000000..b16e009 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_set_blocking.3 @@ -0,0 +1,30 @@ +.TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_set_blocking - set or clear blocking mode on session +.SH SYNOPSIS +#include <libssh2.h> + +void +libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking); + +.SH DESCRIPTION +\fIsession\fP - session instance as returned by +.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. + +Set or clear blocking mode on the selected on the session. This will +instantly affect any channels associated with this session. If a read is +performed on a session with no data currently available, a blocking session +will wait for data to arrive and return what it receives. A non-blocking +session will return immediately with an empty buffer. If a write is performed +on a session with no room for more data, a blocking session will wait for +room. A non-blocking session will return immediately without writing +anything. + +.SH RETURN VALUE +None + +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_set_timeout.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_set_timeout.3 new file mode 100644 index 0000000..2d4f10f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_set_timeout.3 @@ -0,0 +1,20 @@ +.TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual" +.SH NAME +libssh2_session_set_timeout - set timeout for blocking functions +.SH SYNOPSIS +#include <libssh2.h> +.nf +void libssh2_session_set_timeout(LIBSSH2_SESSION *session, long timeout); +.SH DESCRIPTION +Set the \fBtimeout\fP in milliseconds for how long a blocking the libssh2 +function calls may wait until they consider the situation an error and return +LIBSSH2_ERROR_TIMEOUT. + +By default or if you set the timeout to zero, libssh2 has no timeout for +blocking functions. +.SH RETURN VALUE +Nothing +.SH AVAILABILITY +Added in 1.2.9 +.SH SEE ALSO +.BR libssh2_session_get_timeout(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_startup.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_startup.3 new file mode 100644 index 0000000..b59056f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_startup.3 @@ -0,0 +1,42 @@ +.TH libssh2_session_startup 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_session_startup - begin transport layer +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_session_startup(LIBSSH2_SESSION *session, int socket); +.SH DESCRIPTION +Starting in libssh2 version 1.2.8 this function is considered deprecated. Use +\fIlibssh2_session_handshake(3)\fP instead. + +\fIsession\fP - Session instance as returned by +.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 +attempt to use any berkeley socket. + +Begin transport layer protocol negotiation with the connected host. +.SH RETURN VALUE +Returns 0 on success, negative on failure. +.SH ERRORS +\fILIBSSH2_ERROR_SOCKET_NONE\fP - The socket is invalid. + +\fILIBSSH2_ERROR_BANNER_SEND\fP - Unable to send banner to remote host. + +\fILIBSSH2_ERROR_KEX_FAILURE\fP - >Encryption key exchange with the remote +host failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_SOCKET_DISCONNECT\fP - The socket was disconnected. + +\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on +the socket. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. + +.SH SEE ALSO +.BR libssh2_session_free(3) +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_supported_algs.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_supported_algs.3 new file mode 100644 index 0000000..e8568f2 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_session_supported_algs.3 @@ -0,0 +1,74 @@ +.TH libssh2_session_supported_algs 3 "23 Oct 2011" "libssh2 1.4.0" "libssh2 manual" +.SH NAME +libssh2_session_supported_algs - get list of supported algorithms +.SH SYNOPSIS +.nf +#include <libssh2.h> + +int libssh2_session_supported_algs(LIBSSH2_SESSION* session, + int method_type, + const char*** algs); +.SH DESCRIPTION +\fIsession\fP - An instance of initialized LIBSSH2_SESSION (the function will +use its pointer to the memory allocation function). \fImethod_type\fP - Method +type. See .BR \fIlibssh2_session_method_pref(3)\fP. \fIalgs\fP - Address of a +pointer that will point to an array of returned algorithms + +Get a list of supported algorithms for the given \fImethod_type\fP. The +method_type parameter is equivalent to method_type in +\fIlibssh2_session_method_pref(3)\fP. If successful, the function will +allocate the appropriate amount of memory. When not needed anymore, it must be +deallocated by calling \fIlibssh2_free(3)\fP. When this function is +unsuccessful, this must not be done. + +In order to get a list of all supported compression algorithms, +libssh2_session_flag(session, LIBSSH2_FLAG_COMPRESS, 1) must be called before +calling this function, otherwise only "none" will be returned. + +If successful, the function will allocate and fill the array with supported +algorithms (the same names as defined in RFC 4253). The array is not NULL +terminated. +.SH EXAMPLE +.nf +#include "libssh2.h" + +const char **algorithms; +int rc, i; +LIBSSH2_SESSION *session; + +/* initialize session */ +session = libssh2_session_init(); +rc = libssh2_session_supported_algs(session, + LIBSSH2_METHOD_CRYPT_CS, + &algorithms); +if (rc>0) { + /* the call succeeded, do sth. with the list of algorithms + (e.g. list them)... */ + printf("Supported symmetric algorithms:\n"); + for ( i=0; i<rc; i++ ) + printf("\t%s\n", algorithms[i]); + + /* ... and free the allocated memory when not needed anymore */ + libssh2_free(session, algorithms); +} +else { + /* call failed, error handling */ +} +.SH RETURN VALUE +On success, a number of returned algorithms (i.e a positive number will be +returned). In case of a failure, an error code (a negative number, see below) +is returned. 0 should never be returned. +.SH ERRORS +\fILIBSSH2_ERROR_BAD_USE\fP - Invalid address of algs. + +\fILIBSSH2_ERROR_METHOD_NOT_SUPPORTED\fP - Unknown method type. + +\fILIBSSH2_ERROR_INVAL\fP - Internal error (normally should not occur). + +\fILIBSSH2_ERROR_ALLOC\fP - Allocation of memory failed. +.SH AVAILABILITY +Added in 1.4.0 +.SH SEE ALSO +.BR libssh2_session_methods(3), +.BR libssh2_session_method_pref(3) +.BR libssh2_free(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_close.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_close.3 new file mode 100644 index 0000000..b169b1b --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_close.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_close 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_close - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_close_handle(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_close_handle(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_close_handle(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_close_handle(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_close_handle.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_close_handle.3 new file mode 100644 index 0000000..30e299c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_close_handle.3 @@ -0,0 +1,43 @@ +.TH libssh2_sftp_close_handle 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_close_handle - close filehandle +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle); + +int +libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle); + +int +libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle); + +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP +or \fBlibssh2_sftp_opendir(3)\fP (which is a macro). + +Close an active LIBSSH2_SFTP_HANDLE. Because files and directories share the +same underlying storage mechanism these methods may be used +interchangeably. \fBlibssh2_sftp_close(3)\fP and \fBlibssh2_sftp_closedir(3)\fP +are macros for \fBlibssh2_sftp_close_handle(3)\fP. + +.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_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 returned by the server. + +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_closedir.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_closedir.3 new file mode 100644 index 0000000..3e032a7 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_closedir.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_closedir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_closedir - convenience macro for \fIlibssh2_sftp_close_handle(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle) + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_close_handle(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_close_handle(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_close_handle(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_close_handle(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fsetstat.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fsetstat.3 new file mode 100644 index 0000000..e77dd21 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fsetstat.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_fsetstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_fsetstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_fsetstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_fstat_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstat.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstat.3 new file mode 100644 index 0000000..66116a3 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstat.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_fstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_fstat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_fstat(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_ATTRIBUTES *attrs); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_fstat_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstat_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstat_ex.3 new file mode 100644 index 0000000..107594c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstat_ex.3 @@ -0,0 +1,104 @@ +.TH libssh2_sftp_fstat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_fstat_ex - get or set attributes on an SFTP file handle +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_fstat_ex(LIBSSH2_SFTP_HANDLE *handle, + LIBSSH2_SFTP_ATTRIBUTES *attrs, int setstat) + +#define libssh2_sftp_fstat(handle, attrs) \\ + libssh2_sftp_fstat_ex((handle), (attrs), 0) +#define libssh2_sftp_fsetstat(handle, attrs) \\ + libssh2_sftp_fstat_ex((handle), (attrs), 1) +.fi +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIattrs\fP - Pointer to an LIBSSH2_SFTP_ATTRIBUTES structure to set file +metadata from or into depending on the value of setstat. + +\fIsetstat\fP - When non-zero, the file's metadata will be updated +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 DATA TYPES +LIBSSH2_SFTP_ATTRIBUTES is a typedefed struct that is defined as below + +.nf +struct _LIBSSH2_SFTP_ATTRIBUTES { + + /* If flags & ATTR_* bit is set, then the value in this + * struct will be meaningful Otherwise it should be ignored + */ + unsigned long flags; + + /* size of file, in bytes */ + libssh2_uint64_t filesize; + + /* numerical representation of the user and group owner of + * the file + */ + unsigned long uid, gid; + + /* bitmask of permissions */ + unsigned long permissions; + + /* access time and modified time of file */ + unsigned long atime, mtime; +}; +.fi + +You will find a full set of defines and macros to identify flags and +permissions on the \fBlibssh2_sftp.h\fP header file, but some of the +most common ones are: + +To check for specific user permissions, the set of defines are in the +pattern LIBSSH2_SFTP_S_I<action><who> where <action> is R, W or X for +read, write and executable and <who> is USR, GRP and OTH for user, +group and other. So, you check for a user readable file, use the bit +\fILIBSSH2_SFTP_S_IRUSR\fP while you want to see if it is executable +for other, you use \fILIBSSH2_SFTP_S_IXOTH\fP and so on. + +To check for specific file types, you would previously (before libssh2 +1.2.5) use the standard posix S_IS***() macros, but since 1.2.5 +libssh2 offers its own set of macros for this functionality: +.IP LIBSSH2_SFTP_S_ISLNK +Test for a symbolic link +.IP LIBSSH2_SFTP_S_ISREG +Test for a regular file +.IP LIBSSH2_SFTP_S_ISDIR +Test for a directory +.IP LIBSSH2_SFTP_S_ISCHR +Test for a character special file +.IP LIBSSH2_SFTP_S_ISBLK +Test for a block special file +.IP LIBSSH2_SFTP_S_ISFIFO +Test for a pipe or FIFO special file +.IP LIBSSH2_SFTP_S_ISSOCK +Test for a socket +.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_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 returned by the server. +.SH AVAILABILITY +This function has been around since forever, but most of the +LIBSSH2_SFTP_S_* defines were introduced in libssh2 0.14 and the +LIBSSH2_SFTP_S_IS***() macros were introduced in libssh2 1.2.5. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstatvfs.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstatvfs.3 new file mode 100644 index 0000000..934d2a1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fstatvfs.3 @@ -0,0 +1 @@ +.so man3/libssh2_sftp_statvfs.3 diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fsync.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fsync.3 new file mode 100644 index 0000000..646760a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_fsync.3 @@ -0,0 +1,39 @@ +.TH libssh2_sftp_fsync 3 "8 Apr 2013" "libssh2 1.4.4" "libssh2 manual" +.SH NAME +libssh2_sftp_fsync - synchronize file to disk +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_fsync(LIBSSH2_SFTP_HANDLE *handle) +.fi +.SH DESCRIPTION +This function causes the remote server to synchronize the file +data and metadata to disk (like fsync(2)). + +For this to work requires fsync@openssh.com support on the server. + +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +.SH RETURN VALUE +Returns 0 on success or negative on failure. If used in non-blocking mode, 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_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. In particular, this can be returned if +the SSH server does not support the fsync operation: the SFTP subcode +\fILIBSSH2_FX_OP_UNSUPPORTED\fP will be returned in this case. + +.SH AVAILABILITY +Added in libssh2 1.4.4 and OpenSSH 6.3. +.SH SEE ALSO +.BR fsync(2) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_get_channel.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_get_channel.3 new file mode 100644 index 0000000..1c9ff3f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_get_channel.3 @@ -0,0 +1,21 @@ +.TH libssh2_sftp_get_channel 3 "9 Sep 2011" "libssh2 1.4.0" "libssh2 manual" +.SH NAME +libssh2_sftp_get_channel - return the channel of sftp +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +.fi +LIBSSH2_CHANNEL *libssh2_sftp_get_channel(LIBSSH2_SFTP *sftp); +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +Return the channel of the given sftp handle. +.SH RETURN VALUE +The channel of the SFTP instance or NULL if something was wrong. +.SH AVAILABILITY +Added in 1.4.0 +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_init.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_init.3 new file mode 100644 index 0000000..a59d030 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_init.3 @@ -0,0 +1,39 @@ +.TH libssh2_sftp_init 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_init - open SFTP channel for the given SSH session. +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +LIBSSH2_SFTP * +libssh2_sftp_init(LIBSSH2_SESSION *session); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.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, +the protocol itself implements its own unique binary packet protocol which +must be managed with the libssh2_sftp_*() family of functions. When an SFTP +session is complete, it must be destroyed using the +.BR libssh2_sftp_shutdown(3) +function. +.SH RETURN VALUE +A pointer to the newly allocated SFTP instance or NULL on failure. +.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_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 +returned by the server. + +\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/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_last_error.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_last_error.3 new file mode 100644 index 0000000..aadbd5d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_last_error.3 @@ -0,0 +1,24 @@ +.TH libssh2_sftp_last_error 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_last_error - return the last SFTP-specific error code +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +unsigned long +libssh2_sftp_last_error(LIBSSH2_SFTP *sftp); + +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +Returns the last error code produced by the SFTP layer. Note that this only +returns a sensible error code if libssh2 returned LIBSSH2_ERROR_SFTP_PROTOCOL +in a previous call. Using \fBlibssh2_sftp_last_error(3)\fP without a +preceding SFTP protocol error, it will return an unspecified value. + +.SH RETURN VALUE +Current error code state of the SFTP instance. + +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_lstat.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_lstat.3 new file mode 100644 index 0000000..78c9057 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_lstat.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_lstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_lstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_lstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_stat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_stat_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_mkdir.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_mkdir.3 new file mode 100644 index 0000000..999bd01 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_mkdir.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_mkdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_mkdir - convenience macro for \fIlibssh2_sftp_mkdir_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_mkdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_mkdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_mkdir_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_mkdir_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_mkdir_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_mkdir_ex.3 new file mode 100644 index 0000000..20df03c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_mkdir_ex.3 @@ -0,0 +1,40 @@ +.TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_mkdir_ex - create a directory on the remote file system +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, long mode); + +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) + +\fIpath\fP - full path of the new directory to create. Note that the new +directory's parents must all exist prior to making this call. + +\fIpath_len\fP - length of the full path of the new directory to create. + +\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. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\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 +returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_open.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_open.3 new file mode 100644 index 0000000..9096986 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_open.3 @@ -0,0 +1,18 @@ +.TH libssh2_sftp_open 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_open - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_open(LIBSSH2_SFTP *sftp, const char *path, unsigned long flags, long mode); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_open_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_open_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_open_ex.3 new file mode 100644 index 0000000..32cc23f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_open_ex.3 @@ -0,0 +1,65 @@ +.TH libssh2_sftp_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_open - open filehandle for file on SFTP. +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_open_ex(LIBSSH2_SFTP *sftp, const char *filename, + unsigned int filename_len, unsigned long flags, + long mode, int open_type); +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP + +\fIfilename\fP - Remote file/directory resource to open + +\fIfilename_len\fP - Length of filename + +\fIflags\fP - Any reasonable combination of the LIBSSH2_FXF_* constants: +.RS +.IP LIBSSH2_FXF_READ +Open the file for reading. +.IP LIBSSH2_FXF_WRITE +Open the file for writing. If both this and LIBSSH2_FXF_READ are specified, +the file is opened for both reading and writing. +.IP LIBSSH2_FXF_APPEND +Force all writes to append data at the end of the file. +.IP LIBSSH2_FXF_CREAT, +If this flag is specified, then a new file will be created if one does not +already exist (if LIBSSH2_FXF_TRUNC is specified, the new file will be +truncated to zero length if it previously exists) +.IP LIBSSH2_FXF_TRUNC +Forces an existing file with the same name to be truncated to zero length when +creating a file by specifying LIBSSH2_FXF_CREAT. LIBSSH2_FXF_CREAT MUST also +be specified if this flag is used. +.IP LIBSSH2_FXF_EXCL +Causes the request to fail if the named file already exists. +LIBSSH2_FXF_CREAT MUST also be specified if this flag is used. + +.RE +\fImode\fP - POSIX file permissions to assign if the file is being newly +created. See the LIBSSH2_SFTP_S_* convenience defines in <libssh2_sftp.h> + +\fIopen_type\fP - Either of LIBSSH2_SFTP_OPENFILE (to open a file) or +LIBSSH2_SFTP_OPENDIR (to open a directory). +.SH RETURN VALUE +A pointer to the newly created LIBSSH2_SFTP_HANDLE instance or NULL on +failure. +.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_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 +returned by the server. + +\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would +block. +.SH SEE ALSO +.BR libssh2_sftp_close_handle(3) + diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_opendir.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_opendir.3 new file mode 100644 index 0000000..d345103 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_opendir.3 @@ -0,0 +1,18 @@ +.TH libssh2_sftp_opendir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_opendir - convenience macro for \fIlibssh2_sftp_open_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +LIBSSH2_SFTP_HANDLE * +libssh2_sftp_opendir(LIBSSH2_SFTP *sftp, const char *path); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_open_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_open_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_open_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_read.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_read.3 new file mode 100644 index 0000000..36bc979 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_read.3 @@ -0,0 +1,43 @@ +.TH libssh2_sftp_read 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_read - read data from an SFTP handle +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +ssize_t +libssh2_sftp_read(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen); + +.SH DESCRIPTION +\fIhandle\fP is the SFTP File Handle as returned by +.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. + +Reads a block of data from an LIBSSH2_SFTP_HANDLE. This method is modelled +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. +.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 +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_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 +returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) +.BR libssh2_sftp_read(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readdir.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readdir.3 new file mode 100644 index 0000000..adecbcb --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readdir.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_readdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_readdir - convenience macro for \fIlibssh2_sftp_readdir_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_readdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_readdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_readdir_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_readdir_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readdir_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readdir_ex.3 new file mode 100644 index 0000000..a40e4df --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readdir_ex.3 @@ -0,0 +1,65 @@ +.TH libssh2_sftp_readdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_readdir_ex - read directory data from an SFTP handle +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, + char *buffer, size_t buffer_maxlen, + char *longentry, size_t longentry_maxlen, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.SH DESCRIPTION +Reads a block of data from a LIBSSH2_SFTP_HANDLE and returns file entry +information for the next entry, if any. + +\fIhandle\fP - is the SFTP File Handle as returned by +.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. + +\fIbuffer_maxlen\fP - is the length of buffer in bytes. If the length of the +filename is longer than the space provided by buffer_maxlen it will be +truncated to fit. + +\fIlongentry\fP - is a pointer to a pre-allocated buffer of at least +\fIlongentry_maxlen\fP bytes to read data into. The format of the `longname' +field is unspecified by SFTP protocol. It MUST be suitable for use in the +output of a directory listing command (in fact, the recommended operation for +a directory listing command is to simply display this data). + +\fIlongentry_maxlen\fP - is the length of longentry in bytes. If the length of +the full directory entry is longer than the space provided by +\fIlongentry_maxlen\fP it will be truncated to fit. + +\fIattrs\fP - is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate +statbuf style data into. +.SH RETURN VALUE +Number of bytes actually populated into buffer (not counting the terminating +zero), 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 BUG +Passing in a too small buffer for 'buffer' or 'longentry' when receiving data +only results in libssh2 1.2.7 or earlier to not copy the entire data amount, +and it is not possible for the application to tell when it happens! +.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_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 +returned by the server. + +From 1.2.8, LIBSSH2_ERROR_BUFFER_TOO_SMALL is returned if any of the +given 'buffer' or 'longentry' buffers are too small to fit the requested +object name. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_close_handle(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readlink.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readlink.3 new file mode 100644 index 0000000..7425074 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_readlink.3 @@ -0,0 +1,19 @@ +.TH libssh2_sftp_readlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_readlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SYNOPSIS +.nf +#include <libssh2.h> + +#define libssh2_sftp_readlink(sftp, path, target, maxlen) \\ + libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \\ + LIBSSH2_SFTP_READLINK) +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_symlink_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_realpath.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_realpath.3 new file mode 100644 index 0000000..33f0fa8 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_realpath.3 @@ -0,0 +1,19 @@ +.TH libssh2_sftp_realpath 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_realpath - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SYNOPSIS +.nf +#include <libssh2.h> + +#define libssh2_sftp_realpath(sftp, path, target, maxlen) \\ + libssh2_sftp_symlink_ex((sftp), (path), strlen(path), (target), (maxlen), \\ + LIBSSH2_SFTP_REALPATH) +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_symlink_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rename.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rename.3 new file mode 100644 index 0000000..4939e3c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rename.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_rename 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_rename - convenience macro for \fIlibssh2_sftp_rename_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_rename(LIBSSH2_SFTP *sftp, const char *source_filename, const char *destination_filename); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_rename_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_rename_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_rename_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_rename_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rename_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rename_ex.3 new file mode 100644 index 0000000..20a3b9d --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rename_ex.3 @@ -0,0 +1,56 @@ +.TH libssh2_sftp_rename_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_rename_ex - rename an SFTP file +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, const char *source_filename, unsigned int source_filename_len, const char *dest_filename, unsigned int dest_filename_len, long flags); + +int +libssh2_sftp_rename_ex(LIBSSH2_SFTP *sftp, const char *source_filename, const char *dest_filename); + +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIsourcefile\fP - Path and name of the existing filesystem entry + +\fIsourcefile_len\fP - Length of the path and name of the existing +filesystem entry + +\fIdestfile\fP - Path and name of the target filesystem entry + +\fIdestfile_len\fP - Length of the path and name of the target +filesystem entry + +\fIflags\fP - +Bitmask flags made up of LIBSSH2_SFTP_RENAME_* constants. + +Rename a filesystem object on the remote filesystem. The semantics of +this command typically include the ability to move a filesystem object +between folders and/or filesystem mounts. If the LIBSSH2_SFTP_RENAME_OVERWRITE +flag is not set and the destfile entry already exists, the operation +will fail. Use of the other two flags indicate a preference (but not a +requirement) for the remote end to perform an atomic rename operation +and/or using native system calls when possible. + +.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_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 returned by the server. + +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rewind.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rewind.3 new file mode 100644 index 0000000..92d99e2 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rewind.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_rewind 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_rewind - convenience macro for \fIlibssh2_sftp_seek64(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_rewind(LIBSSH2_SFTP_HANDLE *handle); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_seek64(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_seek64(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_seek64(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_seek64(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rmdir.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rmdir.3 new file mode 100644 index 0000000..0d4b67f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rmdir.3 @@ -0,0 +1,18 @@ +.TH libssh2_sftp_rmdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_rmdir - convenience macro for \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH SYNOPSIS +.nf +#include <libssh2.h> + +#define libssh2_sftp_rmdir(sftp, path) \\ + libssh2_sftp_rmdir_ex((sftp), (path), strlen(path)) +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_rmdir_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_rmdir_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_rmdir_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rmdir_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rmdir_ex.3 new file mode 100644 index 0000000..daa85cf --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_rmdir_ex.3 @@ -0,0 +1,36 @@ +.TH libssh2_sftp_rmdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_rmdir_ex - remove an SFTP directory +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +int libssh2_sftp_rmdir_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len); +.SH DESCRIPTION +Remove a directory from the remote file system. + +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIsourcefile\fP - Full path of the existing directory to remove. + +\fIsourcefile_len\fP - Length of the full path of the existing directory to +remove. +.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_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 returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_seek.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_seek.3 new file mode 100644 index 0000000..ccf5e10 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_seek.3 @@ -0,0 +1,25 @@ +.TH libssh2_sftp_seek 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual" +.SH NAME +libssh2_sftp_seek - set the read/write position indicator within a file +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +void libssh2_sftp_seek(LIBSSH2_SFTP_HANDLE *handle, size_t offset); +.SH DESCRIPTION +Deprecated function. Use \fIlibssh2_sftp_seek64(3)\fP instead! + +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIoffset\fP - Number of bytes from the beginning of file to seek to. + +Move the file handle's internal pointer to an arbitrary location. +Note that libssh2 implements file pointers as a localized concept to make +file access appear more POSIX like. No packets are exchanged with the server +during a seek operation. The localized file pointer is simply used as a +convenience offset during read/write operations. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_seek64(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_seek64.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_seek64.3 new file mode 100644 index 0000000..57c9a48 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_seek64.3 @@ -0,0 +1,29 @@ +.TH libssh2_sftp_seek64 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual" +.SH NAME +libssh2_sftp_seek64 - set the read/write position within a file +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +void libssh2_sftp_seek64(LIBSSH2_SFTP_HANDLE *handle, + libssh2_uint64_t offset); +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIoffset\fP - Number of bytes from the beginning of file to seek to. + +Move the file handle's internal pointer to an arbitrary location. libssh2 +implements file pointers as a localized concept to make file access appear +more POSIX like. No packets are exchanged with the server during a seek +operation. The localized file pointer is simply used as a convenience offset +during read/write operations. + +You MUST NOT seek during writing or reading a file with SFTP, as the internals +use outstanding packets and changing the "file position" during transit will +results in badness. +.SH AVAILABILITY +Added in 1.0 +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_setstat.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_setstat.3 new file mode 100644 index 0000000..198703e --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_setstat.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_setstat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_setstat - convenience macro for \fIlibssh2_sftp_stat_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_setstat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attr); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_stat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_stat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_stat_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3 new file mode 100644 index 0000000..42cc1c4 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_shutdown.3 @@ -0,0 +1,24 @@ +.TH libssh2_sftp_shutdown 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_shutdown - shut down an SFTP session +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp); + +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +Destroys a previously initialized SFTP session and frees all resources +associated with it. + +.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_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_stat.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_stat.3 new file mode 100644 index 0000000..96cb2a5 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_stat.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_stat 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_stat - convenience macro for \fIlibssh2_sftp_fstat_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_SFTP_ATTRIBUTES *attrs); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_fstat_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_fstat_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_fstat_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_stat_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_stat_ex.3 new file mode 100644 index 0000000..2fd9507 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_stat_ex.3 @@ -0,0 +1,74 @@ +.TH libssh2_sftp_stat_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_stat_ex - get status about an SFTP file +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +int libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len, int stat_type, + LIBSSH2_SFTP_ATTRIBUTES *attrs); +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIpath\fP - Remote filesystem object to stat/lstat/setstat. + +\fIpath_len\fP - Length of the name of the remote filesystem object +to stat/lstat/setstat. + +\fIstat_type\fP - One of the three constants specifying the type of +stat operation to perform: + +.br +\fBLIBSSH2_SFTP_STAT\fP: performs stat(2) operation +.br +\fBLIBSSH2_SFTP_LSTAT\fP: performs lstat(2) operation +.br +\fBLIBSSH2_SFTP_SETSTAT\fP: performs operation to set stat info on file + +\fIattrs\fP - Pointer to a \fBLIBSSH2_SFTP_ATTRIBUTES\fP structure to set file +metadata from or into depending on the value of stat_type. + +Get or Set statbuf type data on a remote filesystem object. When getting +statbuf data, +.BR libssh2_sftp_stat(3) +will follow all symlinks, while +.BR libssh2_sftp_lstat(3) +will return data about the object encountered, even if that object +happens to be a symlink. + +The LIBSSH2_SFTP_ATTRIBUTES struct looks like this: + +.nf +struct LIBSSH2_SFTP_ATTRIBUTES { + /* If flags & ATTR_* bit is set, then the value in this struct will be + * meaningful Otherwise it should be ignored + */ + unsigned long flags; + + libssh2_uint64_t filesize; + unsigned long uid; + unsigned long gid; + unsigned long permissions; + unsigned long atime; + unsigned long mtime; +}; +.fi +.SH RETURN VALUE +Returns 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_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 returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_statvfs.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_statvfs.3 new file mode 100644 index 0000000..6327030 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_statvfs.3 @@ -0,0 +1,79 @@ +.TH libssh2_sftp_statvfs 3 "22 May 2010" "libssh2 1.2.6" "libssh2 manual" +.SH NAME +libssh2_sftp_statvfs, libssh2_sftp_fstatvfs - get file system statistics +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_statvfs(LIBSSH2_SFTP *sftp, const char *path, + size_t path_len, LIBSSH2_SFTP_STATVFS *st); + +int +libssh2_sftp_fstatvfs(LIBSSH2_SFTP_HANDLE *handle, + LIBSSH2_SFTP_STATVFS *st) +.fi +.SH DESCRIPTION +These functions provide statvfs(2)-like operations and require +statvfs@openssh.com and fstatvfs@openssh.com extension support on the server. + +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIhandle\fP - SFTP File Handle as returned by +.BR libssh2_sftp_open_ex(3) + +\fIpath\fP - full path of any file within the mounted file system. + +\fIpath_len\fP - length of the full path. + +\fIst\fP - Pointer to a LIBSSH2_SFTP_STATVFS structure to place file system +statistics into. + +.SH DATA TYPES +LIBSSH2_SFTP_STATVFS is a typedefed struct that is defined as below + +.nf +struct _LIBSSH2_SFTP_STATVFS { + libssh2_uint64_t f_bsize; /* file system block size */ + libssh2_uint64_t f_frsize; /* fragment size */ + libssh2_uint64_t f_blocks; /* size of fs in f_frsize units */ + libssh2_uint64_t f_bfree; /* # free blocks */ + libssh2_uint64_t f_bavail; /* # free blocks for non-root */ + libssh2_uint64_t f_files; /* # inodes */ + libssh2_uint64_t f_ffree; /* # free inodes */ + libssh2_uint64_t f_favail; /* # free inodes for non-root */ + libssh2_uint64_t f_fsid; /* file system ID */ + libssh2_uint64_t f_flag; /* mount flags */ + libssh2_uint64_t f_namemax; /* maximum filename length */ +}; +.fi + +It is unspecified whether all members of the returned struct have meaningful +values on all file systems. + +The field \fIf_flag\fP is a bit mask. Bits are defined as follows: +.IP LIBSSH2_SFTP_ST_RDONLY +Read-only file system. +.IP LIBSSH2_SFTP_ST_NOSUID +Set-user-ID/set-group-ID bits are ignored by \fBexec\fP(3). + +.SH RETURN VALUE +Returns 0 on success or negative on failure. If used in non-blocking mode, 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_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 returned +by the server. +.SH AVAILABILITY +Added in libssh2 1.2.6 +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_symlink.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_symlink.3 new file mode 100644 index 0000000..3de7b29 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_symlink.3 @@ -0,0 +1,19 @@ +.TH libssh2_sftp_symlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_symlink - convenience macro for \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SYNOPSIS +.nf +#include <libssh2.h> + +#define libssh2_sftp_symlink(sftp, orig, linkpath) \\ + libssh2_sftp_symlink_ex((sftp), (orig), strlen(orig), (linkpath), \\ + strlen(linkpath), LIBSSH2_SFTP_SYMLINK) +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_symlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_symlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_symlink_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_symlink_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_symlink_ex.3 new file mode 100644 index 0000000..fc0bc93 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_symlink_ex.3 @@ -0,0 +1,79 @@ +.TH libssh2_sftp_symlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_symlink_ex - read or set a symbolic link +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path, + unsigned int path_len, char *target, + unsigned int target_len, int link_type); +.SH DESCRIPTION +Create a symlink or read out symlink information from the remote side. + +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIpath\fP - Remote filesystem object to create a symlink from or resolve. + +\fIpath_len\fP - Length of the name of the remote filesystem object to +create a symlink from or resolve. + +\fItarget\fP - a pointer to a buffer. The buffer has different uses depending +what the \fIlink_type\fP argument is set to. +.br +\fBLIBSSH2_SFTP_SYMLINK\fP: Remote filesystem object to link to. +.br +\fBLIBSSH2_SFTP_READLINK\fP: Pre-allocated buffer to resolve symlink target +into. +.br +\fBLIBSSH2_SFTP_REALPATH\fP: Pre-allocated buffer to resolve realpath target +into. + +\fItarget_len\fP - Length of the name of the remote filesystem target object. + +\fIlink_type\fP - One of the three previously mentioned constants which +determines the resulting behavior of this function. + +These are convenience macros: + +.BR libssh2_sftp_symlink(3) +: Create a symbolic link between two filesystem objects. +.br +.BR libssh2_sftp_readlink(3) +: Resolve a symbolic link filesystem object to its next target. +.br +.BR libssh2_sftp_realpath(3) +: Resolve a complex, relative, or symlinked filepath to its effective target. +.SH RETURN VALUE +When using LIBSSH2_SFTP_SYMLINK, this function returns 0 on success or negative +on failure. + +When using LIBSSH2_SFTP_READLINK or LIBSSH2_SFTP_REALPATH, it returns the +number of bytes it copied to the target buffer (not including the terminating +zero) 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. + +From 1.2.8, LIBSSH2_ERROR_BUFFER_TOO_SMALL is returned if the given 'target' +buffer is too small to fit the requested object name. +.SH BUG +Passing in a too small buffer when receiving data only results in libssh2 +1.2.7 or earlier to not copy the entire data amount, and it is not possible +for the application to tell when it happens! +.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_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 returned by the server. + +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_tell.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_tell.3 new file mode 100644 index 0000000..2ff1fba --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_tell.3 @@ -0,0 +1,20 @@ +.TH libssh2_sftp_tell 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_tell - get the current read/write position indicator for a file +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +size_t +libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle); + +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP. + +Returns the current offset of the file handle's internal pointer. Note that +this is now deprecated. Use the newer \fBlibssh2_sftp_tell64(3)\fP instead! +.SH RETURN VALUE +Current offset from beginning of file in bytes. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_tell64(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_tell64.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_tell64.3 new file mode 100644 index 0000000..827601f --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_tell64.3 @@ -0,0 +1,21 @@ +.TH libssh2_sftp_tell64 3 "22 Dec 2008" "libssh2 1.0" "libssh2 manual" +.SH NAME +libssh2_sftp_tell64 - get the current read/write position indicator for a file +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +libssh2_uint64_t +libssh2_sftp_tell64(LIBSSH2_SFTP_HANDLE *handle); + +.SH DESCRIPTION +\fIhandle\fP - SFTP File Handle as returned by \fBlibssh2_sftp_open_ex(3)\fP + +Identify the current offset of the file handle's internal pointer. +.SH RETURN VALUE +Current offset from beginning of file in bytes. +.SH AVAILABILITY +Added in libssh2 1.0 +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3), +.BR libssh2_sftp_tell(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_unlink.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_unlink.3 new file mode 100644 index 0000000..32bbbf9 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_unlink.3 @@ -0,0 +1,17 @@ +.TH libssh2_sftp_unlink 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_sftp_unlink - convenience macro for \fIlibssh2_sftp_unlink_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_sftp_unlink_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_sftp_unlink_ex(3)\fP +.SH ERRORS +See \fIlibssh2_sftp_unlink_ex(3)\fP +.SH SEE ALSO +.BR libssh2_sftp_unlink_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_unlink_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_unlink_ex.3 new file mode 100644 index 0000000..6672a8c --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_unlink_ex.3 @@ -0,0 +1,42 @@ +.TH libssh2_sftp_unlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_unlink_ex - unlink an SFTP file +.SH SYNOPSIS +#include <libssh2.h> +#include <libssh2_sftp.h> + +int +libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len); + +int +libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); + +.SH DESCRIPTION +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) + +\fIfilename\fP - Path and name of the existing filesystem entry + +\fIfilename_len\fP - Length of the path and name of the existing +filesystem entry + +Unlink (delete) a file from the remote filesystem. + +.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_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 returned by the server. + +.SH SEE ALSO +.BR libssh2_sftp_init(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_write.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_write.3 new file mode 100644 index 0000000..8d81912 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_sftp_write.3 @@ -0,0 +1,71 @@ +.TH libssh2_sftp_write 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_sftp_write - write SFTP data +.SH SYNOPSIS +.nf +#include <libssh2.h> +#include <libssh2_sftp.h> + +ssize_t libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, + const char *buffer, + size_t count); +.SH DESCRIPTION +\fBlibssh2_sftp_write(3)\fP writes a block of data to the SFTP server. This +method is modeled after the POSIX write() function and uses the same calling +semantics. + +\fIhandle\fP - SFTP file handle as returned by \fIlibssh2_sftp_open_ex(3)\fP. + +\fIbuffer\fP - points to the data to send off. + +\fIcount\fP - Number of bytes from 'buffer' to write. Note that it may not be +possible to write all bytes as requested. + +\fIlibssh2_sftp_handle(3)\fP will use as much as possible of the buffer and +put it into a single SFTP protocol packet. This means that to get maximum +performance when sending larger files, you should try to always pass in at +least 32K of data to this function. + +.SH WRITE AHEAD +Starting in libssh2 version 1.2.8, the default behavior of libssh2 is to +create several smaller outgoing packets for all data you pass to this function +and it will return a positive number as soon as the first packet is +acknowledged from the server. + +This has the effect that sometimes more data has been sent off but isn't acked +yet when this function returns, and when this function is subsequently called +again to write more data, libssh2 will immediately figure out that the data is +already received remotely. + +In most normal situation this should not cause any problems, but it should be +noted that if you've once called libssh2_sftp_write() with data and it returns +short, you MUST still assume that the rest of the data might've been cached so +you need to make sure you don't alter that data and think that the version you +have in your next function invoke will be detected or used. + +The reason for this funny behavior is that SFTP can only send 32K data in each +packet and it gets all packets acked individually. This means we cannot use a +simple serial approach if we want to reach high performance even on high +latency connections. And we want that. +.SH RETURN VALUE +Actual number of bytes written or negative on failure. + +If used in non-blocking mode, 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. + +If this function returns 0 (zero) it should not be considered an error, but +simply that there was no error but yet no payload data got sent to the other +end. +.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_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 returned by the server. +.SH SEE ALSO +.BR libssh2_sftp_open_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_trace.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_trace.3 new file mode 100644 index 0000000..4d01bf7 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_trace.3 @@ -0,0 +1,35 @@ +.TH libssh2_trace 3 "26 Dec 2008" "libssh2 1.0" "libssh2 manual" +.SH NAME +libssh2_trace - enable debug info from inside libssh2 +.SH SYNOPSIS +#include <libssh2.h> + +void libssh2_trace(LIBSSH2_SESSION *session, int bitmask); + +.SH DESCRIPTION +This is a function present in the library that can be used to get debug info +from within libssh2 when it is running. Helpful when trying to trace or debug +behaviors. Note that this function has no effect unless libssh2 was built to +support tracing! It is usually disabled in release builds. + +\fBbitmask\fP can be set to the logical OR of none, one or more of these: +.RS +.IP LIBSSH2_TRACE_SOCKET +Socket low-level debugging +.IP LIBSSH2_TRACE_TRANS +Transport layer debugging +.IP LIBSSH2_TRACE_KEX +Key exchange debugging +.IP LIBSSH2_TRACE_AUTH +Authentication debugging +.IP LIBSSH2_TRACE_CONN +Connection layer debugging +.IP LIBSSH2_TRACE_SCP +SCP debugging +.IP LIBSSH2_TRACE_SFTP +SFTP debugging +.IP LIBSSH2_TRACE_ERROR +Error debugging +.IP LIBSSH2_TRACE_PUBLICKEY +Public Key debugging +.RE diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_trace_sethandler.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_trace_sethandler.3 new file mode 100644 index 0000000..57d84ba --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_trace_sethandler.3 @@ -0,0 +1,28 @@ +.TH libssh2_trace_sethandler 3 "15 Jan 2010" "libssh2 1.2.3" "libssh2 manual" +.SH NAME +libssh2_trace_sethandler - set a trace output handler +.SH SYNOPSIS +.nf +#include <libssh2.h> + +typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session, + void* context, + const char *data, + size_t length); + +int libssh2_trace_sethandler(LIBSSH2_SESSION *session, + void* context, + libssh2_trace_handler_func callback); +.SH DESCRIPTION +libssh2_trace_sethandler installs a trace output handler for your application. +By default, when tracing has been switched on via a call to libssh2_trace(), +all output is written to stderr. By calling this method and passing a +function pointer that matches the libssh2_trace_handler_func prototype, +libssh2 will call back as it generates trace output. This can be used to +capture the trace output and put it into a log file or diagnostic window. +This function has no effect unless libssh2 was built to support this option, +and a typical "release build" might not. + +\fBcontext\fP can be used to pass arbitrary user defined data back into the callback when invoked. +.SH AVAILABILITY +Added in libssh2 version 1.2.3 diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_authenticated.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_authenticated.3 new file mode 100644 index 0000000..786e0f0 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_authenticated.3 @@ -0,0 +1,20 @@ +.TH libssh2_userauth_authenticated 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_userauth_authenticated - return authentication status +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_userauth_authenticated(LIBSSH2_SESSION *session); + +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +Indicates whether or not the named session has been successfully authenticated. + +.SH RETURN VALUE +Returns 1 if authenticated and 0 if not. + +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_hostbased_fromfile.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_hostbased_fromfile.3 new file mode 100644 index 0000000..2115356 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_hostbased_fromfile.3 @@ -0,0 +1,17 @@ +.TH libssh2_userauth_hostbased_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_userauth_hostbased_fromfile - convenience macro for \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_userauth_hostbased_fromfile(LIBSSH2_SESSION *session, const char *username, const char *publickey, const char *privatekey, const char *passphrase, const char *hostname); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_hostbased_fromfile_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_hostbased_fromfile_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_hostbased_fromfile_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_hostbased_fromfile_ex.3 new file mode 100644 index 0000000..a65f802 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_hostbased_fromfile_ex.3 @@ -0,0 +1,12 @@ +.TH libssh2_userauth_hostbased_fromfile_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_userauth_hostbased_fromfile_ex - TODO +.SH SYNOPSIS + +.SH DESCRIPTION + +.SH RETURN VALUE + +.SH ERRORS + +.SH SEE ALSO diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_keyboard_interactive.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_keyboard_interactive.3 new file mode 100644 index 0000000..a85de32 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_keyboard_interactive.3 @@ -0,0 +1,20 @@ +.TH libssh2_userauth_keyboard_interactive 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_userauth_keyboard_interactive - convenience macro for \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> +.nf + +int +libssh2_userauth_keyboard_interactive(LIBSSH2_SESSION* session, + const char *username, + LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC((*response_callback))); +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_keyboard_interactive_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_keyboard_interactive_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_keyboard_interactive_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_keyboard_interactive_ex.3 new file mode 100644 index 0000000..ada012a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_keyboard_interactive_ex.3 @@ -0,0 +1,58 @@ +.TH libssh2_userauth_keyboard_interactive_ex 3 "8 Mar 2008" "libssh2 0.19" "libssh2 manual" +.SH NAME +libssh2_userauth_keyboard_interactive_ex - authenticate a session using +keyboard-interactive authentication +.SH SYNOPSIS +.nf +#include <libssh2.h> + +int +libssh2_userauth_keyboard_interactive_ex(LIBSSH2_SESSION *session, + const char *username, + unsigned int username_len, + LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback)); +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +\fIlibssh2_session_init_ex(3)\fP. + +\fIusername\fP - Name of user to attempt keyboard-interactive authentication +for. + +\fIusername_len\fP - Length of username parameter. + +\fIresponse_callback\fP - As authentication proceeds, the host issues several +(1 or more) challenges and requires responses. This callback will be called at +this moment. The callback is responsible to obtain responses for the +challenges, fill the provided data structure and then return +control. Responses will be sent to the host. String values will be free(3)ed +by the library. The callback prototype must match this: + +.nf + void response(const char *name, + int name_len, const char *instruction, + int instruction_len, + int num_prompts, + const LIBSSH2_USERAUTH_KBDINT_PROMPT *prompts, + LIBSSH2_USERAUTH_KBDINT_RESPONSE *responses, + void **abstract); +.fi + +Attempts keyboard-interactive (challenge/response) authentication. + +Note that many SSH servers will always issue a single "password" challenge, +requesting actual password as response, but it is not required by the +protocol, and various authentication schemes, such as smartcard authentication +may use keyboard-interactive authentication type too. +.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. + +\fLIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/password +or public/private key. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_list.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_list.3 new file mode 100644 index 0000000..de349f1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_list.3 @@ -0,0 +1,39 @@ +.TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_userauth_list - list supported authentication methods +.SH SYNOPSIS +.nf +#include <libssh2.h> + +char * +libssh2_userauth_list(LIBSSH2_SESSION *session, const char *username, + unsigned int username_len); +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIusername\fP - Username which will be used while authenticating. Note that +most server implementations do not permit attempting authentication with +different usernames between requests. Therefore this must be the same username +you will use on later userauth calls. + +\fIusername_len\fP - Length of username parameter. + +Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the remote +host is configured to accept none as a viable authentication scheme +(unlikely), it will return \fBSSH_USERAUTH_FAILURE\fP along with a listing of +what authentication schemes it does support. In the unlikely event that none +authentication succeeds, this method with return NULL. This case may be +distinguished from a failing case by examining +\fIlibssh2_userauth_authenticated(3)\fP. +.SH RETURN VALUE +On success a comma delimited list of supported authentication schemes. This +list is internally managed by libssh2. On failure returns NULL. +.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_EAGAIN\fP - Marked for non-blocking I/O but the call +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_password.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_password.3 new file mode 100644 index 0000000..15e5511 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_password.3 @@ -0,0 +1,19 @@ +.TH libssh2_userauth_password 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_userauth_password - convenience macro for \fIlibssh2_userauth_password_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int libssh2_userauth_password(LIBSSH2_SESSION *session, + const char *username, + const char *password); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_password_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_password_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_password_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_password_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_password_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_password_ex.3 new file mode 100644 index 0000000..dc9e108 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_password_ex.3 @@ -0,0 +1,57 @@ +.TH libssh2_userauth_password_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_userauth_password_ex - authenticate a session with username and password +.SH SYNOPSIS +#include <libssh2.h> +.nf +int libssh2_userauth_password_ex(LIBSSH2_SESSION *session, + const char *username, + unsigned int username_len, + const char *password, + unsigned int password_len, + LIBSSH2_PASSWD_CHANGEREQ_FUNC((*passwd_change_cb))); + +#define libssh2_userauth_password(session, username, password) \\ + libssh2_userauth_password_ex((session), (username), \\ + strlen(username), \\ + (password), strlen(password), NULL) +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +.BR libssh2_session_init_ex(3) + +\fIusername\fP - Name of user to attempt plain password authentication for. + +\fIusername_len\fP - Length of username parameter. + +\fIpassword\fP - Password to use for authenticating username. + +\fIpassword_len\fP - Length of password parameter. + +\fIpasswd_change_cb\fP - If the host accepts authentication but +requests that the password be changed, this callback will be issued. +If no callback is defined, but server required password change, +authentication will fail. + +Attempt basic password authentication. Note that many SSH servers +which appear to support ordinary password authentication actually have +it disabled and use Keyboard Interactive authentication (routed via +PAM or another authentication backed) instead. + +.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 +Some of the errors this function may return include: + +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +\fILIBSSH2_ERROR_PASSWORD_EXPIRED\fP - + +\fLIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/password +or public/private key. +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey.3 new file mode 100644 index 0000000..0081a24 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey.3 @@ -0,0 +1,27 @@ +.TH libssh2_userauth_publickey 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_userauth_publickey - authenticate using a callback function +.SH SYNOPSIS +#include <libssh2.h> + +.nf +int libssh2_userauth_publickey(LIBSSH2_SESSION *session, + const char *user, + const unsigned char *pubkeydata, + size_t pubkeydata_len, + sign_callback, + void **abstract); +.SH DESCRIPTION +Authenticate with the \fIsign_callback\fP callback that matches the prototype +below +.SH CALLBACK +.nf +int name(LIBSSH2_SESSION *session, unsigned char **sig, size_t *sig_len, + const unsigned char *data, size_t data_len, void **abstract); +.fi + +This function gets called... +.SH RETURN VALUE +Return 0 on success or negative on failure. +.SH SEE ALSO +.BR libssh2_userauth_publickey_fromfile_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey_fromfile.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey_fromfile.3 new file mode 100644 index 0000000..f4799a1 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey_fromfile.3 @@ -0,0 +1,22 @@ +.TH libssh2_userauth_publickey_fromfile 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2 manual" +.SH NAME +libssh2_userauth_publickey_fromfile - convenience macro for \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP calls +.SH SYNOPSIS +#include <libssh2.h> + +int +libssh2_userauth_publickey_fromfile(LIBSSH2_SESSION *session, + const char *username, + const char *publickey, + const char *privatekey, + const char *passphrase); + +.SH DESCRIPTION +This is a macro defined in a public libssh2 header file that is using the +underlying function \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP. +.SH RETURN VALUE +See \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP +.SH ERRORS +See \fIlibssh2_userauth_publickey_fromfile_ex(3)\fP +.SH SEE ALSO +.BR libssh2_userauth_publickey_fromfile_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey_fromfile_ex.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey_fromfile_ex.3 new file mode 100644 index 0000000..0d77c9a --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_userauth_publickey_fromfile_ex.3 @@ -0,0 +1,52 @@ +.TH libssh2_userauth_publickey_fromfile 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_userauth_publickey_fromfile - authenticate a session with a public key, read from a file +.SH SYNOPSIS +#include <libssh2.h> + +.nf +int libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session, + const char *username, + unsigned int ousername_len, + const char *publickey, + const char *privatekey, + const char *passphrase); +.SH DESCRIPTION +\fIsession\fP - Session instance as returned by +\fBlibssh2_session_init_ex(3)\fP + +\fIusername\fP - Pointer to user name to authenticate as. + +\fIusername_len\fP - Length of \fIusername\fP. + +\fIpublickey\fP - Path name of the public key file. +(e.g. /etc/ssh/hostkey.pub). If libssh2 is built against OpenSSL, this option +can be set to NULL. + +\fIprivatekey\fP - Path name of the private key file. (e.g. /etc/ssh/hostkey) + +\fIpassphrase\fP - Passphrase to use when decoding \fIprivatekey\fP. + +Attempt public key authentication using a PEM encoded private key file stored +on disk + +.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_SOCKET_TIMEOUT\fP - + +\fILIBSSH2_ERROR_PUBLICKEY_UNVERIFIED\fP - The username/public key +combination was invalid. + +\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - Authentication using the supplied +public key was not accepted. + +.SH SEE ALSO +.BR libssh2_session_init_ex(3) diff --git a/libssh2-sys/libssh2-1.5.0/docs/libssh2_version.3 b/libssh2-sys/libssh2-1.5.0/docs/libssh2_version.3 new file mode 100644 index 0000000..f98ca96 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/libssh2_version.3 @@ -0,0 +1,36 @@ +.TH libssh2_version 3 "23 Feb 2009" "libssh2 1.1" "libssh2 manual" +.SH NAME +libssh2_version - return the libssh2 version number +.SH SYNOPSIS +#include <libssh2.h> + +const char * +libssh2_version(int required_version); +.SH DESCRIPTION +If \fIrequired_version\fP is lower than or equal to the version number of the +libssh2 in use, the version number of libssh2 is returned as a pointer to a +zero terminated string. + +The \fIrequired_version\fP should be the version number as constructed by the +LIBSSH2_VERSION_NUM define in the libssh2.h public header file, which is a 24 +bit number in the 0xMMmmpp format. MM for major, mm for minor and pp for patch +number. +.SH RETURN VALUE +The version number of libssh2 is returned as a pointer to a zero terminated +string or NULL if the \fIrequired_version\fP isn't fulfilled. +.SH EXAMPLE +To make sure you run with the correct libssh2 version: + +.nf +if (!libssh2_version(LIBSSH2_VERSION_NUM)) { + fprintf (stderr, \&"Runtime libssh2 version too old!\&"); + exit(1); +} +.fi + +Unconditionally get the version number: + +printf(\&"libssh2 version: %s\&", libssh2_version(0) ); +.SH AVAILABILITY +This function was added in libssh2 1.1, in previous versions there way no way +to extract this info in run-time. diff --git a/libssh2-sys/libssh2-1.5.0/docs/template.3 b/libssh2-sys/libssh2-1.5.0/docs/template.3 new file mode 100644 index 0000000..d5b4473 --- /dev/null +++ b/libssh2-sys/libssh2-1.5.0/docs/template.3 @@ -0,0 +1,20 @@ +.TH libssh2_template 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_template - short function description +.SH SYNOPSIS +#include <libssh2.h> + +void +libssh2_template(void); + +.SH DESCRIPTION +Long text describing the function and its input arguments. + +.SH RETURN VALUE +Describe what the function returns. + +.SH ERRORS +Add error codes + +.SH SEE ALSO +Add related functions |