docs/libcurl/opts/CURLOPT_SSH_PRIVATE_KEYFILE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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_PRIVATE_KEYFILE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSH_PRIVATE_KEYFILE \- set private key file for SSH auth
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_PRIVATE_KEYFILE,
  31                           char *filename);
  32 .SH DESCRIPTION
  33 Pass a char * pointing to a \fIfilename\fP for your private key. If not used,
  34 libcurl defaults to \fB$HOME/.ssh/id_dsa\fP if the HOME environment variable
  35 is set, and just "id_dsa" in the current directory if HOME is not set.
  36
  37 If the file is password-protected, set the password with
  38 \fICURLOPT_KEYPASSWD(3)\fP.
  39 .SH DEFAULT
  40 As explained above
  41 .SH PROTOCOLS
  42 SFTP and SCP
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 Added in 7.16.1
  47 .SH RETURN VALUE
  48 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  49 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  50 .SH "SEE ALSO"
  51 .BR CURLOPT_SSH_PUBLIC_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "