mirror of
https://github.com/curl/curl.git
synced 2026-05-27 12:56:21 +03:00
eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
76 lines
1.7 KiB
Markdown
76 lines
1.7 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_SSH_PRIVATE_KEYFILE
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_SSH_AUTH_TYPES (3)
|
|
- CURLOPT_SSH_PUBLIC_KEYFILE (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_SSH_PRIVATE_KEYFILE - private key file for SSH auth
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
|
|
char *filename);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a char pointer pointing to a *filename* for your private key. If not
|
|
used, libcurl defaults to **$HOME/.ssh/id_rsa** or **$HOME/.ssh/id_dsa** if
|
|
the HOME environment variable is set, and in the current directory if HOME is
|
|
not set.
|
|
|
|
If the file is password-protected, set the password with
|
|
CURLOPT_KEYPASSWD(3).
|
|
|
|
The SSH library derives the public key from this private key when possible. If
|
|
the SSH library cannot derive the public key from the private one and no
|
|
public one is provided with CURLOPT_SSH_PUBLIC_KEYFILE(3), the transfer
|
|
fails.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
# DEFAULT
|
|
|
|
As explained above
|
|
|
|
# PROTOCOLS
|
|
|
|
SFTP and SCP
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com/file");
|
|
curl_easy_setopt(curl, CURLOPT_SSH_PRIVATE_KEYFILE,
|
|
"/home/clarkkent/.ssh/id_rsa");
|
|
curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "password");
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.16.1
|
|
|
|
# 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.
|