summaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_multi_timeout.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2021-10-25 08:54:08 +0200
committerDaniel Stenberg <daniel@haxx.se>2021-10-25 12:57:01 +0200
commit24155569d8a23bcd537d2242318340168e3be249 (patch)
treec2b4a9e992ebc41cf12e4aa2d2eaead73246d901 /docs/libcurl/curl_multi_timeout.3
parentc2e804ca47cc82f5a6fadd6a64841b5977be499a (diff)
downloadcurl-24155569d8a23bcd537d2242318340168e3be249.tar.gz
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
Diffstat (limited to 'docs/libcurl/curl_multi_timeout.3')
-rw-r--r--docs/libcurl/curl_multi_timeout.38
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/libcurl/curl_multi_timeout.3 b/docs/libcurl/curl_multi_timeout.3
index af89eefdf..4f169332c 100644
--- a/docs/libcurl/curl_multi_timeout.3
+++ b/docs/libcurl/curl_multi_timeout.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -65,14 +65,14 @@ timeout.tv_usec = (timeo % 1000) * 1000;
/* wait for activities no longer than the set timeout */
select(maxfd+1, &fdread, &fdwrite, &fdexcep, &timeout);
.fi
-.SH "RETURN VALUE"
-The standard CURLMcode for multi interface error codes.
-.SH "TYPICAL USAGE"
+.SH TYPICAL USAGE
Call \fIcurl_multi_timeout(3)\fP, then wait for action on the sockets. You
figure out which sockets to wait for by calling \fIcurl_multi_fdset(3)\fP or
by a previous call to \fIcurl_multi_socket(3)\fP.
.SH AVAILABILITY
This function was added in libcurl 7.15.4.
+.SH RETURN VALUE
+The standard CURLMcode for multi interface error codes.
.SH "SEE ALSO"
.BR curl_multi_fdset "(3), " curl_multi_info_read "(3), "
.BR curl_multi_socket "(3), " curl_multi_setopt "(3) "