1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-02 22:02:25 +03:00
Files
libssh2/docs/libssh2_session_hostkey.3
Viktor Szakats 592e2b37fa docs: simplify .TH header & other cleanups [ci skip]
- simplify `.TH` headers.
- delete empty lines before sections.
- update template with an `AVAILABILITY` section.

Left libssh2 version number in the `.TH` header for entries without an
`AVAILABILITY` section, or where there was a different version number
there.
2023-04-26 17:55:51 +00:00

25 lines
687 B
Groff

.TH libssh2_session_hostkey 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
.SH NAME
libssh2_session_hostkey - get the remote key
.SH SYNOPSIS
.nf
#include <libssh2.h>
const char *
libssh2_session_hostkey(LIBSSH2_SESSION *session,
size_t *len, int *type);
.fi
.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)