CURLOPT_NEW_FILE_PERMS.3 2.1 KB

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