lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-10-24 14:53:03 +03:00
Code Activity
Files
3969991b683efac1d40d76a42af3a47832b85783
libssh2/docs/libssh2_session_hostkey.md
Viktor Szakats b889b39945 docs: convert man page sources to "curldown" format 
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
2025-10-09 04:05:38 +02:00

784 B
Raw Blame History

c, SPDX-License-Identifier, Title, Section, Source, See-also
c SPDX-License-Identifier Title Section Source See-also
Copyright (C) The libssh2 project and its contributors. BSD-3-Clause libssh2_session_hostkey 3 libssh2
libssh2_knownhost_add(3)
libssh2_knownhost_check(3)

NAME

libssh2_session_hostkey - get the remote key

SYNOPSIS

#include <libssh2.h>

const char *
libssh2_session_hostkey(LIBSSH2_SESSION *session,
                        size_t *len, int *type);

DESCRIPTION

Returns a pointer to the current host key, the value len points to will get the length of the key.

The value type points to the type of hostkey which is one of: LIBSSH2_HOSTKEY_TYPE_RSA, LIBSSH2_HOSTKEY_TYPE_DSS (deprecated), or LIBSSH2_HOSTKEY_TYPE_UNKNOWN.

RETURN VALUE

A pointer, or NULL if something went wrong.