docs/libcurl/opts/CURLOPT_REDIR_PROTOCOLS.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 http://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_REDIR_PROTOCOLS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_REDIR_PROTOCOLS \- set protocols allowed to redirect to
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REDIR_PROTOCOLS, long bitmask);
  30 .SH DESCRIPTION
  31 Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask
  32 limits what protocols libcurl may use in a transfer that it follows to in a
  33 redirect when \fICURLOPT_FOLLOWLOCATION(3)\fP is enabled. This allows you to
  34 limit specific transfers to only be allowed to use a subset of protocols in
  35 redirections. By default libcurl will allow all protocols except for FILE and
  36 SCP.
  37 .SH DEFAULT
  38 All protocols except for FILE and SCP
  39 .SH PROTOCOLS
  40 All
  41 .SH EXAMPLE
  42 TODO
  43 .SH AVAILABILITY
  44 Added in 7.19.4, before then it would follow all protcols.
  45 .SH RETURN VALUE
  46 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  47 .SH "SEE ALSO"
  48 .BR CURLOPT_PROTOCOLS "(3), "