]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: fix mandoc -T lint formatting complaints
authorDaniel Stenberg <daniel@haxx.se>
Wed, 5 Jan 2022 15:51:24 +0000 (16:51 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 5 Jan 2022 21:45:02 +0000 (22:45 +0100)
Closes #8228

docs/libcurl/curl_global_init_mem.3
docs/libcurl/curl_share_init.3
docs/libcurl/curl_share_strerror.3
docs/libcurl/curl_unescape.3
docs/libcurl/libcurl.3
docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3
docs/libcurl/opts/CURLOPT_WILDCARDMATCH.3

index 3e747ca62904ea4863c5ae3a4e116f191eda85c1..9b8b4bffcd338013e9d5fe29d33c4aabfe270dc8 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2022, 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
@@ -55,7 +55,7 @@ To replace realloc()
 To replace strdup()
 .IP "void *calloc_callback(size_t nmemb, size_t size);"
 To replace calloc()
-.RE
+.PP
 This function is otherwise the same as \fIcurl_global_init(3)\fP, please refer
 to that man page for documentation.
 .SH CAUTION
index df61fb09989c4097d3b7d06b1fbe1138d14774bc..aaa130bed2170df16154636b594bf404a993806a 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2022, 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
@@ -19,7 +19,7 @@
 .\" * KIND, either express or implied.
 .\" *
 .\" **************************************************************************
-.TH curl_share_init 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl Manual"
+.TH curl_share_init 3 "Aug 3, 2003" "libcurl 7.10.7" "libcurl Manual"
 .SH NAME
 curl_share_init - Create a shared object
 .SH SYNOPSIS
index 08a9dba299e60fc7b60e81270cdfc339c5a6bc9c..1d5ce3a2b4bfb08c12c5de0018bf85afd849d95e 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2022, 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
@@ -19,7 +19,7 @@
 .\" * KIND, either express or implied.
 .\" *
 .\" **************************************************************************
-.TH curl_share_strerror 3 "26 Apr 2004" "libcurl 7.12" "libcurl Manual"
+.TH curl_share_strerror 3 "Apr 26, 2004" "libcurl 7.12" "libcurl Manual"
 .SH NAME
 curl_share_strerror - return string describing error code
 .SH SYNOPSIS
index 23b9f705379a24c23f299e8eee90cf93eb681e50..2a864ef47e72f9c91b29a60a2f76035a938c3704 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2022, 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
@@ -60,4 +60,4 @@ be removed in a future release.
 .SH RETURN VALUE
 A pointer to a null-terminated string or NULL if it failed.
 .SH "SEE ALSO"
-.br curl_easy_escape "(3)," curl_easy_unescape "(3)," curl_free "(3)," RFC 2396
+.BR curl_easy_escape "(3)," curl_easy_unescape "(3)," curl_free "(3)," RFC 2396
index b293846f90c37e79b969ea4791b7ca37e447014f..b500e1cdea0a2102e80492410b40e87e00c6c26d 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2022, 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
@@ -19,7 +19,7 @@
 .\" * KIND, either express or implied.
 .\" *
 .\" **************************************************************************
-.TH libcurl 3 "19 March 2002" "libcurl 7.9.6" "libcurl overview"
+.TH libcurl 3 "March 19, 2002" "libcurl 7.9.6" "libcurl overview"
 .SH NAME
 libcurl \- client-side URL transfers
 .SH DESCRIPTION
index 50a4adf355f9e6959ca4f8e2b982de9df6687824..768702006c202bb7d958eb89b71a52a6861f744c 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 2021, Max Dymond, <max.dymond@microsoft.com>, et al.
+.\" * Copyright (C) 2021 - 2022, Max Dymond, <max.dymond@microsoft.com>, et al.
 .\" *
 .\" * This software is licensed as described in the file COPYING, which
 .\" * you should have received as part of this distribution. The terms
@@ -52,11 +52,15 @@ before a GET/HEAD/POST/etc request has been sent.
 This function may be called multiple times if redirections are enabled and are
 being followed (see \fICURLOPT_FOLLOWLOCATION(3)\fP).
 
-This function is passed the following information:
+The callback function must return \fICURL_PREREQFUNC_OK\fP on success, or
+\fICURL_PREREQFUNC_ABORT\fP to cause the transfer to fail.
+
+This function is passed the following arguments:
 .IP conn_primary_ip
 A nul-terminated pointer to a C string containing the primary IP of the remote
-server established with this connection. For FTP, this is the IP for the control
-connection. IPv6 addresses are represented without surrounding brackets.
+server established with this connection. For FTP, this is the IP for the
+control connection. IPv6 addresses are represented without surrounding
+brackets.
 .IP conn_local_ip
 A nul-terminated pointer to a C string containing the originating IP for this
 connection. IPv6 addresses are represented without surrounding brackets.
@@ -65,15 +69,10 @@ The primary port number on the remote server established with this connection.
 For FTP, this is the port for the control connection. This can be a TCP or a
 UDP port number dependending on the protocol.
 .IP conn_local_port
-The originating port number for this connection. This can be a TCP or a UDP port
-number dependending on the protocol.
-.RE
-
-\fIclientp\fP is the pointer you set with \fICURLOPT_PREREQDATA(3)\fP.
-
-The callback function must return \fICURL_PREREQFUNC_OK\fP on success, or
-\fICURL_PREREQFUNC_ABORT\fP to cause the transfer to fail.
-
+The originating port number for this connection. This can be a TCP or a UDP
+port number dependending on the protocol.
+.IP clientp
+The pointer you set with \fICURLOPT_PREREQDATA(3)\fP.
 .SH DEFAULT
 By default, this is NULL and unused.
 .SH PROTOCOLS
index a5ba8bcef8196a72598be7c25d66293eb9ffa693..8e9383eee10b05144e42d10ea7269e73a55ba9ef 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2022, 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
@@ -75,25 +75,23 @@ characters have no special purpose.
 Using the rules above, a file name pattern can be constructed:
 
 \&ftp://example.com/some/path/\fB[a-z[:upper:]\\\\].jpeg\fP
-.RE
-.PP
 .SH PROTOCOLS
 This feature is only supported for FTP download.
 .SH EXAMPLE
 .nf
-  /* initialization of easy handle */
-  handle = curl_easy_init();
+/* initialization of easy handle */
+handle = curl_easy_init();
 
-  /* turn on wildcard matching */
-  curl_easy_setopt(handle, CURLOPT_WILDCARDMATCH, 1L);
+/* turn on wildcard matching */
+curl_easy_setopt(handle, CURLOPT_WILDCARDMATCH, 1L);
 
-  /* callback is called before download of concrete file started */
-  curl_easy_setopt(handle, CURLOPT_CHUNK_BGN_FUNCTION, file_is_coming);
+/* callback is called before download of concrete file started */
+curl_easy_setopt(handle, CURLOPT_CHUNK_BGN_FUNCTION, file_is_coming);
 
-  /* callback is called after data from the file have been transferred */
-  curl_easy_setopt(handle, CURLOPT_CHUNK_END_FUNCTION, file_is_downloaded);
+/* callback is called after data from the file have been transferred */
+curl_easy_setopt(handle, CURLOPT_CHUNK_END_FUNCTION, file_is_downloaded);
 
-  /* See more on https://curl.se/libcurl/c/ftp-wildcard.html */
+/* See more on https://curl.se/libcurl/c/ftp-wildcard.html */
 .fi
 .SH AVAILABILITY
 Added in 7.21.0