Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_APPEND.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2016, 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_APPEND 3 "March 06, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_APPEND \- enable appending to the remote file
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_APPEND, long append);
31 .SH DESCRIPTION
32 A long parameter set to 1 tells the library to append to the remote file
33 instead of overwrite it. This is only useful when uploading to an FTP site.
34 .SH DEFAULT
35 0 (disabled)
36 .SH PROTOCOLS
37 FTP
38 .SH EXAMPLE
39 .nf
40 CURL *curl = curl_easy_init();
41 if(curl) {
42
43   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/to/newfile");
44   curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
45   curl_easy_setopt(curl, CURLOPT_APPEND, 1L);
46
47   curl_easy_perform(curl);
48 }
49 .fi
50 .SH AVAILABILITY
51 This option was known as CURLOPT_FTPAPPEND up to 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_DIRLISTONLY "(3), " CURLOPT_RESUME_FROM "(3), "
56 .BR CURLOPT_UPLOAD "(3), "