test1705 (9882B)
1 <testcase> 2 <info> 3 <keywords> 4 script 5 documentation 6 managen 7 </keywords> 8 </info> 9 10 # 11 # Client-side 12 <client> 13 <server> 14 none 15 </server> 16 17 <name> 18 managen 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 33 supports these protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, 34 IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, 35 SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. 36 37 curl is powered by libcurl for all transfer-related features. See 38 *libcurl(3)* for details. 39 </file1> 40 <file2 name="%LOGDIR/option1.md"> 41 --- 42 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 43 SPDX-License-Identifier: curl 44 Short: v 45 Long: fakeitreal 46 Mutexed: trace trace-ascii 47 Help: Make the operation more talkative 48 Category: important verbose global 49 Added: 4.0 50 Multi: boolean 51 Scope: global 52 See-also: 53 - include 54 - silent 55 - trace 56 - trace-ascii 57 Example: 58 - --verbose $URL 59 --- 60 61 # `--verbose` 62 63 Makes curl verbose during the operation. Useful for debugging and seeing 64 what's going on under the hood. A line starting with \> means header data sent 65 by curl, \< means header data received by curl that is hidden in normal cases, 66 and a line starting with * means additional info provided by curl. 67 68 If you only want HTTP headers in the output, --include or --dump-header might 69 be more suitable options. 70 71 If you think this option still does not give you enough details, consider using 72 --trace or --trace-ascii instead. 73 74 Note that verbose output of curl activities and network traffic might contain 75 sensitive data, including usernames, credentials or secret data content. Be 76 aware and be careful when sharing trace logs with others. 77 78 End with a quote 79 80 hello 81 </file2> 82 <file3 name="%LOGDIR/option2.md"> 83 --- 84 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 85 SPDX-License-Identifier: curl 86 Long: proto 87 Arg: <protocols> 88 Help: Enable/disable PROTOCOLS 89 Added: 7.20.2 90 Category: connection curl 91 Multi: single 92 See-also: 93 - fakeitreal 94 - proto-default 95 Example: 96 - --proto =http,https,sftp $URL 97 --- 98 99 # `--proto` 100 101 Limit what protocols to allow for transfers. Protocols are evaluated left to 102 right, are comma separated, and are each a protocol name or 'all', optionally 103 prefixed by zero or more modifiers. Available modifiers are: 104 105 ## + 106 Permit this protocol in addition to protocols already permitted (this is 107 the default if no modifier is used). 108 109 ## - 110 Deny this protocol, removing it from the list of protocols already permitted. 111 112 ## = 113 Permit only this protocol (ignoring the list already permitted), though 114 subject to later modification by subsequent entries in the comma separated 115 list. 116 117 ## 118 119 For 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 125 Unknown and disabled protocols produce a warning. This allows scripts to 126 safely rely on being able to disable potentially dangerous protocols, without 127 relying upon support for that protocol being built into curl to avoid an error. 128 129 This option can be used multiple times, in which case the effect is the same 130 as 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 136 The proxy string may be specified with a protocol:// prefix to specify 137 alternative proxy protocols. (Added in 7.21.7) 138 139 If no protocol is specified in the proxy string or if the string does not 140 match a supported one, the proxy is treated as an HTTP proxy. 141 142 The supported proxy protocol prefixes are as follows: 143 ## http:// 144 Makes it use it as an HTTP proxy. The default if no scheme prefix is used. 145 ## https:// 146 Makes it treated as an **HTTPS** proxy. 147 ## socks4:// 148 Makes it the equivalent of --socks4 149 ## socks4a:// 150 Makes it the equivalent of --socks4a 151 ## socks5:// 152 Makes it the equivalent of --socks5 153 ## socks5h:// 154 Makes 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> 164 option1.md:19:1:WARN: see-also a non-existing option: include 165 option1.md:19:1:WARN: see-also a non-existing option: silent 166 option1.md:19:1:WARN: see-also a non-existing option: trace 167 option1.md:19:1:WARN: see-also a non-existing option: trace-ascii 168 WARN: option1.md mutexes a non-existing option: trace 169 WARN: option1.md mutexes a non-existing option: trace-ascii 170 option2.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 202 supports these protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, 203 IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, 204 SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. 205 206 curl is powered by libcurl for all transfer\-related features. See 207 \fIlibcurl(3)\fP for details. 208 .IP "\-v, \-\-fakeitreal" 209 Makes curl verbose during the operation. Useful for debugging and seeing 210 what\(aqs going on under the hood. A line starting with > means header data sent 211 by curl, < means header data received by curl that is hidden in normal cases, 212 and a line starting with * means additional info provided by curl. 213 214 If you only want HTTP headers in the output, \fI\-\-include\fP or \fI\-\-dump\-header\fP might 215 be more suitable options. 216 217 If you think this option still does not give you enough details, consider using 218 \fI\-\-trace\fP or \fI\-\-trace\-ascii\fP instead. 219 220 Note that verbose output of curl activities and network traffic might contain 221 sensitive data, including usernames, credentials or secret data content. Be 222 aware and be careful when sharing trace logs with others. 223 224 End with a quote 225 226 .nf 227 hello 228 .fi 229 230 This option is global and does not need to be specified for each use of --next. 231 232 Providing --fakeitreal multiple times has no extra effect. 233 Disable it again with \-\-no-fakeitreal. 234 235 Example: 236 .nf 237 curl --verbose https://example.com 238 .fi 239 240 This option is mutually exclusive with \fI\-\-trace\fP and \fI\-\-trace\-ascii\fP. 241 See also \fI\-\-include\fP, \fI\-\-silent\fP, \fI\-\-trace\fP and \fI\-\-trace\-ascii\fP. 242 .IP "\-\-proto <protocols>" 243 Limit what protocols to allow for transfers. Protocols are evaluated left to 244 right, are comma separated, and are each a protocol name or \(aqall\(aq, optionally 245 prefixed by zero or more modifiers. Available modifiers are: 246 .RS 247 .IP + 248 Permit this protocol in addition to protocols already permitted (this is 249 the default if no modifier is used). 250 .IP - 251 Deny this protocol, removing it from the list of protocols already permitted. 252 .IP = 253 Permit only this protocol (ignoring the list already permitted), though 254 subject to later modification by subsequent entries in the comma separated 255 list. 256 .RE 257 .IP 258 For 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 264 Unknown and disabled protocols produce a warning. This allows scripts to 265 safely rely on being able to disable potentially dangerous protocols, without 266 relying upon support for that protocol being built into curl to avoid an error. 267 268 This option can be used multiple times, in which case the effect is the same 269 as concatenating the protocols into one instance of the option. 270 271 If --proto is provided several times, the last set value is used. 272 273 Example: 274 .nf 275 curl --proto =http,https,sftp https://example.com 276 .fi 277 278 See also \fI-v, \-\-fakeitreal\fP and \fI\-\-proto\-default\fP. 279 .SH PROXY PROTOCOL PREFIXES 280 The proxy string may be specified with a protocol:// prefix to specify 281 alternative proxy protocols. 282 283 If no protocol is specified in the proxy string or if the string does not 284 match a supported one, the proxy is treated as an HTTP proxy. 285 286 The supported proxy protocol prefixes are as follows: 287 .IP http:// 288 Makes it use it as an HTTP proxy. The default if no scheme prefix is used. 289 .IP https:// 290 Makes it treated as an \fBHTTPS\fP proxy. 291 .IP socks4:// 292 Makes it the equivalent of \fI\-\-socks4\fP 293 .IP socks4a:// 294 Makes it the equivalent of \fI\-\-socks4a\fP 295 .IP socks5:// 296 Makes it the equivalent of \fI\-\-socks5\fP 297 .IP socks5h:// 298 Makes it the equivalent of \fI\-\-socks5\-hostname\fP 299 </stdout> 300 </verify> 301 302 </testcase>