summaryrefslogtreecommitdiff
path: root/doc/api-version.texi
blob: 1634b5c53e7d496164e44c623b9dd7874c6869fb (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@c -*-texinfo-*-
@c This file is part of Guile-SSH Reference Manual.
@c Copyright (C) 2014 Artyom V. Poptsov
@c See the file guile-ssh.texi for copying conditions.

@node Version
@section Version

@cindex versions

The @code{(ssh version)} module provides functions that is used for
getting information about current versions.

@deffn {Scheme Procedure} get-libssh-version
Get version of the libssh.  Returns libssh version as a string in the
follwing format:

@example
<version> ::= <major> "." <minor> "." <micro>
@end example

For example, @samp{0.5.2}.
@end deffn

@deffn {Scheme Procedure} %get-libssh-version
Low-level procedure that returns a version string in libssh format,
eg. "0.6.3/openssl/zlib".
@end deffn

@deffn {Scheme Procedure} get-crypto-library
Get cryptographic library name with which libssh was compiled.  Possible
values are: @code{'openssl}, @code{'gnutls}.
@end deffn

@deffn {Scheme Procedure} zlib-support?
Return @code{#t} if libssh was compiled wit zlib support, @code{#f} otherwise.
@end deffn

@deffn {Scheme Procedure} get-library-version
Get version of the Guile-SSH.
@end deffn

@c Local Variables:
@c TeX-master: "guile-ssh.texi"
@c End: