From 902d3dc33df617d07005755b40019890769943b1 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Sun, 3 Jul 2011 22:13:18 +0200 Subject: help output: more gnu like output First, the -J/--remote-header-name was wrongly sorted in the --help output as pointed out in bug report #3349271. Then, I changed the format of the texts to follow the man page better in that it now uses "-A, --long" intead of "-A/--long". I also made all additional arguments get written as in "-A, --long FILENAME" instead of the previous "" style. Reported by: Herve Amblard Bug: http://curl.haxx.se/bug/view.cgi?id=3349271 --- src/main.c | 309 ++++++++++++++++++++++++++++++------------------------------- 1 file changed, 154 insertions(+), 155 deletions(-) (limited to 'src') diff --git a/src/main.c b/src/main.c index 463996444..154694461 100644 --- a/src/main.c +++ b/src/main.c @@ -795,175 +795,174 @@ static void help(void) static const char * const helptext[]={ "Usage: curl [options...] ", "Options: (H) means HTTP/HTTPS only, (F) means FTP only", - " --anyauth Pick \"any\" authentication method (H)", - " -a/--append Append to target file when uploading (F/SFTP)", - " --basic Use HTTP Basic Authentication (H)", - " --cacert CA certificate to verify peer against (SSL)", - " --capath CA directory to verify peer against (SSL)", - " -E/--cert Client certificate file and password (SSL)", - " --cert-type Certificate file type (DER/PEM/ENG) (SSL)", - " --ciphers SSL ciphers to use (SSL)", - " --compressed Request compressed response (using deflate or gzip)", - " -K/--config Specify which config file to read", - " --connect-timeout Maximum time allowed for connection", - " -C/--continue-at Resumed transfer offset", - " -b/--cookie String or file to read cookies from (H)", - " -c/--cookie-jar Write cookies to this file after operation (H)", - " --create-dirs Create necessary local directory hierarchy", - " --crlf Convert LF to CRLF in upload", - " --crlfile Get a CRL list in PEM format from the given file", - " -d/--data HTTP POST data (H)", - " --data-ascii HTTP POST ASCII data (H)", - " --data-binary HTTP POST binary data (H)", - " --data-urlencode " - "HTTP POST data url encoded (H)", - " --digest Use HTTP Digest Authentication (H)", - " --disable-eprt Inhibit using EPRT or LPRT (F)", - " --disable-epsv Inhibit using EPSV (F)", - " -D/--dump-header Write the headers to this file", - " --egd-file EGD socket path for random data (SSL)", - " --engine Crypto engine (SSL). \"--engine list\" for list", + " --anyauth Pick \"any\" authentication method (H)", + " -a, --append Append to target file when uploading (F/SFTP)", + " --basic Use HTTP Basic Authentication (H)", + " --cacert FILE CA certificate to verify peer against (SSL)", + " --capath DIR CA directory to verify peer against (SSL)", + " -E, --cert CERT[:PASSWD] Client certificate file and password (SSL)", + " --cert-type TYPE Certificate file type (DER/PEM/ENG) (SSL)", + " --ciphers LIST SSL ciphers to use (SSL)", + " --compressed Request compressed response (using deflate or gzip)", + " -K, --config FILE Specify which config file to read", + " --connect-timeout SECONDS Maximum time allowed for connection", + " -C, --continue-at OFFSET Resumed transfer offset", + " -b, --cookie STRING/FILE String or file to read cookies from (H)", + " -c, --cookie-jar FILE Write cookies to this file after operation (H)", + " --create-dirs Create necessary local directory hierarchy", + " --crlf Convert LF to CRLF in upload", + " --crlfile FILE Get a CRL list in PEM format from the given file", + " -d, --data DATA HTTP POST data (H)", + " --data-ascii DATA HTTP POST ASCII data (H)", + " --data-binary DATA HTTP POST binary data (H)", + " --data-urlencode DATA HTTP POST data url encoded (H)", + " --digest Use HTTP Digest Authentication (H)", + " --disable-eprt Inhibit using EPRT or LPRT (F)", + " --disable-epsv Inhibit using EPSV (F)", + " -D, --dump-header FILE Write the headers to this file", + " --egd-file FILE EGD socket path for random data (SSL)", + " --engine ENGINGE Crypto engine (SSL). \"--engine list\" for list", #ifdef USE_ENVIRONMENT - " --environment Write results to environment variables (RISC OS)", + " --environment Write results to environment variables (RISC OS)", #endif - " -f/--fail Fail silently (no output at all) on HTTP errors (H)", - " -F/--form Specify HTTP multipart POST data (H)", - " --form-string Specify HTTP multipart POST data (H)", - " --ftp-account Account data string (F)", - " --ftp-alternative-to-user " + " -f, --fail Fail silently (no output at all) on HTTP errors (H)", + " -F, --form CONTENT Specify HTTP multipart POST data (H)", + " --form-string STRING Specify HTTP multipart POST data (H)", + " --ftp-account DATA Account data string (F)", + " --ftp-alternative-to-user COMMAND " "String to replace \"USER [name]\" (F)", - " --ftp-create-dirs Create the remote dirs if not present (F)", - " --ftp-method [multicwd/nocwd/singlecwd] Control CWD usage (F)", - " --ftp-pasv Use PASV/EPSV instead of PORT (F)", - " -P/--ftp-port
Use PORT with address instead of PASV (F)", - " --ftp-skip-pasv-ip Skip the IP address for PASV (F)\n" - " --ftp-pret Send PRET before PASV (for drftpd) (F)", - " --ftp-ssl-ccc Send CCC after authenticating (F)", - " --ftp-ssl-ccc-mode [active/passive] Set CCC mode (F)", - " --ftp-ssl-control Require SSL/TLS for ftp login, " + " --ftp-create-dirs Create the remote dirs if not present (F)", + " --ftp-method [MULTICWD/NOCWD/SINGLECWD] Control CWD usage (F)", + " --ftp-pasv Use PASV/EPSV instead of PORT (F)", + " -P, --ftp-port ADR Use PORT with given address instead of PASV (F)", + " --ftp-skip-pasv-ip Skip the IP address for PASV (F)\n" + " --ftp-pret Send PRET before PASV (for drftpd) (F)", + " --ftp-ssl-ccc Send CCC after authenticating (F)", + " --ftp-ssl-ccc-mode ACTIVE/PASSIVE Set CCC mode (F)", + " --ftp-ssl-control Require SSL/TLS for ftp login, " "clear for transfer (F)", - " -G/--get Send the -d data with a HTTP GET (H)", - " -g/--globoff Disable URL sequences and ranges using {} and []", - " -H/--header Custom header to pass to server (H)", - " -I/--head Show document info only", - " -h/--help This help text", - " --hostpubmd5 " + " -G, --get Send the -d data with a HTTP GET (H)", + " -g, --globoff Disable URL sequences and ranges using {} and []", + " -H, --header LINE Custom header to pass to server (H)", + " -I, --head Show document info only", + " -h, --help This help text", + " --hostpubmd5 MD5 " "Hex encoded MD5 string of the host public key. (SSH)", - " -0/--http1.0 Use HTTP 1.0 (H)", - " --ignore-content-length Ignore the HTTP Content-Length header", - " -i/--include Include protocol headers in the output (H/F)", - " -k/--insecure Allow connections to SSL sites without certs (H)", - " --interface Specify network interface/address to use", - " -4/--ipv4 Resolve name to IPv4 address", - " -6/--ipv6 Resolve name to IPv6 address", - " -j/--junk-session-cookies Ignore session cookies read from file (H)", - " --keepalive-time Interval between keepalive probes", - " --key Private key file name (SSL/SSH)", - " --key-type Private key file type (DER/PEM/ENG) (SSL)", - " --krb Enable Kerberos with specified security level (F)", - " --libcurl Dump libcurl equivalent code of this command line", - " --limit-rate Limit transfer speed to this rate", - " -J/--remote-header-name Use the header-provided filename (H)", - " -l/--list-only List only names of an FTP directory (F)", - " --local-port [-num] Force use of these local port numbers", - " -L/--location Follow Location: hints (H)", - " --location-trusted Follow Location: and send auth to other hosts (H)", - " -M/--manual Display the full manual", - " --mail-from Mail from this address", - " --mail-rcpt Mail to this receiver(s)", - " --max-filesize Maximum file size to download (H/F)", - " --max-redirs Maximum number of redirects allowed (H)", - " -m/--max-time Maximum time allowed for the transfer", - " --negotiate Use HTTP Negotiate Authentication (H)", - " -n/--netrc Must read .netrc for user name and password", - " --netrc-optional Use either .netrc or URL; overrides -n", - " --netrc-file Set up the netrc filename to use", - " -N/--no-buffer Disable buffering of the output stream", - " --no-keepalive Disable keepalive use on the connection", - " --no-sessionid Disable SSL session-ID reusing (SSL)", - " --noproxy Comma-separated list of hosts which do not use proxy", - " --ntlm Use HTTP NTLM authentication (H)", - " -o/--output Write output to instead of stdout", - " --pass Pass phrase for the private key (SSL/SSH)", - " --post301 " + " -0, --http1.0 Use HTTP 1.0 (H)", + " --ignore-content-length Ignore the HTTP Content-Length header", + " -i, --include Include protocol headers in the output (H/F)", + " -k, --insecure Allow connections to SSL sites without certs (H)", + " --interface INTERFACE Specify network interface/address to use", + " -4, --ipv4 Resolve name to IPv4 address", + " -6, --ipv6 Resolve name to IPv6 address", + " -j, --junk-session-cookies Ignore session cookies read from file (H)", + " --keepalive-time SECONDS Interval between keepalive probes", + " --key KEY Private key file name (SSL/SSH)", + " --key-type TYPE Private key file type (DER/PEM/ENG) (SSL)", + " --krb LEVEL Enable Kerberos with specified security level (F)", + " --libcurl FILE Dump libcurl equivalent code of this command line", + " --limit-rate RATE Limit transfer speed to this rate", + " -l, --list-only List only names of an FTP directory (F)", + " --local-port RANGE Force use of these local port numbers", + " -L, --location Follow redirects (H)", + " --location-trusted like --location and send auth to other hosts (H)", + " -M, --manual Display the full manual", + " --mail-from FROM Mail from this address", + " --mail-rcpt TO Mail to this receiver(s)", + " --max-filesize BYTES Maximum file size to download (H/F)", + " --max-redirs NUM Maximum number of redirects allowed (H)", + " -m, --max-time SECONDS Maximum time allowed for the transfer", + " --negotiate Use HTTP Negotiate Authentication (H)", + " -n, --netrc Must read .netrc for user name and password", + " --netrc-optional Use either .netrc or URL; overrides -n", + " --netrc-file FILE Set up the netrc filename to use", + " -N, --no-buffer Disable buffering of the output stream", + " --no-keepalive Disable keepalive use on the connection", + " --no-sessionid Disable SSL session-ID reusing (SSL)", + " --noproxy List of hosts which do not use proxy", + " --ntlm Use HTTP NTLM authentication (H)", + " -o, --output FILE Write output to instead of stdout", + " --pass PASS Pass phrase for the private key (SSL/SSH)", + " --post301 " "Do not switch to GET after following a 301 redirect (H)", - " --post302 " + " --post302 " "Do not switch to GET after following a 302 redirect (H)", - " -#/--progress-bar Display transfer progress as a progress bar", - " --proto Enable/disable specified protocols", - " --proto-redir " + " -#, --progress-bar Display transfer progress as a progress bar", + " --proto PROTOCOLS Enable/disable specified protocols", + " --proto-redir PROTOCOLS " "Enable/disable specified protocols on redirect", - " -x/--proxy Use HTTP proxy on given port", - " --proxy-anyauth Pick \"any\" proxy authentication method (H)", - " --proxy-basic Use Basic authentication on the proxy (H)", - " --proxy-digest Use Digest authentication on the proxy (H)", - " --proxy-negotiate Use Negotiate authentication on the proxy (H)", - " --proxy-ntlm Use NTLM authentication on the proxy (H)", - " -U/--proxy-user Set proxy user and password", - " --proxy1.0 Use HTTP/1.0 proxy on given port", - " -p/--proxytunnel Operate through a HTTP proxy tunnel (using CONNECT)", - " --pubkey Public key file name (SSH)", - " -Q/--quote Send command(s) to server before transfer (F/SFTP)", - " --random-file File for reading random data from (SSL)", - " -r/--range Retrieve only the bytes within a range", - " --raw Pass HTTP \"raw\", without any transfer decoding (H)", - " -e/--referer Referer URL (H)", - " -O/--remote-name Write output to a file named as the remote file", - " --remote-name-all Use the remote file name for all URLs", - " -R/--remote-time Set the remote file's time on the local output", - " -X/--request Specify request command to use", - " --resolve Force resolve of HOST:PORT to ADDRESS", - " --retry " - "Retry request times if transient problems occur", - " --retry-delay " + " -x, --proxy [PROTOCOL://]HOST[:PORT] Use proxy on given port", + " --proxy-anyauth Pick \"any\" proxy authentication method (H)", + " --proxy-basic Use Basic authentication on the proxy (H)", + " --proxy-digest Use Digest authentication on the proxy (H)", + " --proxy-negotiate Use Negotiate authentication on the proxy (H)", + " --proxy-ntlm Use NTLM authentication on the proxy (H)", + " -U, --proxy-user USER[:PASSWORD] Proxy user and password", + " --proxy1.0 HOST[:PORT] Use HTTP/1.0 proxy on given port", + " -p, --proxytunnel Operate through a HTTP proxy tunnel (using CONNECT)", + " --pubkey KEY Public key file name (SSH)", + " -Q, --quote CMD Send command(s) to server before transfer (F/SFTP)", + " --random-file FILE File for reading random data from (SSL)", + " -r, --range RANGE Retrieve only the bytes within a range", + " --raw Do HTTP \"raw\", without any transfer decoding (H)", + " -e, --referer Referer URL (H)", + " -J, --remote-header-name Use the header-provided filename (H)", + " -O, --remote-name Write output to a file named as the remote file", + " --remote-name-all Use the remote file name for all URLs", + " -R, --remote-time Set the remote file's time on the local output", + " -X, --request COMMAND Specify request command to use", + " --resolve HOST:PORT:ADDRESS Force resolve of HOST:PORT to ADDRESS", + " --retry NUM " + "Retry request NUM times if transient problems occur", + " --retry-delay SECONDS " "When retrying, wait this many seconds between each", - " --retry-max-time Retry only within this period", - " -S/--show-error " + " --retry-max-time SECONDS Retry only within this period", + " -S, --show-error " "Show error. With -s, make curl show errors when they occur", - " -s/--silent Silent mode. Don't output anything", - " --socks4 SOCKS4 proxy on given host + port", - " --socks4a SOCKS4a proxy on given host + port", - " --socks5 SOCKS5 proxy on given host + port", - " --socks5-hostname " + " -s, --silent Silent mode. Don't output anything", + " --socks4 HOST[:PORT] SOCKS4 proxy on given host + port", + " --socks4a HOST[:PORT] SOCKS4a proxy on given host + port", + " --socks5 HOST[:PORT] SOCKS5 proxy on given host + port", + " --socks5-hostname HOST[:PORT] " "SOCKS5 proxy, pass host name to proxy", #if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI) - " --socks5-gssapi-service SOCKS5 proxy service name for gssapi", - " --socks5-gssapi-nec Compatibility with NEC SOCKS5 server", + " --socks5-gssapi-service NAME SOCKS5 proxy service name for gssapi", + " --socks5-gssapi-nec Compatibility with NEC SOCKS5 server", #endif - " -Y/--speed-limit " - "Stop transfer if below speed-limit for 'speed-time' secs", - " -y/--speed-time " - "Time needed to trig speed-limit abort. Defaults to 30", - " --ssl Try SSL/TLS (FTP, IMAP, POP3, SMTP)", - " --ssl-reqd Require SSL/TLS (FTP, IMAP, POP3, SMTP)", - " -2/--sslv2 Use SSLv2 (SSL)", - " -3/--sslv3 Use SSLv3 (SSL)", - " --stderr Where to redirect stderr. - means stdout", - " --tcp-nodelay Use the TCP_NODELAY option", - " -t/--telnet-option Set telnet option", - " --tftp-blksize Set TFTP BLKSIZE option (must be >512)", - " -z/--time-cond