This is the libssh2 Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:29:21 2020 GMT+0.
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The libssh2 system |
Oleksii Shevchuk <alxchk@gmail.com>
Public Domain
Trivial libssh2 bindings
0.1
libssh2.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
• The libssh2/src module |
libssh2 (system)
src/
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The libssh2/src/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
libssh2.asd
libssh2 (system)
Next: The libssh2/src/logging․lisp file, Previous: The libssh2․asd file, Up: Lisp files [Contents][Index]
Next: The libssh2/src/types․lisp file, Previous: The libssh2/src/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
src (module)
src/logging.lisp
Next: The libssh2/src/libssh2-libc-cffi․lisp file, Previous: The libssh2/src/logging․lisp file, Up: Lisp files [Contents][Index]
logging.lisp (file)
src (module)
src/types.lisp
Next: The libssh2/src/util․lisp file, Previous: The libssh2/src/types․lisp file, Up: Lisp files [Contents][Index]
types.lisp (file)
src (module)
src/libssh2-libc-cffi.lisp
Next: The libssh2/src/libssh2-cffi․lisp file, Previous: The libssh2/src/libssh2-libc-cffi․lisp file, Up: Lisp files [Contents][Index]
libssh2-libc-cffi.lisp (file)
src (module)
src/util.lisp
Next: The libssh2/src/streams․lisp file, Previous: The libssh2/src/util․lisp file, Up: Lisp files [Contents][Index]
util.lisp (file)
src (module)
src/libssh2-cffi.lisp
Next: The libssh2/src/scp․lisp file, Previous: The libssh2/src/libssh2-cffi․lisp file, Up: Lisp files [Contents][Index]
libssh2-cffi.lisp (file)
src (module)
src/streams.lisp
Next: The libssh2/src/sftp․lisp file, Previous: The libssh2/src/streams․lisp file, Up: Lisp files [Contents][Index]
streams.lisp (file)
src (module)
src/scp.lisp
Next: The libssh2/src/solutions․lisp file, Previous: The libssh2/src/scp․lisp file, Up: Lisp files [Contents][Index]
scp.lisp (file)
src (module)
src/sftp.lisp
sftp-list-directory (function)
Previous: The libssh2/src/sftp․lisp file, Up: Lisp files [Contents][Index]
sftp.lisp (file)
src (module)
src/solutions.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The libssh2 package |
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions | ||
• Exported structures | ||
• Exported classes |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
types.lisp (file)
types.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
streams.lisp (file)
streams.lisp (file)
libssh2-cffi.lisp (file)
streams.lisp (file)
streams.lisp (file)
libssh2-cffi.lisp (file)
streams.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
streams.lisp (file)
solutions.lisp (file)
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
Return a list of files in directory ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’.
Restrict the number of files to retrieve by providing
- ‘MAXFILES’ - a fixnum (which is by default set to an insanely large number)
- ‘EXTENSIONS’ - a list of strings (default: nil)
It is possible to combine ‘MAXFILES’ and ‘EXTENSIONS’ (retrieve 5 files with extensions ’(".json", ".js"))
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
solutions.lisp (file)
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
types.lisp (file)
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
libssh2-cffi.lisp (file)
types.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
types.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
types.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
types.lisp (file)
streams.lisp (file)
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
streams.lisp (file)
Next: Exported structures, Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
libssh2-cffi.lisp (file)
ssh-generic-error (condition)
:file
file (generic function)
(setf file) (generic function)
types.lisp (file)
:reason
reason (generic function)
(setf reason) (generic function)
Signalled when a non-correctable condition occurs during a libssh2 call.
types.lisp (file)
types.lisp (file)
ssh-generic-error (condition)
Next: Exported classes, Previous: Exported conditions, Up: Exported definitions [Contents][Index]
types.lisp (file)
structure-object (structure)
0
key-data (function)
(setf key-data) (function)
0
key-size (function)
(setf key-size) (function)
0
key-type (function)
(setf key-type) (function)
Previous: Exported structures, Up: Exported definitions [Contents][Index]
streams.lisp (file)
auth-data (class)
streams.lisp (file)
standard-object (class)
string
:login
""
login (generic function)
streams.lisp (file)
auth-data (class)
string
:password
""
password (generic function)
streams.lisp (file)
auth-data (class)
string
:public-key
"id_rsa.pub"
public-key (generic function)
(setf public-key) (generic function)
string
:private-key
"id_rsa"
private-key (generic function)
(setf private-key) (generic function)
string
:password
""
password (generic function)
(setf password) (generic function)
streams.lisp (file)
streams.lisp (file)
stream-read-sequence (method)
streams.lisp (file)
streams.lisp (file)
trivial-gray-stream-mixin (class)
:socket
socket (generic function)
(setf socket) (generic function)
libssh2:+channel+
:channel
channel (generic function)
(setf channel) (generic function)
streams.lisp (file)
ssh-channel-stream (class)
(cffi-sys:make-shareable-byte-vector libssh2::*ssh-channel-buffer-size*)
input-buffer (generic function)
(setf input-buffer) (generic function)
libssh2::int
0
input-size (generic function)
(setf input-size) (generic function)
libssh2::int
0
input-pos (generic function)
(setf input-pos) (generic function)
streams.lisp (file)
ssh-channel-exec (class)
streams.lisp (file)
ssh-channel-stream (class)
(cffi-sys:make-shareable-byte-vector libssh2::*ssh-channel-buffer-size*)
output-buffer (generic function)
(setf output-buffer) (generic function)
libssh2::int
0
output-size (generic function)
(setf output-size) (generic function)
libssh2::int
0
output-pos (generic function)
(setf output-pos) (generic function)
streams.lisp (file)
standard-object (class)
libssh2:+session+
:session
(cffi-sys:null-pointer)
session (generic function)
usocket:socket
:socket
socket (generic function)
(setf socket) (generic function)
string
:host
host (generic function)
(setf host) (generic function)
libssh2::int
:port
port (generic function)
(setf port) (generic function)
string
:hosts-db
hosts-db (generic function)
(setf hosts-db) (generic function)
boolean
auth-passed (generic function)
(setf auth-passed) (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal conditions | ||
• Internal classes |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libssh2-20160531-git/src/libssh2-libc-cffi.processed-grovel-file
Next: Internal macros, Previous: Internal constants, Up: Internal definitions [Contents][Index]
libssh2-cffi.lisp (file)
solutions.lisp (file)
Dynamic variable which is bound to a foreign reference representing the SFTP session (in libssh2 terms).
libssh2-cffi.lisp (file)
streams.lisp (file)
Dynamic variable which holds an instance of SSH-CONNECTION which is a wrapper around the libssh2 ’session’ pointer, and contains additional information about host, port etc.
libssh2-cffi.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
logging.lisp (file)
logging.lisp (file)
logging.lisp (file)
logging.lisp (file)
logging.lisp (file)
logging.lisp (file)
streams.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
types.lisp (file)
libssh2-cffi.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
types.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
types.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
Sets up timeouts on the given USOCKET object. READ-TIMEOUT is the read timeout period, WRITE-TIMEOUT is the write timeout, specified in (fractional) seconds. The timeouts can either be implemented using the low-level socket options SO_RCVTIMEO and SO_SNDTIMEO or some other, implementation specific mechanism. On platforms that do not support separate read and write timeouts, both must be equal or an error will be signaled. READ-TIMEOUT and WRITE-TIMEOUT may be NIL, which means that the corresponding socket timeout value will not be set.
Delete a remote file ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’.
Receive a remote file ‘PATH’ on the server to which we are connected with ‘SSH-CONNECTION’ to a local file at ‘LOCAL-PATH’.
streams.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
Next: Internal conditions, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
streams.lisp (file)
automatically generated writer method
streams.lisp (file)
automatically generated reader method
streams.lisp (file)
solutions.lisp (file)
solutions.lisp (file)
solutions.lisp (file)
streams.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
Signalled when an error code is returned by libssh2
which is unknown (or better: not yet known) to this library; this
situation can arise when libssh2 adds a new error, but the lisp code
is not yet updated to reflect the change. The ‘MESSAGE’ slot is set
to ’Received unknown error code from libssh2; please contact the
cl-libssh2 authors.’
types.lisp (file)
ssh-generic-error (condition)
initialize-instance (method)
is thrown in case authentication failed without specific error code~%
streams.lisp (file)
ssh-generic-error (condition)
Parent condition for all situations where a libssh2
call yields a non-zero return value. ‘CODE’ and ‘MESSAGE’ are used
to transport the error code and message from C.
types.lisp (file)
condition (condition)
:message
message (generic function)
(setf message) (generic function)
:code
code (generic function)
(setf code) (generic function)
types.lisp (file)
ssh-condition (condition)
:host
host (generic function)
(setf host) (generic function)
:hash
hash (generic function)
(setf hash) (generic function)
types.lisp (file)
ssh-hostkey-condition (condition)
Previous: Internal conditions, Up: Internal definitions [Contents][Index]
types.lisp (file)
types.lisp (file)
types.lisp (file)
/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libssh2-20160531-git/src/libssh2-libc-cffi.processed-grovel-file
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
libssh2-cffi.lisp (file)
streams.lisp (file)
auth-data (class)
string
:password
""
password (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L M |
---|
Jump to: | F L M |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
A C D E F G H I K L M O P R S T U W |
---|
Jump to: | %
(
A C D E F G H I K L M O P R S T U W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
.
A C D F H I L M O P R S T |
---|
Jump to: | *
+
.
A C D F H I L M O P R S T |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | +
_
A C K L P S |
---|
Jump to: | +
_
A C K L P S |
---|