From: Daniel Stenberg <daniel@haxx.se>
Date: Thu, 2 Jun 2022 07:30:52 +0000 (+0200)
Subject: CURLOPT_SSH_HOSTKEYDATA/FUNCTION.3: minor polish
X-Git-Tag: curl-7_84_0~95
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=665138b2dd3dbc3f877645c847757edbed54e755;p=thirdparty%2Fcurl.git

CURLOPT_SSH_HOSTKEYDATA/FUNCTION.3: minor polish
---

diff --git a/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3 b/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3
index 412cc364de..bb5235d096 100644
--- a/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3
+++ b/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.3
@@ -38,10 +38,10 @@ NULL
 SCP and SFTP
 .SH EXAMPLE
 .nf
-int sshhostkeycallback(void *clientp,/* custom pointer passed with CURLOPT_SSH_HOSTKEYDATA */
-                          int keytype, /* CURLKHTYPE */
-                          const char * key, /*hostkey to check*/
-                          size_t keylen); /*length of the key*/
+int hostkeycb(void *clientp,    /* passed with CURLOPT_SSH_HOSTKEYDATA */
+              int keytype,      /* CURLKHTYPE */
+              const char * key, /*hostkey to check*/
+              size_t keylen);   /*length of the key*/
 {
   /* 'clientp' points to the callback_data struct */
   /* investigate the situation and return the correct value */
@@ -49,14 +49,14 @@ int sshhostkeycallback(void *clientp,/* custom pointer passed with CURLOPT_SSH_H
 }
 {
   curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/thisfile.txt");
-  curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYFUNCTION, sshhostkeycallback);
+  curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYFUNCTION, hostkeycb);
   curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYDATA, &callback_data);
 
   curl_easy_perform(curl);
 }
 .fi
 .SH AVAILABILITY
-Added in 7.84.0 , work only with libssh2 backend.
+Added in 7.84.0, works only with libssh2 backend.
 .SH RETURN VALUE
 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
 .SH "SEE ALSO"
diff --git a/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYFUNCTION.3 b/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYFUNCTION.3
index c27e2fd099..c5a16a3d96 100644
--- a/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYFUNCTION.3
+++ b/docs/libcurl/opts/CURLOPT_SSH_HOSTKEYFUNCTION.3
@@ -22,29 +22,33 @@
 .\"
 .TH CURLOPT_SSH_HOSTKEYFUNCTION 3 "4 Nov 2021" "libcurl 7.84.0" "curl_easy_setopt options"
 .SH NAME
-CURLOPT_SSH_HOSTKEYFUNCTION \- callback to check hostkey (to overwrite the functionality known_host file)
+CURLOPT_SSH_HOSTKEYFUNCTION \- callback to check hostkey
 .SH SYNOPSIS
 .nf
 #include <curl/curl.h>
 
-int sshhostkeycallback(void *clientp,/* custom pointer passed with CURLOPT_SSH_HOSTKEYDATA */
-                          int keytype, /* CURLKHTYPE */
-                          const char * key, /*hostkey to check*/
-                          size_t keylen); /*length of the key*/
+int keycallback(void *clientp,
+                int keytype,
+                const char *key,
+                size_t keylen);
 
 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_HOSTKEYFUNCTION,
-                          sshhostkeycallback);
+                          keycallback);
 .fi
 .SH DESCRIPTION
 Pass a pointer to your callback function, which should match the prototype
-shown above. It overrides CURLOPT_SSH_KNOWNHOSTS.
+shown above. It overrides \fICURLOPT_SSH_KNOWNHOSTS(3)\fP.
 
-It gets called when the verification of the hostkey is needed.
+This callback gets called when the verification of the SSH hostkey is needed.
 
-This callback function gets passed a custom pointer (set with
-\fICURLOPT_SSH_HOSTKEYDATA(3)\fP, the libcurl keytype, the hostkey,
-the length of the key.
-It MUST return one of the following return codes to tell libcurl how to act:
+\fBkey\fP is \fBkeylen\fP bytes long and is the key to check. \fBkeytype\fP
+says what type it is, from the \fBCURLKHTYPE_*\fP series in the curl_khtype
+enum.
+
+\fBclientp\fP is a custom pointer set with \fICURLOPT_SSH_HOSTKEYDATA(3)\fP.
+
+The callback MUST return one of the following return codes to tell libcurl how
+to act:
 .IP CURLKHMATCH_OK
 The hostkey is accepted, the connexion should continue.
 .IP CURLKHMATCH_MISMATCH
@@ -55,10 +59,10 @@ NULL
 SCP and SFTP
 .SH EXAMPLE
 .nf
-int sshhostkeycallback(void *clientp,/* custom pointer passed with CURLOPT_SSH_HOSTKEYDATA */
-                          int keytype, /* CURLKHTYPE */
-                          const char * key, /*hostkey to check*/
-                          size_t keylen); /*length of the key*/
+int hostkeycb(void *clientp,    /* passed with CURLOPT_SSH_HOSTKEYDATA */
+              int keytype,      /* CURLKHTYPE */
+              const char * key, /*hostkey to check*/
+              size_t keylen);   /*length of the key*/
 {
   /* 'clientp' points to the callback_data struct */
   /* investigate the situation and return the correct value */
@@ -66,7 +70,7 @@ int sshhostkeycallback(void *clientp,/* custom pointer passed with CURLOPT_SSH_H
 }
 {
   curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/thisfile.txt");
-  curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYFUNCTION, sshhostkeycallback);
+  curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYFUNCTION, hostkeycb);
   curl_easy_setopt(curl, CURLOPT_SSH_HOSTKEYDATA, &callback_data);
 
   curl_easy_perform(curl);
@@ -78,3 +82,4 @@ Added in 7.84.0 , work only with libssh2 backend.
 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
 .SH "SEE ALSO"
 .BR CURLOPT_SSH_HOSTKEYDATA "(3), "
+.BR CURLOPT_SSH_KNOWNHOSTS "(3), "