sjero.net Git - wget/blob - vms/WGET.HLP

   1 1 WGET
   2  GNU Wget 1.11a, a non-interactive network retriever.
   3  Usage:
   4         WGET :== $ device:[directory]WGET.EXE  ! Define foreign command.
   5         WGET [OPTION [...]] [URL [...]]
   6
   7  Mandatory arguments for long options are also mandatory for short options.
   8
   9 2 Startup
  10   -V,  --version           display the version of Wget and exit.
  11   -h,  --help              print this help.
  12   -b,  --background        go to background after startup. (Ignored on VMS.)
  13   -e,  --execute=COMMAND   execute a `.wgetrc'-style command.
  14
  15 2 Logging_and_input_file
  16   -o,  --output-file=FILE    log messages to FILE.
  17   -a,  --append-output=FILE  append messages to FILE.
  18   -d,  --debug               print debugging information.
  19   -q,  --quiet               quiet (no output).
  20   -v,  --verbose             be verbose.  (This is the default.)
  21   -nv, --non-verbose         turn off verboseness, without being quiet.
  22   -i,  --input-file=FILE     download URLs found in FILE.
  23   -F,  --force-html          treat input file as HTML.
  24   -B,  --base=URL            prepends URL to relative links in -F -i file.
  25
  26 2 Download
  27   -t,  --tries=NUMBER            set number of retries to NUMBER
  28                                  (0 unlimits).
  29        --retry-connrefused       retry even if connection is refused.
  30   -O   --output-document=FILE    write documents to FILE.
  31   -nc, --no-clobber              skip downloads that would download to
  32                                  existing files.
  33   -c,  --continue                resume getting a partially downloaded file.
  34        --progress=TYPE           select progress gauge type.
  35   -N,  --timestamping            don't re-retrieve files unless newer than
  36                                  local.
  37   -S,  --server-response         print server response.
  38        --spider                  don't download anything.
  39   -T,  --timeout=SECONDS         set all timeout values to SECONDS.
  40        --dns-timeout=SECS        set the DNS lookup timeout to SECS.
  41        --connect-timeout=SECS    set the connect timeout to SECS.
  42        --read-timeout=SECS       set the read timeout to SECS.
  43   -w,  --wait=SECONDS            wait SECONDS between retrievals.
  44        --waitretry=SECS          wait 1...SECS between retrieval retries.
  45        --random-wait             wait from 0...2*WAIT secs between
  46                                  retrievals.
  47        --no-proxy                explicitly turn off proxy.
  48   -Q,  --quota=NUMBER            set retrieval quota to NUMBER.
  49        --bind-address=ADDRESS    bind to ADDRESS (hostname or IP) on local
  50                                  host.
  51        --limit-rate=RATE         limit download rate to RATE.
  52        --no-dns-cache            disable caching DNS lookups.
  53        --restrict-file-names=OS  restrict file name chars to ones OS allows.
  54        --ignore-case             ignore case when matching files/dirs.
  55   -4,  --inet4-only              connect only to IPv4 addresses.
  56   -6,  --inet6-only              connect only to IPv6 addresses.
  57        --prefer-family=FAMILY    connect first to addresses of specified
  58                                  family, one of IPv6, IPv4, or none.
  59        --user=USER               set both FTP and HTTP user to USER.
  60        --password=PASS           set both FTP and HTTP password to PASS.
  61
  62 2 Directories
  63   -nd  --no-directories           don't create directories.
  64   -x,  --force-directories        force creation of directories.
  65   -nH, --no-host-directories      don't create host directories.
  66        --protocol-directories     use protocol name in directories.
  67   -P,  --directory-prefix=PREFIX  save files to PREFIX/...
  68        --cut-dirs=NUMBER          ignore NUMBER remote directory components.
  69
  70 2 HTTP_options
  71        --http-user=USER        set HTTP user to USER.
  72        --http-passwd=PASS      set HTTP password to PASS.
  73        --no-cache              disallow server-cached data.
  74   -E,  --html-extension        save HTML documents with ".html" extension.
  75        --ignore-length         ignore "Content-Length" header field.
  76        --header=STRING         insert STRING among the headers.
  77        --proxy-user=USER       set USER as proxy username.
  78        --proxy-passwd=PASS     set PASS as proxy password.
  79        --referer=URL           include "Referer: URL" header in HTTP
  80                                request.
  81        --save-headers          save the HTTP headers to file.
  82   -U,  --user-agent=AGENT      identify as AGENT instead of Wget/VERSION.
  83        --no-http-keep-alive    disable HTTP keep-alive (persistent
  84                                connections).
  85        --no-cookies            don't use cookies.
  86        --load-cookies=FILE     load cookies from FILE before session.
  87        --save-cookies=FILE     save cookies to FILE after session.
  88        --keep-session-cookies  load and save session (non-permanent)
  89                                cookies.
  90        --post-data=STRING      use the POST method; send STRING as the data.
  91        --post-file=FILE        use the POST method; send contents of FILE.
  92        --content-disposition   honor the Content-Disposition header when
  93                                choosing local file names (EXPERIMENTAL).
  94
  95 2 HTTPS (SSL/TLS) options:
  96        --secure-protocol=PR     choose secure protocol, PR, one of: auto,
  97                                 SSLv2, SSLv3, and TLSv1.
  98        --no-check-certificate   don't validate the server's certificate.
  99        --certificate=FILE       client certificate file.
 100        --certificate-type=TYPE  client certificate type, PEM or DER.
 101        --private-key=FILE       private key file.
 102        --private-key-type=TYPE  private key type, PEM or DER.
 103        --ca-certificate=FILE    file with the bundle of CA's.
 104        --ca-directory=DIR       directory where hash list of CA's is stored.
 105        --random-file=FILE       FILE with random data to seed the SSL PRNG.
 106        --egd-file=FILE          FILE naming the EGD socket with random data.
 107
 108 2 FTP_options
 109        --ftp-stmlf             All binary FTP files use Stream_LF format.
 110        --ftp-user=USER         set FTP user to USER.
 111        --ftp-password=PASS     set FTP password to PASS.
 112        --no-remove-listing     don't remove ".listing" files.
 113        --no-glob               turn off FTP file name globbing.
 114        --no-passive-ftp        disable the "passive" transfer mode.
 115        --retr-symlinks         when recursing, get linked-to files (not
 116                                dir).
 117        --preserve-permissions  preserve remote file permissions.
 118
 119 2 Recursive_retrieval
 120   -r,  --recursive          recursive download.
 121   -l,  --level=NUMBER       maximum recursion depth (inf or 0 for infinite).
 122        --delete-after       delete files locally after downloading them.
 123   -k,  --convert-links      make links in downloaded HTML point to local
 124                             files.
 125   -K,  --backup-converted   before converting file X, back up as X_orig.
 126   -m,  --mirror             shortcut for -r -N -l inf --no-remove-listing.
 127   -p,  --page-requisites    get all images, etc. needed by HTML page.
 128        --strict-comments    turn on strict (SGML) handling of HTML comments.
 129
 130 2 Recursive_accept-reject
 131   -A,  --accept=LIST               comma-separated list of accepted
 132                                    extensions.
 133   -R,  --reject=LIST               comma-separated list of rejected
 134                                    extensions.
 135   -D,  --domains=LIST              comma-separated list of accepted domains.
 136        --exclude-domains=LIST      comma-separated list of rejected domains.
 137        --follow-ftp                follow FTP links from HTML documents.
 138        --follow-tags=LIST          comma-separated list of followed HTML
 139                                    tags.
 140   -G,  --ignore-tags=LIST          comma-separated list of ignored HTML
 141                                    tags.
 142   -H,  --span-hosts                go to foreign hosts when recursive.
 143   -L,  --relative                  follow relative links only.
 144   -I,  --include-directories=LIST  list of allowed directories.
 145   -X,  --exclude-directories=LIST  list of excluded directories.
 146   -np, --no-parent                 don't ascend to the parent directory.
 147
 148 2 VMS_specifics
 149  Wget on VMS systems may behave differently in some ways from Wget on other
 150  systems.
 151
 152  The "-b" or "--background" command-line option is ignored on VMS systems.
 153
 154  Other differences involve command-line case, restrictions on directory
 155  and file names, some FTP behavior, and some RMS default parameters.
 156
 157 3 Command-line_case
 158  On non-VAX systems, Wget for VMS enables the following DECC$* run-time
 159  option:
 160     DECC$ARGV_PARSE_STYLE
 161
 162  This way, with extended command parsing enabled ("SET PROCESS
 163  /PARSE_STYLE = EXTENDED"), command-line case is preserved, which
 164  obviates quoting case-sensitive option switches, URLs, and other
 165  parameters.
 166
 167 3 Directory_and_file_names
 168  When the destination for a downloaded file is an ODS2 file system,
 169  excessive dots (".") in file names and directory names generated by
 170  recursive retrieval (which would be illegal in ODS2 directory or file
 171  names) are replaced by underscores ("_").  All tildes ("~") are replaced
 172  by hyphens ("-"), and all "at" signs ("@") are replaced by dollar signs
 173  ("$").  Any other invalid characters are replaced by underscores ("_").
 174  Also, case information is lost.
 175
 176  For example, the command:
 177  wget -r "ftp://ftp.xfree86.org/pub/XFree86/3.3.5/binaries/NetBSD-1.3/"
 178
 179  on a UNIX system, should put files into the directory:
 180  ./ftp.xfree86.org/pub/XFree86/3.3.5/binaries/NetBSD-1.3/
 181
 182  while on a VMS ODS2 file system, the directory would be:
 183  [.FTP_XFREE86_ORG.PUB.XFREE86.3_3_5.BINARIES.NETBSD-1_3]
 184
 185  When the destination for a downloaded file is an ODS5 file system, the
 186  ODS5-invalid characters "?" and "*" are converted to "!" and "#",
 187  respectively.
 188
 189  On non-VAX systems, Wget for VMS enables the following DECC$* run-time
 190  options:
 191     DECC$EFS_CHARSET
 192     DECC$EFS_CASE_PRESERVE
 193
 194  This way, when the destination for a downloaded file is an ODS5 file
 195  system, multiple dots will be permitted and case will be preserved in
 196  directory and file names, so the previous example directory would be:
 197  [.ftp^.xfree86^.org.pub.XFree86.3^.3^.5.binaries.NetBSD-1^.3]
 198
 199 3 FTP_file_date
 200  Files downloaded using FTP from some servers may get date-time info in
 201  server-local time.  Define an environment variable (symbol or logical
 202  name) WGET_TIMEZONE_DIFFERENTIAL (a signed time in seconds) to offset
 203  these file dates.
 204
 205 3 FTP_file_format
 206  By default, when Wget does a binary (Image) FTP transfer, the
 207  destination file is created with fixed-length, 512-byte records.  When
 208  Wget does an ASCII FTP transfer, the destination file is created with
 209  Stream_LF format.
 210
 211  In Wget versions before 1.10.1, an FTP destination file was always
 212  created with Stream_LF format.
 213
 214  A new command-line option, --ftp-stmlf, forces all FTP destination
 215  files to Stream_LF format, as in Wget versions before 1.10.1.
 216
 217  Add ";type=a" to the end of an FTP URL to specify an ASCII transfer.
 218
 219  Destination files specified using "-O" ("--output-document") are always
 220  created with Stream_LF format.
 221
 222 3 FTP_file_versions
 223  To specify an explicit ";nnn" version number in an FTP URL, escape the
 224  ";" as "%3B", or, if the (VMS) FTP server will accept it, use a second
 225  dot.  For example, for "file.type;25" use a URL like:
 226     ftp://server/directory/file.type%3B25
 227  or:
 228     ftp://server/directory/file.type.25
 229
 230 3 RMS_default_parameters
 231  For improved I/O speed, when writing a downloaded file, Wget uses these
 232  RMS parameter values by default: BLOCK_COUNT = 127, BUFFER_COUNT = 2,
 233  EXTEND_QUANTITY = 16384.
 234
 235  The user may overide these values by specifying different (non-zero)
 236  values for these parameters using the SET RMS_DEFAULT command.
 237
 238 3 File_attributes
 239  As with many C programs which originated on non-VMS systems, Wget may
 240  make some assumptions about file attributes which can cause some
 241  problems.  One example is the "--post-file=FILE" option, which requires
 242  that the "FILE" be in Stream_LF format.  (In this case, HTTP 1.0
 243  requires the length of the request to be known, and the method used to
 244  determine the size of the file will fail for Variable-length format
 245  files.)