Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_ALTSVC.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2019, 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_ALTSVC 3 "August 14, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_ALTSVC \- set alt-svc cache file name
! 27: .SH SYNOPSIS
! 28: .nf
! 29: #include <curl/curl.h>
! 30:
! 31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ALTSVC, char *filename);
! 32: .fi
! 33: .SH EXPERIMENTAL
! 34: Warning: this feature is early code and is marked as experimental. It can only
! 35: be enabled by explicitly telling configure with \fB--enable-alt-svc\fP. You are
! 36: advised to not ship this in production before the experimental label is
! 37: removed.
! 38: .SH DESCRIPTION
! 39: Pass in a pointer to a \fIfilename\fP to instruct libcurl to use that file as
! 40: the Alt-Svc cache to read existing cache contents from and possibly also write
! 41: it back to a after a transfer, unless \fBCURLALTSVC_READONLYFILE\fP is set in
! 42: \fICURLOPT_ALTSVC_CTRL(3)\fP.
! 43:
! 44: Specify a blank file name ("") to make libcurl not load from a file at all.
! 45: .SH DEFAULT
! 46: NULL. The alt-svc cache is not read nor written to file.
! 47: .SH PROTOCOLS
! 48: HTTPS
! 49: .SH EXAMPLE
! 50: .nf
! 51: CURL *curl = curl_easy_init();
! 52: if(curl) {
! 53: curl_easy_setopt(curl, CURLOPT_ALTSVC_CTRL, CURLALTSVC_H1);
! 54: curl_easy_setopt(curl, CURLOPT_ALTSVC, "altsvc-cache.txt");
! 55: curl_easy_perform(curl);
! 56: }
! 57: .fi
! 58: .SH AVAILABILITY
! 59: Added in 7.64.1
! 60: .SH RETURN VALUE
! 61: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 62: .SH "SEE ALSO"
! 63: .BR CURLOPT_ALTSVC_CTRL "(3), " CURLOPT_CONNECT_TO "(3), " CURLOPT_RESOLVE "(3), "
! 64: .BR CURLOPT_COOKIEFILE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>