Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_NEW_DIRECTORY_PERMS.3
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_NEW_DIRECTORY_PERMS 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_NEW_DIRECTORY_PERMS \- permissions for remotely created directories
27 .SH SYNOPSIS
28 .nf
29 #include <curl/curl.h>
30
31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NEW_DIRECTORY_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 directories on the remote server.  The default value is
36 \fI0755\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 0755
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/newdir/file.zip");
48   curl_easy_setopt(curl, CURLOPT_FTP_CREATE_MISSING_DIRS, 1L);
49   curl_easy_setopt(curl, CURLOPT_NEW_DIRECTORY_PERMS, 0644L);
50   ret = curl_easy_perform(curl);
51 }
52 .fi
53 .SH AVAILABILITY
54 Added in 7.16.4
55 .SH RETURN VALUE
56 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
57 .SH "SEE ALSO"
58 .BR CURLOPT_NEW_FILE_PERMS "(3), " CURLOPT_UPLOAD "(3), "