mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-17 04:22:32 +03:00
b889b39945
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
62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_knownhost_writeline
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_knownhost_get(3)
|
|
- libssh2_knownhost_readline(3)
|
|
- libssh2_knownhost_writefile(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_knownhost_writeline - convert a known host to a line for storage
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,
|
|
struct libssh2_knownhost *known,
|
|
char *buffer, size_t buflen,
|
|
size_t *outlen,
|
|
int type);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Converts a single known host to a single line of output for storage, using
|
|
the 'type' output format.
|
|
|
|
*known* identifies which particular known host
|
|
|
|
*buffer* points to an allocated buffer
|
|
|
|
*buflen* is the size of the *buffer*. See RETURN VALUE about the size.
|
|
|
|
*outlen* must be a pointer to a size_t variable that will get the output
|
|
length of the stored data chunk. The number does not included the trailing
|
|
zero!
|
|
|
|
*type* specifies what file type it is, and
|
|
*LIBSSH2_KNOWNHOST_FILE_OPENSSH* is the only currently supported
|
|
format.
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns a regular libssh2 error code, where negative values are error codes
|
|
and 0 indicates success.
|
|
|
|
If the provided buffer is deemed too small to fit the data libssh2 wants to
|
|
store in it, LIBSSH2_ERROR_BUFFER_TOO_SMALL will be returned. The application
|
|
is then advised to call the function again with a larger buffer. The
|
|
*outlen* size will then hold the requested size.
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in libssh2 1.2
|