mirror of https://github.com/libssh2/libssh2.git synced 2025-10-24 14:53:03 +03:00

Files

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

1.1 KiB

Raw Blame History

c, SPDX-License-Identifier, Title, Section, Source, See-also

SPDX-License-Identifier

Title

Section

Source

See-also

BSD-3-Clause

libssh2_knownhost_get

libssh2

libssh2_knownhost_add(3)

libssh2_knownhost_readfile(3)

libssh2_knownhost_writefile(3)

NAME

libssh2_knownhost_get - get a known host off the collection of known hosts

SYNOPSIS

#include <libssh2.h>

int
libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts,
                      struct libssh2_knownhost **store,
                      struct libssh2_knownhost *prev):

DESCRIPTION

libssh2_knownhost_get(3) allows an application to iterate over all known hosts in the collection.

store should point to a pointer that gets filled in to point to the known host data.

prev is a pointer to a previous 'struct libssh2_knownhost' as returned by a previous invoke of this function, or NULL to get the first entry in the internal collection.

RETURN VALUE

Returns 0 if everything is fine and information about a host was stored in the store struct.

Returns 1 if it reached the end of hosts.

Returns negative values for error

AVAILABILITY

Added in libssh2 1.2

1.1 KiB Raw Blame History