Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CURLOPT_QUOTE(3)	   curl_easy_setopt options	      CURLOPT_QUOTE(3)

NAME
       CURLOPT_QUOTE - (S)FTP commands to run before transfer

SYNOPSIS
       #include	<curl/curl.h>

       CURLcode	   curl_easy_setopt(CURL    *handle,   CURLOPT_QUOTE,	struct
       curl_slist *cmds);

DESCRIPTION
       Pass a pointer to a linked list of FTP or SFTP commands to pass to  the
       server  prior  to your request. This will be done before	any other com-
       mands are issued	(even before the CWD command for FTP). The linked list
       should  be  a  fully valid list of 'struct curl_slist' structs properly
       filled in with text strings. Use	curl_slist_append(3) to	append strings
       (commands)  to  the  list,  and	clear  the entire list afterwards with
       curl_slist_free_all(3). Disable this operation again by setting a  NULL
       to this option. When speaking to	an FTP server, prefix the command with
       an asterisk (*) to make libcurl continue	even if	the command  fails  as
       by default libcurl will stop at first failure.

       The  set	 of valid FTP commands depends on the server (see RFC959 for a
       list of mandatory commands).

       The valid SFTP commands are:

	      atime date file
		     The atime command sets the	last access time of  the  file
		     named  by	the file operand. The <date expression>	can be
		     all sorts of date strings,	see  the  curl_getdate(3)  man
		     page for date expression details. (Added in 7.73.0)

	      chgrp group file
		     The  chgrp	command	sets the group ID of the file named by
		     the file operand to the group ID specified	by  the	 group
		     operand. The group	operand	is a decimal integer group ID.

	      chmod mode file
		     The  chmod	 command  modifies  the	 file mode bits	of the
		     specified file. The mode operand is an octal integer mode
		     number.

	      chown user file
		     The chown command sets the	owner of the file named	by the
		     file operand to the user ID specified by the  user	 oper-
		     and. The user operand is a	decimal	integer	user ID.

	      ln source_file target_file
		     The ln and	symlink	commands create	a symbolic link	at the
		     target_file location pointing to  the  source_file	 loca-
		     tion.

	      mkdir directory_name
		     The  mkdir	command	creates	the directory named by the di-
		     rectory_name operand.

	      mtime date file
		     The mtime command sets the	last modification time of  the
		     file named	by the file operand. The <date expression> can
		     be	all sorts of date strings, see the curl_getdate(3) man
		     page for date expression details. (Added in 7.73.0)

	      pwd    The pwd command returns the absolute pathname of the cur-
		     rent working directory.

	      rename source target
		     The rename	command	renames	the file or directory named by
		     the  source  operand to the destination path named	by the
		     target operand.

	      rm file
		     The rm command removes the	file specified by the file op-
		     erand.

	      rmdir directory
		     The  rmdir	 command removes the directory entry specified
		     by	the directory operand, provided	it is empty.

	      statvfs file
		     The statvfs command returns statistics on the file	system
		     in	which specified	file resides. (Added in	7.49.0)

	      symlink source_file target_file
		     See ln.

DEFAULT
       NULL

PROTOCOLS
       SFTP and	FTP

EXAMPLE
       struct curl_slist *cmdlist = NULL;
       cmdlist = curl_slist_append(cmdlist, "RNFR source-name");
       cmdlist = curl_slist_append(cmdlist, "RNTO new-name");

       curl = curl_easy_init();
       if(curl)	{
	 curl_easy_setopt(curl,	CURLOPT_URL, "ftp://example.com/foo.bin");

	 /* pass in the	FTP commands to	run before the transfer	*/
	 curl_easy_setopt(curl,	CURLOPT_QUOTE, cmdlist);

	 ret = curl_easy_perform(curl);

	 curl_easy_cleanup(curl);
       }

AVAILABILITY
       SFTP support added in 7.16.3. *-prefix for SFTP added in	7.24.0

RETURN VALUE
       Returns CURLE_OK

SEE ALSO
       CURLOPT_POSTQUOTE(3), CURLOPT_PREQUOTE(3),

libcurl	7.74.0		       November	04, 2020	      CURLOPT_QUOTE(3)

NAME | SYNOPSIS | DESCRIPTION | DEFAULT | PROTOCOLS | EXAMPLE | AVAILABILITY | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CURLOPT_QUOTE&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help