- Added CURLFORM_STREAM as a supported option to curl_formadd() to allow an

  application to provide data for a multipart with the read callback. Note
  that the size needs to be provided with CURLFORM_CONTENTSLENGTH when the
  stream option is used. This feature is verified by the new test case
  554. This feature was sponsored by Xponaut.

1 files changed, 11 insertions, 18 deletions

diff --git a/docs/libcurl/curl_formadd.3 b/docs/libcurl/curl_formadd.3
index 8508dd411..f3cea0054 100644
--- a/docs/libcurl/curl_formadd.3
+++ b/docs/libcurl/curl_formadd.3
@@ -38,9 +38,7 @@ parts you want to add to your post.
 The options listed first are for making normal parts. The options from
 \fICURLFORM_FILE\fP through \fICURLFORM_BUFFERLENGTH\fP are for file upload
 parts.
-
 .SH OPTIONS
-
 .IP CURLFORM_COPYNAME
 followed by a string which provides the \fIname\fP of this part. libcurl
 copies the string so your application doesn't need to keep it around after
@@ -48,14 +46,12 @@ this function call. If the name isn't NUL-terminated, or if you'd
 like it to contain zero bytes, you must set its length with
 \fBCURLFORM_NAMELENGTH\fP. The copied data will be freed by
 \fIcurl_formfree(3)\fP.
-
 .IP CURLFORM_PTRNAME
 followed by a string which provides the \fIname\fP of this part. libcurl
 will use the pointer and refer to the data in your application, so you
 must make sure it remains until curl no longer needs it. If the name
 isn't NUL-terminated, or if you'd like it to contain zero
 bytes, you must set its length with \fBCURLFORM_NAMELENGTH\fP.
-
 .IP CURLFORM_COPYCONTENTS
 followed by a pointer to the contents of this part, the actual data
 to send away. libcurl copies the provided data, so your application doesn't
@@ -63,57 +59,55 @@ need to keep it around after this function call. If the data isn't null
 terminated, or if you'd like it to contain zero bytes, you must
 set the length of the name with \fBCURLFORM_CONTENTSLENGTH\fP. The copied
 data will be freed by \fIcurl_formfree(3)\fP.
-
 .IP CURLFORM_PTRCONTENTS
 followed by a pointer to the contents of this part, the actual data
 to send away. libcurl will use the pointer and refer to the data in your
 application, so you must make sure it remains until curl no longer needs it.
 If the data isn't NUL-terminated, or if you'd like it to contain zero bytes,
 you must set its length  with \fBCURLFORM_CONTENTSLENGTH\fP.
-
 .IP CURLFORM_CONTENTSLENGTH
-followed by a long giving the length of the contents.
-
+followed by a long giving the length of the contents. Note that for
+\fICURLFORM_STREAM\fP contents, this option is mandatory.
 .IP CURLFORM_FILECONTENT
 followed by a filename, causes that file to be read and its contents used
 as data in this part. This part does \fInot\fP automatically become a file
 upload part simply because its data was read from a file.
-
 .IP CURLFORM_FILE
 followed by a filename, makes this part a file upload part. It sets the
 \fIfilename\fP field to the basename of the provided filename, it reads the
 contents of the file and passes them as data and sets the content-type if the
 given file match one of the internally known file extensions.  For
 \fBCURLFORM_FILE\fP the user may send one or more files in one part by
-providing multiple \fBCURLFORM_FILE\fP arguments each followed by the
-filename (and each CURLFORM_FILE is allowed to have a CURLFORM_CONTENTTYPE).
-
+providing multiple \fBCURLFORM_FILE\fP arguments each followed by the filename
+(and each \fICURLFORM_FILE\fP is allowed to have a
+\fICURLFORM_CONTENTTYPE\fP).
 .IP CURLFORM_CONTENTTYPE
 is used in combination with \fICURLFORM_FILE\fP. Followed by a pointer to a
 string which provides the content-type for this part, possibly instead of an
 internally chosen one.
-
 .IP CURLFORM_FILENAME
 is used in combination with \fICURLFORM_FILE\fP. Followed by a pointer to a
 string, it tells libcurl to use the given string as the \fIfilename\fP in the
 file upload part instead of the actual file name.
-
 .IP CURLFORM_BUFFER
 is used for custom file upload parts without use of \fICURLFORM_FILE\fP.  It
 tells libcurl that the file contents are already present in a buffer.  The
 parameter is a string which provides the \fIfilename\fP field in the content
 header.
-
 .IP CURLFORM_BUFFERPTR
 is used in combination with \fICURLFORM_BUFFER\fP. The parameter is a pointer
 to the buffer to be uploaded. This buffer must not be freed until after
 \fIcurl_easy_cleanup(3)\fP is called. You must also use
 \fICURLFORM_BUFFERLENGTH\fP to set the number of bytes in the buffer.
-
 .IP CURLFORM_BUFFERLENGTH
 is used in combination with \fICURLFORM_BUFFER\fP. The parameter is a
 long which gives the length of the buffer.
-
+.IP CURLFORM_STREAM
+Tells libcurl to use the \fICURLOPT_READFUNCTION\fP callback to get data. The
+parameter you pass to \fICURLFORM_STREAM\fP is the pointer passed on to the
+read callback's fourth argument. If you want the part to look like a file
+upload one, set the \fICURLFORM_FILENAME\fP parameter as well. (Option added
+in libcurl 7.18.2)
 .IP CURLFORM_ARRAY
 Another possibility to send options to curl_formadd() is the
 \fBCURLFORM_ARRAY\fP option, that passes a struct curl_forms array pointer as
@@ -121,7 +115,6 @@ its value. Each curl_forms structure element has a CURLformoption and a char
 pointer. The final element in the array must be a CURLFORM_END. All available
 options can be used in an array, except the CURLFORM_ARRAY option itself!  The
 last argument in such an array must always be \fBCURLFORM_END\fP.
-
 .IP CURLFORM_CONTENTHEADER
 specifies extra headers for the form POST section.  This takes a curl_slist
 prepared in the usual way using \fBcurl_slist_append\fP and appends the list