aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3
diff options
context:
space:
mode:
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2024-02-28 21:23:34 +0000
committerGerrit Code Review <noreply-gerritcodereview@google.com>2024-02-28 21:23:34 +0000
commit6a9977cde9914ddf75f6debd9810591e5b8f84ef (patch)
tree1b01132e15db02538dcf10922559df5a286d1cd6 /docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3
parente73cfcb7f7f74bf28d5b22092f1fbe4b2e7bfccf (diff)
parent80c3417987dd57711bf1832cc267599b55d1836e (diff)
downloadcurl-simpleperf-release.tar.gz
Merge "Snap for 11510257 from 5a7a71055c2c5ea8e7342422964c47f1e2d03970 to simpleperf-release" into simpleperf-releasesimpleperf-release
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.368
1 files changed, 0 insertions, 68 deletions
diff --git a/docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3 b/docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3
deleted file mode 100644
index a97aa4c1f..000000000
--- a/docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3
+++ /dev/null
@@ -1,68 +0,0 @@
-.\" **************************************************************************
-.\" * _ _ ____ _
-.\" * Project ___| | | | _ \| |
-.\" * / __| | | | |_) | |
-.\" * | (__| |_| | _ <| |___
-.\" * \___|\___/|_| \_\_____|
-.\" *
-.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
-.\" *
-.\" * This software is licensed as described in the file COPYING, which
-.\" * you should have received as part of this distribution. The terms
-.\" * are also available at https://curl.se/docs/copyright.html.
-.\" *
-.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
-.\" * copies of the Software, and permit persons to whom the Software is
-.\" * furnished to do so, under the terms of the COPYING file.
-.\" *
-.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
-.\" * KIND, either express or implied.
-.\" *
-.\" * SPDX-License-Identifier: curl
-.\" *
-.\" **************************************************************************
-.\"
-.TH CURLOPT_SSH_PUBLIC_KEYFILE 3 "19 Jun 2014" libcurl libcurl
-.SH NAME
-CURLOPT_SSH_PUBLIC_KEYFILE \- public key file for SSH auth
-.SH SYNOPSIS
-.nf
-#include <curl/curl.h>
-
-CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PUBLIC_KEYFILE,
- char *filename);
-.SH DESCRIPTION
-Pass a char * pointing to a \fIfilename\fP for your public key. If not used,
-libcurl defaults to \fB$HOME/.ssh/id_dsa.pub\fP if the HOME environment
-variable is set, and just "id_dsa.pub" in the current directory if HOME is not
-set.
-
-If NULL (or an empty string) is passed, libcurl passes no public key to
-libssh2, which then computes it from the private key. This is known to work
-with libssh2 1.4.0+ linked against OpenSSL.
-
-The application does not have to keep the string around after setting this
-option.
-.SH DEFAULT
-NULL
-.SH PROTOCOLS
-SFTP and SCP
-.SH EXAMPLE
-.nf
-CURL *curl = curl_easy_init();
-if(curl) {
- curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
- curl_easy_setopt(curl, CURLOPT_SSH_PUBLIC_KEYFILE,
- "/home/clarkkent/.ssh/id_rsa.pub");
- ret = curl_easy_perform(curl);
- curl_easy_cleanup(curl);
-}
-.fi
-.SH AVAILABILITY
-The "" trick was added in 7.26.0
-.SH RETURN VALUE
-Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
-CURLE_OUT_OF_MEMORY if there was insufficient heap space.
-.SH "SEE ALSO"
-.BR CURLOPT_SSH_PRIVATE_KEYFILE (3),
-.BR CURLOPT_SSH_AUTH_TYPES (3)