mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-24 14:53:03 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
60 lines
1.3 KiB
Markdown
60 lines
1.3 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_version
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_version - return the libssh2 version number
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
const char *
|
|
libssh2_version(int required_version);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
If *required_version* 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 *required_version* 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.
|
|
|
|
# RETURN VALUE
|
|
|
|
The version number of libssh2 is returned as a pointer to a zero terminated
|
|
string or NULL if the *required_version* is not fulfilled.
|
|
|
|
# EXAMPLE
|
|
|
|
To make sure you run with the correct libssh2 version:
|
|
|
|
~~~c
|
|
if(!libssh2_version(LIBSSH2_VERSION_NUM)) {
|
|
fprintf(stderr, \&"Runtime libssh2 version too old.\&");
|
|
return -1; /* return error */
|
|
}
|
|
~~~
|
|
|
|
Unconditionally get the version number:
|
|
|
|
~~~c
|
|
printf(\&"libssh2 version: %s\&", libssh2_version(0));
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
This function was added in libssh2 1.1, in previous versions there way no way
|
|
to extract this info in run-time.
|