CURLOPT_QUOTE.3 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  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_QUOTE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_QUOTE \- (S)FTP commands to run before transfer
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_QUOTE, struct curl_slist *cmds);
  29. .SH DESCRIPTION
  30. Pass a pointer to a linked list of FTP or SFTP commands to pass to the server
  31. prior to your request. This will be done before any other commands are issued
  32. (even before the CWD command for FTP). The linked list should be a fully valid
  33. list of 'struct curl_slist' structs properly filled in with text strings. Use
  34. \fIcurl_slist_append(3)\fP to append strings (commands) to the list, and clear
  35. the entire list afterwards with \fIcurl_slist_free_all(3)\fP. Disable this
  36. operation again by setting a NULL to this option. When speaking to a FTP
  37. server, prefix the command with an asterisk (*) to make libcurl continue even
  38. if the command fails as by default libcurl will stop at first failure.
  39. The set of valid FTP commands depends on the server (see RFC959 for a list of
  40. mandatory commands).
  41. The valid SFTP commands are:
  42. .RS
  43. .IP "chgrp group file"
  44. The chgrp command sets the group ID of the file named by the file operand to
  45. the group ID specified by the group operand. The group operand is a decimal
  46. integer group ID.
  47. .IP "chmod mode file"
  48. The chmod command modifies the file mode bits of the specified file. The
  49. mode operand is an octal integer mode number.
  50. .IP "chown user file"
  51. The chown command sets the owner of the file named by the file operand to the
  52. user ID specified by the user operand. The user operand is a decimal
  53. integer user ID.
  54. .IP "ln source_file target_file"
  55. The ln and symlink commands create a symbolic link at the target_file location
  56. pointing to the source_file location.
  57. .IP "mkdir directory_name"
  58. The mkdir command creates the directory named by the directory_name operand.
  59. .IP "pwd"
  60. The pwd command returns the absolute pathname of the current working directory.
  61. .IP "rename source target"
  62. The rename command renames the file or directory named by the source
  63. operand to the destination path named by the target operand.
  64. .IP "rm file"
  65. The rm command removes the file specified by the file operand.
  66. .IP "rmdir directory"
  67. The rmdir command removes the directory entry specified by the directory
  68. operand, provided it is empty.
  69. .IP "symlink source_file target_file"
  70. See ln.
  71. .RE
  72. .SH DEFAULT
  73. NULL
  74. .SH PROTOCOLS
  75. SFTP and FTP
  76. .SH EXAMPLE
  77. TODO
  78. .SH AVAILABILITY
  79. SFTP support added in 7.16.3. *-prefix for SFTP added in 7.24.0
  80. .SH RETURN VALUE
  81. Returns CURLE_OK
  82. .SH "SEE ALSO"
  83. .BR CURLOPT_POSTQUOTE "(3), " CURLOPT_PREQUOTE "(3), "