From 2e4074c953e96cadc3182454fd437f9a348e37ce Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 4 Sep 2017 09:20:24 +0200 Subject: docs: curl_mime_*.3 man page formatting edits --- docs/libcurl/curl_mime_data_cb.3 | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) (limited to 'docs/libcurl/curl_mime_data_cb.3') diff --git a/docs/libcurl/curl_mime_data_cb.3 b/docs/libcurl/curl_mime_data_cb.3 index 64e5c7dc0..d0a0c14b1 100644 --- a/docs/libcurl/curl_mime_data_cb.3 +++ b/docs/libcurl/curl_mime_data_cb.3 @@ -38,20 +38,24 @@ void freefunc(void *arg); .BI " curl_free_callback " freefunc ", void * " arg ");" .ad .SH DESCRIPTION -curl_mime_data_cb() sets the data source of a mime part's body content from -a data read callback function. +\fIcurl_mime_data_cb(3)\fP sets the data source of a mime part's body content +from a data read callback function. \fIpart\fP is the part's to assign contents to. -\fIreadfunc\fP is a pointer to a data read callback function, with a -signature as shown by the above prototype. It may not be set to NULL. -\fIseekfunc\fP is a pointer to a seek callback function, with a -signature as shown by the above prototype. This function will be used upon -resending data (i.e.: after a redirect); this pointer may be set to NULL, -in which case a resend is not possible. + +\fIreadfunc\fP is a pointer to a data read callback function, with a signature +as shown by the above prototype. It may not be set to NULL. + +\fIseekfunc\fP is a pointer to a seek callback function, with a signature as +shown by the above prototype. This function will be used upon resending data +(i.e.: after a redirect); this pointer may be set to NULL, in which case a +resend is not possible. + \fIfreefunc\fP is a pointer to a user resource freeing callback function, with -a signature as shown by the above prototype. If no resource is to be freed, -it may safely be set to NULL. This function will be called upon mime -structure freeing. +a signature as shown by the above prototype. If no resource is to be freed, it +may safely be set to NULL. This function will be called upon mime structure +freeing. + \fIarg\fP is a user defined argument to callback functions. The read callback function gets called by libcurl as soon as it needs to -- cgit v1.2.3