docs/libcurl/opts/CURLOPT_KRBLEVEL.3

   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_KRBLEVEL 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_KRBLEVEL \- set FTP kerberos security level
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KRBLEVEL, char *level);
  31 .SH DESCRIPTION
  32 Pass a char * as parameter. Set the kerberos security level for FTP; this also
  33 enables kerberos awareness.  This is a string that should match one of the
  34 following: \&'clear', \&'safe', \&'confidential' or \&'private'.  If the
  35 string is set but doesn't match one of these, 'private' will be used. Set the
  36 string to NULL to disable kerberos support for FTP.
  37
  38 The application does not have to keep the string around after setting this
  39 option.
  40 .SH DEFAULT
  41 NULL
  42 .SH PROTOCOLS
  43 FTP
  44 .SH EXAMPLE
  45 .nf
  46 CURL *curl = curl_easy_init();
  47 if(curl) {
  48   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
  49   curl_easy_setopt(curl, CURLOPT_KRBLEVEL, "private");
  50   ret = curl_easy_perform(curl);
  51   curl_easy_cleanup(curl);
  52 }
  53 .fi
  54 .SH AVAILABILITY
  55 This option was known as CURLOPT_KRB4LEVEL up to 7.16.3
  56 .SH RETURN VALUE
  57 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  58 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  59 .SH "SEE ALSO"
  60 .BR CURLOPT_KRBLEVEL "(3), " CURLOPT_USE_SSL "(3), "