1<testcase> 2<info> 3<keywords> 4script 5documentation 6managen 7</keywords> 8</info> 9 10# 11# Client-side 12<client> 13<server> 14none 15</server> 16 17<name> 18managen makes manpage 19</name> 20 21<file name="%LOGDIR/mainpage.idx"> 22_header.md 23%options 24_footer.md 25</file> 26 27<file1 name="%LOGDIR/_header.md"> 28<!-- Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. --> 29<!-- SPDX-License-Identifier: curl --> 30# DESCRIPTION 31 32**curl** is a tool for transferring data from or to a server using URLs. It 33supports these protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, 34IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, 35SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. 36 37curl is powered by libcurl for all transfer-related features. See 38*libcurl(3)* for details. 39</file1> 40<file2 name="%LOGDIR/option1.md"> 41--- 42c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 43SPDX-License-Identifier: curl 44Short: v 45Long: fakeitreal 46Mutexed: trace trace-ascii 47Help: Make the operation more talkative 48Category: important verbose global 49Added: 4.0 50Multi: boolean 51Scope: global 52See-also: 53 - include 54 - silent 55 - trace 56 - trace-ascii 57Example: 58 - --verbose $URL 59--- 60 61# `--verbose` 62 63Makes curl verbose during the operation. Useful for debugging and seeing 64what's going on under the hood. A line starting with \> means header data sent 65by curl, \< means header data received by curl that is hidden in normal cases, 66and a line starting with * means additional info provided by curl. 67 68If you only want HTTP headers in the output, --include or --dump-header might 69be more suitable options. 70 71If you think this option still does not give you enough details, consider using 72--trace or --trace-ascii instead. 73 74Note that verbose output of curl activities and network traffic might contain 75sensitive data, including usernames, credentials or secret data content. Be 76aware and be careful when sharing trace logs with others. 77 78End with a quote 79 80 hello 81</file2> 82<file3 name="%LOGDIR/option2.md"> 83--- 84c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 85SPDX-License-Identifier: curl 86Long: proto 87Arg: <protocols> 88Help: Enable/disable PROTOCOLS 89Added: 7.20.2 90Category: connection curl 91Multi: single 92See-also: 93 - fakeitreal 94 - proto-default 95Example: 96 - --proto =http,https,sftp $URL 97--- 98 99# `--proto` 100 101Limit what protocols to allow for transfers. Protocols are evaluated left to 102right, are comma separated, and are each a protocol name or 'all', optionally 103prefixed by zero or more modifiers. Available modifiers are: 104 105## + 106Permit this protocol in addition to protocols already permitted (this is 107the default if no modifier is used). 108 109## - 110Deny this protocol, removing it from the list of protocols already permitted. 111 112## = 113Permit only this protocol (ignoring the list already permitted), though 114subject to later modification by subsequent entries in the comma separated 115list. 116 117## 118 119For example: --proto -ftps uses the default protocols, but disables ftps 120 121--proto -all,https,+http only enables http and https 122 123--proto =http,https also only enables http and https 124 125Unknown and disabled protocols produce a warning. This allows scripts to 126safely rely on being able to disable potentially dangerous protocols, without 127relying upon support for that protocol being built into curl to avoid an error. 128 129This option can be used multiple times, in which case the effect is the same 130as concatenating the protocols into one instance of the option. 131</file3> 132<file4 name="%LOGDIR/_footer.md"> 133<!-- Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. --> 134<!-- SPDX-License-Identifier: curl --> 135# PROXY PROTOCOL PREFIXES 136The proxy string may be specified with a protocol:// prefix to specify 137alternative proxy protocols. (Added in 7.21.7) 138 139If no protocol is specified in the proxy string or if the string does not 140match a supported one, the proxy is treated as an HTTP proxy. 141 142The supported proxy protocol prefixes are as follows: 143## http:// 144Makes it use it as an HTTP proxy. The default if no scheme prefix is used. 145## https:// 146Makes it treated as an **HTTPS** proxy. 147## socks4:// 148Makes it the equivalent of --socks4 149## socks4a:// 150Makes it the equivalent of --socks4a 151## socks5:// 152Makes it the equivalent of --socks5 153## socks5h:// 154Makes it the equivalent of --socks5-hostname 155</file4> 156 157<command type="perl"> 158%SRCDIR/../scripts/managen -d %LOGDIR -I %SRCDIR/../include mainpage option1.md option2.md 159</command> 160</client> 161 162<verify> 163<stderr> 164option1.md:19:1:WARN: see-also a non-existing option: include 165option1.md:19:1:WARN: see-also a non-existing option: silent 166option1.md:19:1:WARN: see-also a non-existing option: trace 167option1.md:19:1:WARN: see-also a non-existing option: trace-ascii 168WARN: option1.md mutexes a non-existing option: trace 169WARN: option1.md mutexes a non-existing option: trace-ascii 170option2.md:15:1:WARN: see-also a non-existing option: proto-default 171</stderr> 172<stdout> 173.\" ************************************************************************** 174.\" * _ _ ____ _ 175.\" * Project ___| | | | _ \| | 176.\" * / __| | | | |_) | | 177.\" * | (__| |_| | _ <| |___ 178.\" * \___|\___/|_| \_\_____| 179.\" * 180.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 181.\" * 182.\" * This software is licensed as described in the file COPYING, which 183.\" * you should have received as part of this distribution. The terms 184.\" * are also available at https://curl.se/docs/copyright.html. 185.\" * 186.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell 187.\" * copies of the Software, and permit persons to whom the Software is 188.\" * furnished to do so, under the terms of the COPYING file. 189.\" * 190.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY 191.\" * KIND, either express or implied. 192.\" * 193.\" * SPDX-License-Identifier: curl 194.\" * 195.\" ************************************************************************** 196.\" 197.\" DO NOT EDIT. Generated by the curl project managen manpage generator. 198.\" 199.TH curl 1 "%DATE" "curl %VERNUM" "curl Manual" 200.SH DESCRIPTION 201\fBcurl\fP is a tool for transferring data from or to a server using URLs. It 202supports these protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, 203IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, 204SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. 205 206curl is powered by libcurl for all transfer\-related features. See 207\fIlibcurl(3)\fP for details. 208.IP "\-v, \-\-fakeitreal" 209Makes curl verbose during the operation. Useful for debugging and seeing 210what\(aqs going on under the hood. A line starting with > means header data sent 211by curl, < means header data received by curl that is hidden in normal cases, 212and a line starting with * means additional info provided by curl. 213 214If you only want HTTP headers in the output, \fI\-\-include\fP or \fI\-\-dump\-header\fP might 215be more suitable options. 216 217If you think this option still does not give you enough details, consider using 218\fI\-\-trace\fP or \fI\-\-trace\-ascii\fP instead. 219 220Note that verbose output of curl activities and network traffic might contain 221sensitive data, including usernames, credentials or secret data content. Be 222aware and be careful when sharing trace logs with others. 223 224End with a quote 225 226.nf 227hello 228.fi 229 230This option is global and does not need to be specified for each use of --next. 231 232Providing --fakeitreal multiple times has no extra effect. 233Disable it again with \-\-no-fakeitreal. 234 235Example: 236.nf 237curl --verbose https://example.com 238.fi 239 240This option is mutually exclusive with \fI\-\-trace\fP and \fI\-\-trace\-ascii\fP. 241See also \fI\-\-include\fP, \fI\-\-silent\fP, \fI\-\-trace\fP and \fI\-\-trace\-ascii\fP. 242.IP "\-\-proto <protocols>" 243Limit what protocols to allow for transfers. Protocols are evaluated left to 244right, are comma separated, and are each a protocol name or \(aqall\(aq, optionally 245prefixed by zero or more modifiers. Available modifiers are: 246.RS 247.IP + 248Permit this protocol in addition to protocols already permitted (this is 249the default if no modifier is used). 250.IP - 251Deny this protocol, removing it from the list of protocols already permitted. 252.IP = 253Permit only this protocol (ignoring the list already permitted), though 254subject to later modification by subsequent entries in the comma separated 255list. 256.RE 257.IP 258For example: \fI\-\-proto\fP \-ftps uses the default protocols, but disables ftps 259 260\fI\-\-proto\fP \-all,https,+http only enables http and https 261 262\fI\-\-proto\fP =http,https also only enables http and https 263 264Unknown and disabled protocols produce a warning. This allows scripts to 265safely rely on being able to disable potentially dangerous protocols, without 266relying upon support for that protocol being built into curl to avoid an error. 267 268This option can be used multiple times, in which case the effect is the same 269as concatenating the protocols into one instance of the option. 270 271If --proto is provided several times, the last set value is used. 272 273Example: 274.nf 275curl --proto =http,https,sftp https://example.com 276.fi 277 278See also \fI-v, \-\-fakeitreal\fP and \fI\-\-proto\-default\fP. 279.SH PROXY PROTOCOL PREFIXES 280The proxy string may be specified with a protocol:// prefix to specify 281alternative proxy protocols. 282 283If no protocol is specified in the proxy string or if the string does not 284match a supported one, the proxy is treated as an HTTP proxy. 285 286The supported proxy protocol prefixes are as follows: 287.IP http:// 288Makes it use it as an HTTP proxy. The default if no scheme prefix is used. 289.IP https:// 290Makes it treated as an \fBHTTPS\fP proxy. 291.IP socks4:// 292Makes it the equivalent of \fI\-\-socks4\fP 293.IP socks4a:// 294Makes it the equivalent of \fI\-\-socks4a\fP 295.IP socks5:// 296Makes it the equivalent of \fI\-\-socks5\fP 297.IP socks5h:// 298Makes it the equivalent of \fI\-\-socks5\-hostname\fP 299</stdout> 300</verify> 301 302</testcase> 303
