docs/libcurl/opts/CURLOPT_POSTQUOTE.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_POSTQUOTE 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_POSTQUOTE \- (S)FTP commands to run after the transfer
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_POSTQUOTE, struct curl_slist *cmds);
  31 .SH DESCRIPTION
  32 Pass a pointer to a linked list of FTP or SFTP commands to pass to the server
  33 after your FTP transfer request. The commands will only be run if no error
  34 occurred. The linked list should be a fully valid list of struct curl_slist
  35 structs properly filled in as described for \fICURLOPT_QUOTE(3)\fP.
  36
  37 Disable this operation again by setting a NULL to this option.
  38 .SH DEFAULT
  39 NULL
  40 .SH PROTOCOLS
  41 SFTP and FTP
  42 .SH EXAMPLE
  43 .nf
  44 struct curl_slist *h = NULL;
  45 h = curl_slist_append(h, "RNFR source-name");
  46 h = curl_slist_append(h, "RNTO new-name");
  47
  48 curl = curl_easy_init();
  49 if(curl) {
  50   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
  51
  52   /* pass in the FTP commands to run after the transfer */
  53   curl_easy_setopt(curl, CURLOPT_POSTQUOTE, headerlist);
  54
  55   ret = curl_easy_perform(curl);
  56
  57   curl_easy_cleanup(curl);
  58 }
  59 .fi
  60 .SH AVAILABILITY
  61 If support for the protocols are built-in.
  62 .SH RETURN VALUE
  63 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  64 .SH "SEE ALSO"
  65 .BR CURLOPT_QUOTE "(3), " CURLOPT_PREQUOTE "(3), "