Skip to content
hugehelp.c 50.2 KiB
Newer Older
Daniel Stenberg's avatar
Daniel Stenberg committed
/* NEVER EVER edit this manually, fix the mkhelp script instead! */
#include <stdio.h>
void hugehelp(void)
{
puts (
"                                  _   _ ____  _     \n"
"  Project                     ___| | | |  _ \\| |    \n"
"                             / __| | | | |_) | |    \n"
"                            | (__| |_| |  _ <| |___ \n"
"                             \\___|\\___/|_| \\_\\_____|\n"
"NAME\n"
"     curl - get a URL with FTP, TELNET, LDAP, GOPHER, DICT, FILE,\n"
"     HTTP or HTTPS syntax.\n"
"\n"
"SYNOPSIS\n"
"     curl [options] url\n"
"\n"
"DESCRIPTION\n"
"     curl is a client to get documents/files from servers,  using\n"
"     any  of  the supported protocols. The command is designed to\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"     work without user interaction or any kind of  interactivity.\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"     curl  offers  a busload of useful tricks like proxy support,\n"
"     user authentication, ftp upload,  HTTP  post,  SSL  (https:)\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"     connections, cookies, file transfer resume and more.\n"
"\n"
"URL\n"
"     The URL syntax is protocol dependent. You'll find a detailed\n"
"     description in RFC 2396.\n"
"\n"
"     You can specify multiple URLs or parts of  URLs  by  writing\n"
"     part sets within braces as in:\n"
"\n"
"      http://site.{one,two,three}.com\n"
"\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"     or  you can get sequences of alphanumeric series by using []\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"     as in:\n"
"\n"
"      ftp://ftp.numericals.com/file[1-100].txt\n"
"      ftp://ftp.numericals.com/file[001-100].txt    (with leading\n"
"     zeros)\n"
"      ftp://ftp.letters.com/file[a-z].txt\n"
"\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"     It  is possible to specify up to 9 sets or series for a URL,\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"     but no nesting is supported at the moment:\n"
"\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"      http://www.any.org/archive[1996-1999]/vol­\n"
"     ume[1-4]part{a,b,c,index}.html\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"\n"
"OPTIONS\n"
"     -a/--append\n"
"          (FTP) When used in a ftp upload, this will tell curl to\n"
"          append to the target file instead of overwriting it. If\n"
"          the file doesn't exist, it will be created.\n"
"\n"
"     -A/--user-agent <agent string>\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          (HTTP)  Specify  the  User-Agent  string to send to the\n"
"          HTTP server. Some badly done CGIs fail if its  not  set\n"
"          to \"Mozilla/4.0\".  To encode blanks in the string, sur­\n"
"          round the string with single  quote  marks.   This  can\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          also be set with the -H/--header flag of course.\n"
"     -b/--cookie <name=data>\n"
"          (HTTP) Pass the data to the HTTP server as a cookie. It\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          is supposedly the data  previously  received  from  the\n"
"          server  in a \"Set-Cookie:\" line.  The data should be in\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          the format \"NAME1=VALUE1; NAME2=VALUE2\".\n"
"\n"
"          If no '=' letter is used in the line, it is treated  as\n"
"          a  filename  to  use  to  read previously stored cookie\n"
"          lines from, which should be used  in  this  session  if\n"
"          they  match.  Using  this  method  also  activates  the\n"
"          \"cookie parser\" which will make  curl  record  incoming\n"
"          cookies too, which may be handy if you're using this in\n"
"          combination with the  -L/--location  option.  The  file\n"
"          format of the file to read cookies from should be plain\n"
"          HTTP headers or the netscape cookie file format.\n"
"\n"
"     -B/--ftp-ascii\n"
"          (FTP/LDAP) Use ASCII transfer when getting an FTP  file\n"
"          or  LDAP  info.  For  FTP, this can also be enforced by\n"
"          using an URL that ends with \";type=A\".\n"
"\n"
"     -c/--continue\n"
"          Continue/Resume  a   previous   file   transfer.   This\n"
"          instructs  curl  to continue appending data on the file\n"
"          where it was previously left,  possibly  because  of  a\n"
"          broken  connection to the server. There must be a named\n"
"          physical file to append to for  this  to  work.   Note:\n"
"          Upload  resume  is depening on a command named SIZE not\n"
"          always present in all ftp servers! Upload resume is for\n"
"          FTP  only.   HTTP resume is only possible with HTTP/1.1\n"
"          or later servers.\n"
"\n"
"     -C/--continue-at <offset>\n"
"          Continue/Resume a previous file transfer at  the  given\n"
"          offset.  The  given offset is the exact number of bytes\n"
"          that will be skipped counted from the beginning of  the\n"
"          source file before it is transfered to the destination.\n"
"          If used with uploads, the ftp server command SIZE  will\n"
"          not  be  used  by  curl. Upload resume is for FTP only.\n"
"          HTTP resume is only possible  with  HTTP/1.1  or  later\n"
"          servers.\n"
"\n"
"     -d/--data <data>\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          (HTTP)  Sends  the  specified data in a POST request to\n"
"          the HTTP server. Note that the data is sent exactly  as\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          specified  with  no  extra  processing.   The  data  is\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          expected to be \"url-encoded\". This will cause  curl  to\n"
"          pass  the  data  to  the  server using the content-type\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          application/x-www-form-urlencoded. Compare to -F.\n"
"\n"
"          If you start the data  with  the  letter  @,  the  rest\n"
"          should  be  a  file name to read the data from, or - if\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          you want curl to read the data from  stdin.   The  con­\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          tents of the file must already be url-encoded.\n"
"\n"
"     -D/--dump-header <file>\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          (HTTP/FTP)  Write  the HTTP headers to this file. Write\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          the FTP file info to this file if -I/--head is used.\n"
"\n"
"     -e/--referer <URL>\n"
"          (HTTP) Sends the \"Referer Page\" information to the HTTP\n"
"          server. Some badly done CGIs fail if it's not set. This\n"
"          can also be set with the -H/--header flag of course.\n"
"\n"
"     -E/--cert <certificate[:password]>\n"
"          (HTTPS) Tells curl to  use  the  specified  certificate\n"
"          file  when  getting  a file with HTTPS. The certificate\n"
"          must be in PEM format.  If the optional password  isn't\n"
"          specified, it will be queried for on the terminal. Note\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          that this certificate is the private key and  the  pri­\n"
"          vate certificate concatenated!\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"\n"
"     -f/--fail\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          (HTTP)  Fail  silently  (no  output  at  all) on server\n"
"          errors. This is mostly done like this to better  enable\n"
"          scripts  etc  to  better  deal with failed attempts. In\n"
"          normal cases when a HTTP server fails to deliver a doc­\n"
"          ument,  it  returns  a  HTML document stating so (which\n"
"          often also describes why and more). This flag will pre­\n"
"          vent  curl  from  outputting  that  and  fail  silently\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          instead.\n"
"\n"
"     -F/--form <name=content>\n"
"          (HTTP) This lets curl emulate a filled in form in which\n"
"          a  user has pressed the submit button. This causes curl\n"
"          to POST data using the content-type multipart/form-data\n"
"          according  to RFC1867. This enables uploading of binary\n"
"          files etc. To force the 'content' part to be read  from\n"
"          a  file,  prefix the file name with an @ sign. Example,\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          to send your password file to the server, where  'pass­\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          word'   is   the   name  of  the  form-field  to  which\n"
"          /etc/passwd will be the input:\n"
"\n"
"          curl -F password=@/etc/passwd www.mypasswords.com\n"
"\n"
"          To read the file's content from stdin insted of a file,\n"
"          use - where the file name should've been.\n"
"\n"
"     -h/--help\n"
"          Usage help.\n"
"\n"
"     -H/--header <header>\n"
"          (HTTP) Extra header to use when getting a web page. You\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          may specify any number of extra headers. Note  that  if\n"
"          you  should  add a custom header that has the same name\n"
"          as one of the internal ones curl would use, your exter­\n"
"          nally  set  header will be used instead of the internal\n"
"          one. This allows you to make even trickier  stuff  than\n"
"          curl  would  normally do. You should not replace inter­\n"
"          nally set headers without knowing perfectly  well  what\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          you're doing.\n"
"\n"
"     -i/--include\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          (HTTP) Include the HTTP-header in the output. The HTTP-\n"
"          header includes things like server-name,  date  of  the\n"
"          document, HTTP-version and more...\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"\n"
"     -I/--head\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          (HTTP/FTP)  Fetch  the  HTTP-header  only! HTTP-servers\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          feature the command HEAD which this uses to get nothing\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          but  the header of a document. When used on a FTP file,\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          curl displays the file size only.\n"
"\n"
"     -K/--config <config file>\n"
"          Specify which config file to read curl arguments  from.\n"
"          The  config  file  is a text file in which command line\n"
"          arguments can be written which then will be used as  if\n"
"          they  were  written  on the actual command line. If the\n"
"          first column of a config line is a '#'  character,  the\n"
"          rest of the line will be treated as a comment.\n"
"\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          Specify  the filename as '-' to make curl read the file\n"
Daniel Stenberg's avatar
Daniel Stenberg committed
"          from stdin.\n"
"\n"
"     -l/--list-only\n"
"          (FTP) When listing an FTP directory, this switch forces\n"
"          a  name-only  view.   Especially  useful if you want to\n"
"          machine-parse the contents of an  FTP  directory  since\n"
"          the  normal  directory view doesn't use a standard look\n"
Loading
Loading full blame…