1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at http://curl.haxx.se/docs/copyright.html.
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
22 #include "tool_setup.h"
24 #include "tool_panykey.h"
25 #include "tool_help.h"
26 #include "tool_libinfo.h"
27 #include "tool_version.h"
29 #include "memdebug.h" /* keep this as LAST include */
36 * A few of these source lines are >80 columns wide, but that's only because
37 * breaking the strings narrower makes this chunk look even worse!
39 * Starting with 7.18.0, this list of command line options is sorted based
40 * on the long option name. It is not done automatically, although a command
41 * line like the following can help out:
43 * curl --help | cut -c5- | grep "^-" | sort
46 static const char *const helptext[] = {
47 "Usage: curl [options...] <url>",
48 "Options: (H) means HTTP/HTTPS only, (F) means FTP only",
49 " --anyauth Pick \"any\" authentication method (H)",
50 " -a, --append Append to target file when uploading (F/SFTP)",
51 " --basic Use HTTP Basic Authentication (H)",
52 " --cacert FILE CA certificate to verify peer against (SSL)",
53 " --capath DIR CA directory to verify peer against (SSL)",
54 " -E, --cert CERT[:PASSWD] Client certificate file and password (SSL)",
55 " --cert-type TYPE Certificate file type (DER/PEM/ENG) (SSL)",
56 " --ciphers LIST SSL ciphers to use (SSL)",
57 " --compressed Request compressed response (using deflate or gzip)",
58 " -K, --config FILE Read config from FILE",
59 " --connect-timeout SECONDS Maximum time allowed for connection",
60 " -C, --continue-at OFFSET Resumed transfer OFFSET",
61 " -b, --cookie STRING/FILE Read cookies from STRING/FILE (H)",
62 " -c, --cookie-jar FILE Write cookies to FILE after operation (H)",
63 " --create-dirs Create necessary local directory hierarchy",
64 " --crlf Convert LF to CRLF in upload",
65 " --crlfile FILE Get a CRL list in PEM format from the given file",
66 " -d, --data DATA HTTP POST data (H)",
67 " --data-ascii DATA HTTP POST ASCII data (H)",
68 " --data-binary DATA HTTP POST binary data (H)",
69 " --data-urlencode DATA HTTP POST data url encoded (H)",
70 " --delegation STRING GSS-API delegation permission",
71 " --digest Use HTTP Digest Authentication (H)",
72 " --disable-eprt Inhibit using EPRT or LPRT (F)",
73 " --disable-epsv Inhibit using EPSV (F)",
74 " --dns-servers DNS server addrs to use: 1.1.1.1;2.2.2.2",
75 " --dns-interface Interface to use for DNS requests",
76 " --dns-ipv4-addr IPv4 address to use for DNS requests, dot notation",
77 " --dns-ipv6-addr IPv6 address to use for DNS requests, dot notation",
78 " -D, --dump-header FILE Write the headers to FILE",
79 " --egd-file FILE EGD socket path for random data (SSL)",
80 " --engine ENGINE Crypto engine (use \"--engine list\" for list) (SSL)",
81 #ifdef USE_ENVIRONMENT
82 " --environment Write results to environment variables (RISC OS)",
84 " -f, --fail Fail silently (no output at all) on HTTP errors (H)",
85 " -F, --form CONTENT Specify HTTP multipart POST data (H)",
86 " --form-string STRING Specify HTTP multipart POST data (H)",
87 " --ftp-account DATA Account data string (F)",
88 " --ftp-alternative-to-user COMMAND "
89 "String to replace \"USER [name]\" (F)",
90 " --ftp-create-dirs Create the remote dirs if not present (F)",
91 " --ftp-method [MULTICWD/NOCWD/SINGLECWD] Control CWD usage (F)",
92 " --ftp-pasv Use PASV/EPSV instead of PORT (F)",
93 " -P, --ftp-port ADR Use PORT with given address instead of PASV (F)",
94 " --ftp-skip-pasv-ip Skip the IP address for PASV (F)\n"
95 " --ftp-pret Send PRET before PASV (for drftpd) (F)",
96 " --ftp-ssl-ccc Send CCC after authenticating (F)",
97 " --ftp-ssl-ccc-mode ACTIVE/PASSIVE Set CCC mode (F)",
98 " --ftp-ssl-control Require SSL/TLS for FTP login, "
99 "clear for transfer (F)",
100 " -G, --get Send the -d data with a HTTP GET (H)",
101 " -g, --globoff Disable URL sequences and ranges using {} and []",
102 " -H, --header LINE Pass custom header LINE to server (H)",
103 " -I, --head Show document info only",
104 " -h, --help This help text",
106 "Hex-encoded MD5 string of the host public key. (SSH)",
107 " -0, --http1.0 Use HTTP 1.0 (H)",
108 " --http1.1 Use HTTP 1.1 (H)",
109 " --http2 Use HTTP 2 (H)",
110 " --ignore-content-length Ignore the HTTP Content-Length header",
111 " -i, --include Include protocol headers in the output (H/F)",
112 " -k, --insecure Allow connections to SSL sites without certs (H)",
113 " --interface INTERFACE Use network INTERFACE (or address)",
114 " -4, --ipv4 Resolve name to IPv4 address",
115 " -6, --ipv6 Resolve name to IPv6 address",
116 " -j, --junk-session-cookies Ignore session cookies read from file (H)",
117 " --keepalive-time SECONDS Wait SECONDS between keepalive probes",
118 " --key KEY Private key file name (SSL/SSH)",
119 " --key-type TYPE Private key file type (DER/PEM/ENG) (SSL)",
120 " --krb LEVEL Enable Kerberos with security LEVEL (F)",
121 #ifndef CURL_DISABLE_LIBCURL_OPTION
122 " --libcurl FILE Dump libcurl equivalent code of this command line",
124 " --limit-rate RATE Limit transfer speed to RATE",
125 " -l, --list-only List only mode (F/POP3)",
126 " --local-port RANGE Force use of RANGE for local port numbers",
127 " -L, --location Follow redirects (H)",
128 " --location-trusted "
129 "Like '--location', and send auth to other hosts (H)",
130 " --login-options OPTIONS Server login options (IMAP, POP3, SMTP)",
131 " -M, --manual Display the full manual",
132 " --mail-from FROM Mail from this address (SMTP)",
133 " --mail-rcpt TO Mail to this/these addresses (SMTP)",
134 " --mail-auth AUTH Originator address of the original email (SMTP)",
135 " --max-filesize BYTES Maximum file size to download (H/F)",
136 " --max-redirs NUM Maximum number of redirects allowed (H)",
137 " -m, --max-time SECONDS Maximum time allowed for the transfer",
138 " --metalink Process given URLs as metalink XML file",
139 " --negotiate Use HTTP Negotiate (SPNEGO) authentication (H)",
140 " -n, --netrc Must read .netrc for user name and password",
141 " --netrc-optional Use either .netrc or URL; overrides -n",
142 " --netrc-file FILE Specify FILE for netrc",
144 "Allows the following URL to use a separate set of options",
145 " --no-alpn Disable the ALPN TLS extension (H)",
146 " -N, --no-buffer Disable buffering of the output stream",
147 " --no-keepalive Disable keepalive use on the connection",
148 " --no-npn Disable the NPN TLS extension (H)",
149 " --no-sessionid Disable SSL session-ID reusing (SSL)",
150 " --noproxy List of hosts which do not use proxy",
151 " --ntlm Use HTTP NTLM authentication (H)",
152 " --oauth2-bearer TOKEN OAuth 2 Bearer Token (IMAP, POP3, SMTP)",
153 " -o, --output FILE Write to FILE instead of stdout",
154 " --pass PASS Pass phrase for the private key (SSL/SSH)",
155 " --pinnedpubkey FILE Public key (PEM/DER) to verify peer against "
156 "(OpenSSL/GnuTLS/GSKit only)",
158 "Do not switch to GET after following a 301 redirect (H)",
160 "Do not switch to GET after following a 302 redirect (H)",
162 "Do not switch to GET after following a 303 redirect (H)",
163 " -#, --progress-bar Display transfer progress as a progress bar",
164 " --proto PROTOCOLS Enable/disable PROTOCOLS",
165 " --proto-redir PROTOCOLS Enable/disable PROTOCOLS on redirect",
166 " -x, --proxy [PROTOCOL://]HOST[:PORT] Use proxy on given port",
167 " --proxy-anyauth Pick \"any\" proxy authentication method (H)",
168 " --proxy-basic Use Basic authentication on the proxy (H)",
169 " --proxy-digest Use Digest authentication on the proxy (H)",
170 " --proxy-negotiate "
171 "Use HTTP Negotiate (SPNEGO) authentication on the proxy (H)",
172 " --proxy-ntlm Use NTLM authentication on the proxy (H)",
173 " -U, --proxy-user USER[:PASSWORD] Proxy user and password",
174 " --proxy1.0 HOST[:PORT] Use HTTP/1.0 proxy on given port",
175 " -p, --proxytunnel Operate through a HTTP proxy tunnel (using CONNECT)",
176 " --pubkey KEY Public key file name (SSH)",
177 " -Q, --quote CMD Send command(s) to server before transfer (F/SFTP)",
178 " --random-file FILE File for reading random data from (SSL)",
179 " -r, --range RANGE Retrieve only the bytes within RANGE",
180 " --raw Do HTTP \"raw\"; no transfer decoding (H)",
181 " -e, --referer Referer URL (H)",
182 " -J, --remote-header-name Use the header-provided filename (H)",
183 " -O, --remote-name Write output to a file named as the remote file",
184 " --remote-name-all Use the remote file name for all URLs",
185 " -R, --remote-time Set the remote file's time on the local output",
186 " -X, --request COMMAND Specify request command to use",
187 " --resolve HOST:PORT:ADDRESS Force resolve of HOST:PORT to ADDRESS",
189 "Retry request NUM times if transient problems occur",
190 " --retry-delay SECONDS Wait SECONDS between retries",
191 " --retry-max-time SECONDS Retry only within this period",
192 " --sasl-ir Enable initial response in SASL authentication",
194 "Show error. With -s, make curl show errors when they occur",
195 " -s, --silent Silent mode (don't output anything)",
196 " --socks4 HOST[:PORT] SOCKS4 proxy on given host + port",
197 " --socks4a HOST[:PORT] SOCKS4a proxy on given host + port",
198 " --socks5 HOST[:PORT] SOCKS5 proxy on given host + port",
199 " --socks5-hostname HOST[:PORT] "
200 "SOCKS5 proxy, pass host name to proxy",
201 #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
202 " --socks5-gssapi-service NAME SOCKS5 proxy service name for GSS-API",
203 " --socks5-gssapi-nec Compatibility with NEC SOCKS5 server",
205 " -Y, --speed-limit RATE "
206 "Stop transfers below RATE for 'speed-time' secs",
207 " -y, --speed-time SECONDS "
208 "Trigger 'speed-limit' abort after SECONDS (default: 30)",
209 " --ssl Try SSL/TLS (FTP, IMAP, POP3, SMTP)",
210 " --ssl-reqd Require SSL/TLS (FTP, IMAP, POP3, SMTP)",
211 " -2, --sslv2 Use SSLv2 (SSL)",
212 " -3, --sslv3 Use SSLv3 (SSL)",
213 " --ssl-allow-beast Allow security flaw to improve interop (SSL)",
214 " --stderr FILE Where to redirect stderr (use \"-\" for stdout)",
215 " --tcp-nodelay Use the TCP_NODELAY option",
216 " -t, --telnet-option OPT=VAL Set telnet option",
217 " --tftp-blksize VALUE Set TFTP BLKSIZE option (must be >512)",
218 " -z, --time-cond TIME Transfer based on a time condition",
219 " -1, --tlsv1 Use => TLSv1 (SSL)",
220 " --tlsv1.0 Use TLSv1.0 (SSL)",
221 " --tlsv1.1 Use TLSv1.1 (SSL)",
222 " --tlsv1.2 Use TLSv1.2 (SSL)",
223 " --trace FILE Write a debug trace to FILE",
224 " --trace-ascii FILE Like --trace, but without hex output",
225 " --trace-time Add time stamps to trace/verbose output",
226 " --tr-encoding Request compressed transfer encoding (H)",
227 " -T, --upload-file FILE Transfer FILE to destination",
228 " --url URL URL to work with",
229 " -B, --use-ascii Use ASCII/text transfer",
230 " -u, --user USER[:PASSWORD] Server user and password",
231 " --tlsuser USER TLS username",
232 " --tlspassword STRING TLS password",
233 " --tlsauthtype STRING TLS authentication type (default: SRP)",
234 " --unix-socket FILE Connect through this Unix domain socket",
235 " -A, --user-agent STRING Send User-Agent STRING to server (H)",
236 " -v, --verbose Make the operation more talkative",
237 " -V, --version Show version number and quit",
239 " --wdebug Turn on Watt-32 debugging",
241 " -w, --write-out FORMAT Use output FORMAT after completion",
242 " --xattr Store metadata in extended file attributes",
243 " -q Disable .curlrc (must be first parameter)",
248 # define PRINT_LINES_PAUSE 23
252 # define PRINT_LINES_PAUSE 16
260 static const struct feat feats[] = {
261 {"AsynchDNS", CURL_VERSION_ASYNCHDNS},
262 {"Debug", CURL_VERSION_DEBUG},
263 {"TrackMemory", CURL_VERSION_CURLDEBUG},
264 {"IDN", CURL_VERSION_IDN},
265 {"IPv6", CURL_VERSION_IPV6},
266 {"Largefile", CURL_VERSION_LARGEFILE},
267 {"SSPI", CURL_VERSION_SSPI},
268 {"GSS-API", CURL_VERSION_GSSAPI},
269 {"Kerberos", CURL_VERSION_KERBEROS5},
270 {"SPNEGO", CURL_VERSION_SPNEGO},
271 {"NTLM", CURL_VERSION_NTLM},
272 {"NTLM_WB", CURL_VERSION_NTLM_WB},
273 {"SSL", CURL_VERSION_SSL},
274 {"libz", CURL_VERSION_LIBZ},
275 {"CharConv", CURL_VERSION_CONV},
276 {"TLS-SRP", CURL_VERSION_TLSAUTH_SRP},
277 {"HTTP2", CURL_VERSION_HTTP2},
278 {"UnixSockets", CURL_VERSION_UNIX_SOCKETS},
284 for(i = 0; helptext[i]; i++) {
286 #ifdef PRINT_LINES_PAUSE
287 if(i && ((i % PRINT_LINES_PAUSE) == 0))
293 void tool_version_info(void)
295 const char *const *proto;
297 printf(CURL_ID "%s\n", curl_version());
298 if(curlinfo->protocols) {
299 printf("Protocols: ");
300 for(proto = curlinfo->protocols; *proto; ++proto) {
301 printf("%s ", *proto);
303 puts(""); /* newline */
305 if(curlinfo->features) {
307 printf("Features: ");
308 for(i = 0; i < sizeof(feats)/sizeof(feats[0]); i++) {
309 if(curlinfo->features & feats[i].bitmask)
310 printf("%s ", feats[i].name);
315 puts(""); /* newline */
319 void tool_list_engines(CURL *curl)
321 struct curl_slist *engines = NULL;
323 /* Get the list of engines */
324 curl_easy_getinfo(curl, CURLINFO_SSL_ENGINES, &engines);
326 puts("Build-time engines:");
328 for(; engines; engines = engines->next)
329 printf(" %s\n", engines->data);
335 /* Cleanup the list of engines */
336 curl_slist_free_all(engines);