1
0
mirror of https://github.com/libssh2/libssh2.git synced 2025-10-26 02:17:35 +03:00
Files
libssh2/docs/libssh2_knownhost_readline.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

47 lines
977 B
Markdown

---
c: Copyright (C) Daniel Stenberg
SPDX-License-Identifier: BSD-3-Clause
Title: libssh2_knownhost_readline
Section: 3
Source: libssh2
See-also:
- libssh2_knownhost_get(3)
- libssh2_knownhost_readfile(3)
- libssh2_knownhost_writeline(3)
---
# NAME
libssh2_knownhost_readline - read a known host line
# SYNOPSIS
~~~c
#include <libssh2.h>
int
libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts,
const char *line, size_t len, int type):
~~~
# DESCRIPTION
Tell libssh2 to read a buffer as it if is a line from a known hosts file.
*line* points to the start of the line
*len* is the length of the line in bytes
*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 regular libssh2 error code, where negative values are error codes
and 0 indicates success.
# AVAILABILITY
Added in libssh2 1.2