diff --git a/docs/Makefile.am b/docs/Makefile.am index 3de2caa..bbeee02 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -40,6 +40,7 @@ dist_man_MANS = \ libssh2_knownhost_del.3 \ libssh2_knownhost_get.3 \ libssh2_knownhost_init.3 \ + libssh2_knownhost_free.3 \ libssh2_knownhost_readfile.3 \ libssh2_knownhost_readline.3 \ libssh2_knownhost_writefile.3 \ diff --git a/docs/libssh2_knownhost_free.3 b/docs/libssh2_knownhost_free.3 new file mode 100644 index 0000000..fd7b679 --- /dev/null +++ b/docs/libssh2_knownhost_free.3 @@ -0,0 +1,21 @@ +.\" +.\" Copyright (c) 2009 by Daniel Stenberg +.\" +.TH libssh2_knownhost_free 3 "28 May 2009" "libssh2 1.2" "libssh2 manual" +.SH NAME +libssh2_knownhost_free - free a collection of known hosts +.SH SYNOPSIS +#include + +void libssh2_knownhost_free(LIBSSH2_KNOWNHOSTS *hosts); +.SH DESCRIPTION +Free a collection of known hosts. +.SH RETURN VALUE +Returns a handle pointer or NULL if something went wrong. The returned handle +is used as input to all other known host related functions libssh2 provides. +.SH AVAILABILITY +Added in libssh2 1.2 +.SH SEE ALSO +.BR libssh2_knownhost_init(3) +.BR libssh2_knownhost_add(3) +.BR libssh2_knownhost_check(3) diff --git a/docs/libssh2_knownhost_init.3 b/docs/libssh2_knownhost_init.3 index 52518f0..145f10c 100644 --- a/docs/libssh2_knownhost_init.3 +++ b/docs/libssh2_knownhost_init.3 @@ -11,6 +11,9 @@ LIBSSH2_KNOWNHOSTS *libssh2_knownhost_init(LIBSSH2_SESSION *session); .SH DESCRIPTION Init a collection of known hosts for this session. Returns the handle to an internal representation of a known host collection. + +Call \fBlibssh2_knownhost_free(3)\fP to free the collection again after you're +doing using it. .SH RETURN VALUE Returns a handle pointer or NULL if something went wrong. The returned handle is used as input to all other known host related functions libssh2 provides.