Return to CURLOPT_SSH_KNOWNHOSTS.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSH_KNOWNHOSTS.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
        !             9: .\" *
        !            10: .\" * This software is licensed as described in the file COPYING, which
        !            11: .\" * you should have received as part of this distribution. The terms
        !            12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
        !            13: .\" *
        !            14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
        !            15: .\" * copies of the Software, and permit persons to whom the Software is
        !            16: .\" * furnished to do so, under the terms of the COPYING file.
        !            17: .\" *
        !            18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
        !            19: .\" * KIND, either express or implied.
        !            20: .\" *
        !            21: .\" **************************************************************************
        !            22: .\"
        !            23: .TH CURLOPT_SSH_KNOWNHOSTS 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_SSH_KNOWNHOSTS \- file name holding the SSH known hosts
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_KNOWNHOSTS, char *fname);
        !            31: .SH DESCRIPTION
        !            32: Pass a pointer to a zero terminated string holding the file name of the
        !            33: known_host file to use.  The known_hosts file should use the OpenSSH file
        !            34: format as supported by libssh2. If this file is specified, libcurl will only
        !            35: accept connections with hosts that are known and present in that file, with a
        !            36: matching public key. Use \fICURLOPT_SSH_KEYFUNCTION(3)\fP to alter the default
        !            37: behavior on host and key (mis)matching.
        !            38: 
        !            39: The application does not have to keep the string around after setting this
        !            40: option.
        !            41: .SH DEFAULT
        !            42: NULL
        !            43: .SH PROTOCOLS
        !            44: SFTP and SCP
        !            45: .SH EXAMPLE
        !            46: .nf
        !            47: CURL *curl = curl_easy_init();
        !            48: if(curl) {
        !            49:   curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
        !            50:   curl_easy_setopt(curl, CURLOPT_SSH_KNOWNHOSTS,
        !            51:                    "/home/clarkkent/.ssh/known_hosts");
        !            52:   ret = curl_easy_perform(curl);
        !            53:   curl_easy_cleanup(curl);
        !            54: }
        !            55: .fi
        !            56: .SH AVAILABILITY
        !            57: Added in 7.19.6
        !            58: .SH RETURN VALUE
        !            59: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
        !            60: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
        !            61: .SH "SEE ALSO"
        !            62: .BR CURLOPT_SSH_AUTH_TYPES "(3), " CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 "(3), "