mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
73 lines
1.5 KiB
Markdown
73 lines
1.5 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_TIMECONDITION
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLINFO_FILETIME (3)
|
|
- CURLOPT_TIMEVALUE (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_TIMECONDITION - select condition for a time request
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMECONDITION, long cond);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a long as parameter. This defines how the CURLOPT_TIMEVALUE(3) time
|
|
value is treated. You can set this parameter to *CURL_TIMECOND_IFMODSINCE*
|
|
or *CURL_TIMECOND_IFUNMODSINCE*.
|
|
|
|
The last modification time of a file is not always known and in such instances
|
|
this feature has no effect even if the given time condition would not have
|
|
been met. curl_easy_getinfo(3) with the *CURLINFO_CONDITION_UNMET*
|
|
option can be used after a transfer to learn if a zero-byte successful
|
|
"transfer" was due to this condition not matching.
|
|
|
|
# DEFAULT
|
|
|
|
CURL_TIMECOND_NONE (0)
|
|
|
|
# PROTOCOLS
|
|
|
|
HTTP, FTP, RTSP, and FILE
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
/* January 1, 2020 is 1577833200 */
|
|
curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
|
|
|
|
/* If-Modified-Since the above time stamp */
|
|
curl_easy_setopt(curl, CURLOPT_TIMECONDITION,
|
|
(long)CURL_TIMECOND_IFMODSINCE);
|
|
|
|
/* Perform the request */
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Always
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK
|