mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +08:00
Code Issues Packages Projects Releases Wiki Activity
6bc7191438
curl/docs/libcurl/curl_share_setopt.3

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

62 lines
2.2 KiB
Groff
Raw Normal View History

source header: added to more files
2011-03-12 07:14:32 +08:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205
2023-01-02 20:51:48 +08:00
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
source header: added to more files
2011-03-12 07:14:32 +08:00
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
curl.se: new home Closes #6172
2020-11-04 21:02:01 +08:00
.\" * are also available at https://curl.se/docs/copyright.html.
source header: added to more files
2011-03-12 07:14:32 +08:00
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" * SPDX-License-Identifier: curl
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869
2022-05-17 17:16:50 +08:00
.\" *
source header: added to more files
2011-03-12 07:14:32 +08:00
.\" **************************************************************************
man pages: simplify the .TH sections - remove the version numbers - simplify the texts The date and version number will be put there for releases when maketgz runs the updatemanpages.pl script. Closes #11029
2023-04-26 14:58:35 +08:00
.TH curl_share_setopt 3 "8 Aug 2003" "libcurl" "libcurl"
documenting the share interface
2003-08-11 15:25:02 +08:00
.SH NAME
curl_share_setopt - Set options for a shared object
.SH SYNOPSIS
docs: consistent manpage SYNOPSIS Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
2021-11-26 21:20:18 +08:00
.nf
#include <curl/curl.h>
documenting the share interface
2003-08-11 15:25:02 +08:00
CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, parameter);
docs: consistent manpage SYNOPSIS Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
2021-11-26 21:20:18 +08:00
.fi
documenting the share interface
2003-08-11 15:25:02 +08:00
.SH DESCRIPTION
Set the \fIoption\fP to \fIparameter\fP for the given \fIshare\fP.
.SH OPTIONS
Dominick Meglio's added share interface documentation
2004-02-09 17:07:26 +08:00
.IP CURLSHOPT_LOCKFUNC
curl_share_setopt.3: split out options into their own manpages CURLSHOPT_LOCKFUNC.3 CURLSHOPT_SHARE.3 CURLSHOPT_UNLOCKFUNC.3 CURLSHOPT_UNSHARE.3 CURLSHOPT_USERDATA.3 Closes #7998
2021-11-12 17:56:05 +08:00
See \fICURLSHOPT_LOCKFUNC(3)\fP.
Dominick Meglio's added share interface documentation
2004-02-09 17:07:26 +08:00
.IP CURLSHOPT_UNLOCKFUNC
curl_share_setopt.3: split out options into their own manpages CURLSHOPT_LOCKFUNC.3 CURLSHOPT_SHARE.3 CURLSHOPT_UNLOCKFUNC.3 CURLSHOPT_UNSHARE.3 CURLSHOPT_USERDATA.3 Closes #7998
2021-11-12 17:56:05 +08:00
See \fICURLSHOPT_UNLOCKFUNC(3)\fP.
Dominick Meglio's added share interface documentation
2004-02-09 17:07:26 +08:00
.IP CURLSHOPT_SHARE
curl_share_setopt.3: split out options into their own manpages CURLSHOPT_LOCKFUNC.3 CURLSHOPT_SHARE.3 CURLSHOPT_UNLOCKFUNC.3 CURLSHOPT_UNSHARE.3 CURLSHOPT_USERDATA.3 Closes #7998
2021-11-12 17:56:05 +08:00
See \fICURLSHOPT_SHARE(3)\fP.
Dominick Meglio's added share interface documentation
2004-02-09 17:07:26 +08:00
.IP CURLSHOPT_UNSHARE
curl_share_setopt.3: split out options into their own manpages CURLSHOPT_LOCKFUNC.3 CURLSHOPT_SHARE.3 CURLSHOPT_UNLOCKFUNC.3 CURLSHOPT_UNSHARE.3 CURLSHOPT_USERDATA.3 Closes #7998
2021-11-12 17:56:05 +08:00
See \fICURLSHOPT_UNSHARE(3)\fP.
Dominick Meglio's added share interface documentation
2004-02-09 17:07:26 +08:00
.IP CURLSHOPT_USERDATA
curl_share_setopt.3: refer to CURLSHOPT_USERDATA(3) properly
2021-11-12 22:27:04 +08:00
See \fICURLSHOPT_USERDATA(3)\fP.
man pages: require all to use the same section header order This is the same order we already enforce among the options' man pages: consistency is good. Add lots of previously missing examples. Adjust the manpage-syntax script for this purpose, used in test 1173. Closes #7904
2021-10-25 14:54:08 +08:00
.SH EXAMPLE
.nf
docs: Fix missing semicolon in example code Multiple share examples were missing a semicolon on the line defining the CURLSHcode variable. Closes: #8697 Reported-by: Michael Kaufmann <mail@michael-kaufmann.ch> Reviewed-by: Daniel Stenberg <daniel@haxx.se>
2022-04-16 05:35:15 +08:00
CURLSHcode sh;
man pages: require all to use the same section header order This is the same order we already enforce among the options' man pages: consistency is good. Add lots of previously missing examples. Adjust the manpage-syntax script for this purpose, used in test 1173. Closes #7904
2021-10-25 14:54:08 +08:00
share = curl_share_init();
sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
if(sh)
man pages: fix backslash-n in examples ... to be proper backslash-backslash-n sequences to render nicely in man and on website. Follow-up to 24155569d8a Reported-by: Sergey Markelov Fixes https://github.com/curl/curl-www/issues/163 Closes #7962
2021-11-05 06:48:23 +08:00
printf("Error: %s\\n", curl_share_strerror(sh));
man pages: require all to use the same section header order This is the same order we already enforce among the options' man pages: consistency is good. Add lots of previously missing examples. Adjust the manpage-syntax script for this purpose, used in test 1173. Closes #7904
2021-10-25 14:54:08 +08:00
.fi
.SH AVAILABILITY
docs: consistent use of "Added in" Make them all say "Added in [version]" without using 'curl' or 'libcurl' in that phrase.
2021-10-25 17:45:09 +08:00
Added in 7.10
Dominick Meglio's added share interface documentation
2004-02-09 17:07:26 +08:00
.SH RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP
man page for the full list with descriptions.
documenting the share interface
2003-08-11 15:25:02 +08:00
.SH "SEE ALSO"
.BR curl_share_cleanup "(3), " curl_share_init "(3)"
Reference in New Issue Copy Permalink