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

988 B

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_readfile

libssh2

libssh2_knownhost_check(3)

libssh2_knownhost_free(3)

libssh2_knownhost_init(3)

NAME

libssh2_knownhost_readfile - parse a file of known hosts

SYNOPSIS

#include <libssh2.h>

int
libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts,
                           const char *filename, int type);

DESCRIPTION

Reads a collection of known hosts from a specified file and adds them to the collection of known hosts.

filename specifies which file to read

type specifies what file type it is, and LIBSSH2_KNOWNHOST_FILE_OPENSSH is the only currently supported format. This file is normally found named ~/.ssh/known_hosts

RETURN VALUE

Returns a negative value, a regular libssh2 error code for errors, or a positive number as number of parsed known hosts in the file.

AVAILABILITY

Added in libssh2 1.2

988 B Raw Blame History