docs/libcurl/opts/CURLOPT_SSH_PUBLIC_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_PUBLIC_KEYFILE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSH_PUBLIC_KEYFILE \- set public 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_PUBLIC_KEYFILE,
  31                           char *filename);
  32 .SH DESCRIPTION
  33 Pass a char * pointing to a \fIfilename\fP for your public key. If not used,
  34 libcurl defaults to \fB$HOME/.ssh/id_dsa.pub\fP if the HOME environment
  35 variable is set, and just "id_dsa.pub" in the current directory if HOME is not
  36 set.
  37
  38 If NULL (or an empty string) is passed, libcurl will pass no public key to
  39 libssh2, which then tries to compute it from the private key.  This is known
  40 to work with libssh2 1.4.0+ linked against OpenSSL.
  41
  42 The application does not have to keep the string around after setting this
  43 option.
  44 .SH DEFAULT
  45 NULL
  46 .SH PROTOCOLS
  47 SFTP and SCP
  48 .SH EXAMPLE
  49 TODO
  50 .SH AVAILABILITY
  51 The "" trick was added in 7.26.0
  52 .SH RETURN VALUE
  53 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  54 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  55 .SH "SEE ALSO"
  56 .BR CURLOPT_SSH_PRIVATE_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "