CURLOPT_PREQUOTE.3 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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_PREQUOTE 3 "June 18, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PREQUOTE \- commands to run before an FTP transfer
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PREQUOTE,
  29. struct curl_slist *cmds);
  30. .SH DESCRIPTION
  31. Pass a pointer to a linked list of FTP commands to pass to the server after
  32. the transfer type is set. The linked list should be a fully valid list of
  33. struct curl_slist structs properly filled in as described for
  34. \fICURLOPT_QUOTE(3)\fP. Disable this operation again by setting a NULL to this
  35. option.
  36. While \fICURLOPT_QUOTE(3)\fP and \fICURLOPT_POSTQUOTE(3)\fP work for SFTP,
  37. this option does not.
  38. .SH DEFAULT
  39. NULL
  40. .SH PROTOCOLS
  41. FTP
  42. .SH EXAMPLE
  43. .nf
  44. struct curl_slist *h = NULL;
  45. h = curl_slist_append(h, "SYST");
  46. curl = curl_easy_init();
  47. if(curl) {
  48. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
  49. /* pass in the FTP commands to run */
  50. curl_easy_setopt(curl, CURLOPT_PREQUOTE, headerlist);
  51. ret = curl_easy_perform(curl);
  52. curl_easy_cleanup(curl);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. Along with the protocol support
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  59. .SH "SEE ALSO"
  60. .BR CURLOPT_QUOTE "(3), " CURLOPT_POSTQUOTE "(3), "