CURLOPT_NEW_FILE_PERMS.3 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_NEW_FILE_PERMS 3 "19 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_NEW_FILE_PERMS \- permissions for remotely created files
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NEW_FILE_PERMS,
  32. long mode);
  33. .SH DESCRIPTION
  34. Pass a long as a parameter, containing the value of the permissions that will
  35. be assigned to newly created files on the remote server. The default value is
  36. \fI0644\fP, but any valid value can be used. The only protocols that can use
  37. this are \fIsftp://\fP, \fIscp://\fP, and \fIfile://\fP.
  38. .SH DEFAULT
  39. 0644
  40. .SH PROTOCOLS
  41. SFTP, SCP and FILE
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. CURLcode ret;
  47. curl_easy_setopt(curl, CURLOPT_URL, "sftp://upload.example.com/file.txt");
  48. curl_easy_setopt(curl, CURLOPT_NEW_FILE_PERMS, 0664L);
  49. ret = curl_easy_perform(curl);
  50. }
  51. .fi
  52. .SH AVAILABILITY
  53. Added in 7.16.4
  54. .SH RETURN VALUE
  55. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  56. .SH "SEE ALSO"
  57. .BR CURLOPT_NEW_DIRECTORY_PERMS "(3), " CURLOPT_UPLOAD "(3), "