CURLOPT_PROTOCOLS.3 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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_PROTOCOLS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROTOCOLS \- allowed protocols
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROTOCOLS, long bitmask);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask
  33. limits what protocols libcurl may use in the transfer. This allows you to have
  34. a libcurl built to support a wide range of protocols but still limit specific
  35. transfers to only be allowed to use a subset of them. By default libcurl will
  36. accept all protocols it supports (\fICURLPROTO_ALL\fP). See also
  37. \fICURLOPT_REDIR_PROTOCOLS(3)\fP.
  38. These are the available protocol defines:
  39. .nf
  40. CURLPROTO_DICT
  41. CURLPROTO_FILE
  42. CURLPROTO_FTP
  43. CURLPROTO_FTPS
  44. CURLPROTO_GOPHER
  45. CURLPROTO_HTTP
  46. CURLPROTO_HTTPS
  47. CURLPROTO_IMAP
  48. CURLPROTO_IMAPS
  49. CURLPROTO_LDAP
  50. CURLPROTO_LDAPS
  51. CURLPROTO_POP3
  52. CURLPROTO_POP3S
  53. CURLPROTO_RTMP
  54. CURLPROTO_RTMPE
  55. CURLPROTO_RTMPS
  56. CURLPROTO_RTMPT
  57. CURLPROTO_RTMPTE
  58. CURLPROTO_RTMPTS
  59. CURLPROTO_RTSP
  60. CURLPROTO_SCP
  61. CURLPROTO_SFTP
  62. CURLPROTO_SMB
  63. CURLPROTO_SMBS
  64. CURLPROTO_SMTP
  65. CURLPROTO_SMTPS
  66. CURLPROTO_TELNET
  67. CURLPROTO_TFTP
  68. .fi
  69. .SH DEFAULT
  70. All protocols built-in
  71. .SH PROTOCOLS
  72. All
  73. .SH EXAMPLE
  74. .nf
  75. curl = curl_easy_init();
  76. if(curl) {
  77. /* pass in the URL from an external source */
  78. curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
  79. /* only allow HTTP, TFTP and SFTP */
  80. curl_easy_setopt(curl, CURLOPT_PROTOCOLS,
  81. CURLPROTO_HTTP | CURLPROTO_TFTP | CURLPROTO_SFTP);
  82. /* Perform the request */
  83. curl_easy_perform(curl);
  84. }
  85. .fi
  86. .SH AVAILABILITY
  87. Added in 7.19.4
  88. .SH RETURN VALUE
  89. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  90. .SH "SEE ALSO"
  91. .BR CURLOPT_REDIR_PROTOCOLS "(3), " CURLOPT_URL "(3), "