From 5a2e0181fc7fc9f482c288d7dbf101413b59605f Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Wed, 5 Jan 2022 16:51:24 +0100 Subject: docs: fix mandoc -T lint formatting complaints --- docs/libcurl/curl_global_init_mem.3 | 4 ++-- docs/libcurl/curl_share_init.3 | 4 ++-- docs/libcurl/curl_share_strerror.3 | 4 ++-- docs/libcurl/curl_unescape.3 | 4 ++-- docs/libcurl/libcurl.3 | 4 ++-- docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 | 25 ++++++++++++------------- docs/libcurl/opts/CURLOPT_WILDCARDMATCH.3 | 22 ++++++++++------------ 7 files changed, 32 insertions(+), 35 deletions(-) diff --git a/docs/libcurl/curl_global_init_mem.3 b/docs/libcurl/curl_global_init_mem.3 index 3e747ca62..9b8b4bffc 100644 --- a/docs/libcurl/curl_global_init_mem.3 +++ b/docs/libcurl/curl_global_init_mem.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, , 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 diff --git a/docs/libcurl/curl_share_init.3 b/docs/libcurl/curl_share_init.3 index df61fb099..aaa130bed 100644 --- a/docs/libcurl/curl_share_init.3 +++ b/docs/libcurl/curl_share_init.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, , 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 diff --git a/docs/libcurl/curl_share_strerror.3 b/docs/libcurl/curl_share_strerror.3 index 08a9dba29..1d5ce3a2b 100644 --- a/docs/libcurl/curl_share_strerror.3 +++ b/docs/libcurl/curl_share_strerror.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, , 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 diff --git a/docs/libcurl/curl_unescape.3 b/docs/libcurl/curl_unescape.3 index 23b9f7053..2a864ef47 100644 --- a/docs/libcurl/curl_unescape.3 +++ b/docs/libcurl/curl_unescape.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, , 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 diff --git a/docs/libcurl/libcurl.3 b/docs/libcurl/libcurl.3 index b293846f9..b500e1cde 100644 --- a/docs/libcurl/libcurl.3 +++ b/docs/libcurl/libcurl.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, , 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 diff --git a/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 b/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 index 50a4adf35..768702006 100644 --- a/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 +++ b/docs/libcurl/opts/CURLOPT_PREREQFUNCTION.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 2021, Max Dymond, , et al. +.\" * Copyright (C) 2021 - 2022, Max Dymond, , 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 diff --git a/docs/libcurl/opts/CURLOPT_WILDCARDMATCH.3 b/docs/libcurl/opts/CURLOPT_WILDCARDMATCH.3 index a5ba8bcef..8e9383eee 100644 --- a/docs/libcurl/opts/CURLOPT_WILDCARDMATCH.3 +++ b/docs/libcurl/opts/CURLOPT_WILDCARDMATCH.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, , 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 -- cgit v1.2.1