Added man pages for the two newest members of the knownhosts API family:
libssh2_knownhost_readline() and libssh2_knownhost_writeline()
Этот коммит содержится в:
родитель
1afbbf4507
Коммит
2e990194ab
@ -41,7 +41,9 @@ dist_man_MANS = \
|
||||
libssh2_knownhost_get.3 \
|
||||
libssh2_knownhost_init.3 \
|
||||
libssh2_knownhost_readfile.3 \
|
||||
libssh2_knownhost_readline.3 \
|
||||
libssh2_knownhost_writefile.3 \
|
||||
libssh2_knownhost_writeline.3 \
|
||||
libssh2_new_host_entry.3 \
|
||||
libssh2_poll.3 \
|
||||
libssh2_poll_channel_read.3 \
|
||||
|
30
docs/libssh2_knownhost_readline.3
Обычный файл
30
docs/libssh2_knownhost_readline.3
Обычный файл
@ -0,0 +1,30 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2009 by Daniel Stenberg
|
||||
.\"
|
||||
.TH libssh2_knownhost_readline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
|
||||
.SH NAME
|
||||
libssh2_knownhost_readline - read a known host line
|
||||
.SH SYNOPSIS
|
||||
#include <libssh2.h>
|
||||
|
||||
int libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts,
|
||||
const char *line, size_t len, int type):
|
||||
.SH DESCRIPTION
|
||||
Tell libssh2 to read a buffer as it if is a line from a known hosts file.
|
||||
|
||||
\fIline\fP points to the start of the line
|
||||
|
||||
\fIlen\fP is the length of the line in bytes
|
||||
|
||||
\fItype\fP specifies what file type it is, and
|
||||
\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported
|
||||
format. This file is normally found named ~/.ssh/known_hosts
|
||||
.SH RETURN VALUE
|
||||
Returns a regular libssh2 error code, where negative values are error codes
|
||||
and 0 indicates success.
|
||||
.SH AVAILABILITY
|
||||
Added in libssh2 1.2
|
||||
.SH SEE ALSO
|
||||
.BR libssh2_knownhost_get(3)
|
||||
.BR libssh2_knownhost_writeline(3)
|
||||
.BR libssh2_knownhost_readfile(3)
|
45
docs/libssh2_knownhost_writeline.3
Обычный файл
45
docs/libssh2_knownhost_writeline.3
Обычный файл
@ -0,0 +1,45 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2009 by Daniel Stenberg
|
||||
.\"
|
||||
.TH libssh2_knownhost_writeline 3 "28 May 2009" "libssh2 1.2" "libssh2 manual"
|
||||
.SH NAME
|
||||
libssh2_knownhost_writeline - convert a known host to a line for storage
|
||||
.SH SYNOPSIS
|
||||
#include <libssh2.h>
|
||||
|
||||
libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,
|
||||
struct libssh2_knownhost *known,
|
||||
char *buffer, size_t buflen,
|
||||
size_t *outlen,
|
||||
int type);
|
||||
.SH DESCRIPTION
|
||||
Converts a single known host to a single line of output for storage, using
|
||||
the 'type' output format.
|
||||
|
||||
\fIknown\fP identifies which particular known host
|
||||
|
||||
\fIbuffer\fP points to an allocated buffer
|
||||
|
||||
\fIbuflen\fP is the size of the \fIbuffer\fP. See RETURN VALUE about the size.
|
||||
|
||||
\fIoutlen\fP must be a pointer to a size_t variable that will get the output
|
||||
length stored
|
||||
|
||||
\fItype\fP specifies what file type it is, and
|
||||
\fILIBSSH2_KNOWNHOST_FILE_OPENSSH\fP is the only currently supported
|
||||
format.
|
||||
.SH 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 adviced to call the function again with a larger buffer. The
|
||||
\fIoutlen\fP size will then hold the requested size.
|
||||
.SH AVAILABILITY
|
||||
Added in libssh2 1.2
|
||||
.SH SEE ALSO
|
||||
.BR libssh2_knownhost_get(3)
|
||||
.BR libssh2_knownhost_readline(3)
|
||||
.BR libssh2_knownhost_writefile(3)
|
||||
|
Загрузка…
x
Ссылка в новой задаче
Block a user