www.delorie.com/gnu/docs/wget/wget_27.html   search  
Buy GNU books!

GNU Wget Manual

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

6.3 Wgetrc Commands

The complete set of commands is listed below. Legal values are listed after the `='. Simple Boolean values can be set or unset using `on' and `off' or `1' and `0'. A fancier kind of Boolean allowed in some cases is the lockable Boolean, which may be set to `on', `off', `always', or `never'. If an option is set to `always' or `never', that value will be locked in for the duration of the Wget invocation--commandline options will not override.

Some commands take pseudo-arbitrary values. address values can be hostnames or dotted-quad IP addresses. n can be any positive integer, or `inf' for infinity, where appropriate. string values can be any non-empty string.

Most of these commands have commandline equivalents (see section 2. Invoking), though some of the more obscure or rarely used ones do not.

accept/reject = string
Same as `-A'/`-R' (see section 4.2 Types of Files).

add_hostdir = on/off
Enable/disable host-prefixed file names. `-nH' disables it.

continue = on/off
If set to on, force continuation of preexistent partially retrieved files. See `-c' before setting it.

background = on/off
Enable/disable going to background--the same as `-b' (which enables it).

backup_converted = on/off
Enable/disable saving pre-converted files with the suffix `.orig'---the same as `-K' (which enables it).

base = string
Consider relative URLs in URL input files forced to be interpreted as HTML as being relative to string---the same as `-B'.

bind_address = address
Bind to address, like the `--bind-address' option.

cache = on/off
When set to off, disallow server-caching. See the `-C' option.

convert links = on/off
Convert non-relative links locally. The same as `-k'.

cookies = on/off
When set to off, disallow cookies. See the `--cookies' option.

load_cookies = file
Load cookies from file. See `--load-cookies'.

save_cookies = file
Save cookies to file. See `--save-cookies'.

cut_dirs = n
Ignore n remote directory components.

debug = on/off
Debug mode, same as `-d'.

delete_after = on/off
Delete after download--the same as `--delete-after'.

dir_prefix = string
Top of directory tree--the same as `-P'.

dirstruct = on/off
Turning dirstruct on or off--the same as `-x' or `-nd', respectively.

domains = string
Same as `-D' (see section 4.1 Spanning Hosts).

dot_bytes = n
Specify the number of bytes "contained" in a dot, as seen throughout the retrieval (1024 by default). You can postfix the value with `k' or `m', representing kilobytes and megabytes, respectively. With dot settings you can tailor the dot retrieval to suit your needs, or you can use the predefined styles (see section 2.5 Download Options).

dots_in_line = n
Specify the number of dots that will be printed in each line throughout the retrieval (50 by default).

dot_spacing = n
Specify the number of dots in a single cluster (10 by default).

exclude_directories = string
Specify a comma-separated list of directories you wish to exclude from download--the same as `-X' (see section 4.3 Directory-Based Limits).

exclude_domains = string
Same as `--exclude-domains' (see section 4.1 Spanning Hosts).

follow_ftp = on/off
Follow FTP links from HTML documents--the same as `--follow-ftp'.

follow_tags = string
Only follow certain HTML tags when doing a recursive retrieval, just like `--follow-tags'.

force_html = on/off
If set to on, force the input filename to be regarded as an HTML document--the same as `-F'.

ftp_proxy = string
Use string as FTP proxy, instead of the one specified in environment.

glob = on/off
Turn globbing on/off--the same as `-g'.

header = string
Define an additional header, like `--header'.

html_extension = on/off
Add a `.html' extension to `text/html' files without it, like `-E'.

http_passwd = string
Set HTTP password.

http_proxy = string
Use string as HTTP proxy, instead of the one specified in environment.

http_user = string
Set HTTP user to string.

ignore_length = on/off
When set to on, ignore Content-Length header; the same as `--ignore-length'.

ignore_tags = string
Ignore certain HTML tags when doing a recursive retrieval, just like `-G' / `--ignore-tags'.

include_directories = string
Specify a comma-separated list of directories you wish to follow when downloading--the same as `-I'.

input = string
Read the URLs from string, like `-i'.

kill_longer = on/off
Consider data longer than specified in content-length header as invalid (and retry getting it). The default behaviour is to save as much data as there is, provided there is more than or equal to the value in Content-Length.

limit_rate = rate
Limit the download speed to no more than rate bytes per second. The same as `--limit-rate'.

logfile = string
Set logfile--the same as `-o'.

login = string
Your user name on the remote machine, for FTP. Defaults to `anonymous'.

mirror = on/off
Turn mirroring on/off. The same as `-m'.

netrc = on/off
Turn reading netrc on or off.

noclobber = on/off
Same as `-nc'.

no_parent = on/off
Disallow retrieving outside the directory hierarchy, like `--no-parent' (see section 4.3 Directory-Based Limits).

no_proxy = string
Use string as the comma-separated list of domains to avoid in proxy loading, instead of the one specified in environment.

output_document = string
Set the output filename--the same as `-O'.

page_requisites = on/off
Download all ancillary documents necessary for a single HTML page to display properly--the same as `-p'.

passive_ftp = on/off/always/never
Set passive FTP---the same as `--passive-ftp'. Some scripts and `.pm' (Perl module) files download files using `wget --passive-ftp'. If your firewall does not allow this, you can set `passive_ftp = never' to override the commandline.

passwd = string
Set your FTP password to password. Without this setting, the password defaults to `username@hostname.domainname'.

progress = string
Set the type of the progress indicator. Legal types are "dot" and "bar".

proxy_user = string
Set proxy authentication user name to string, like `--proxy-user'.

proxy_passwd = string
Set proxy authentication password to string, like `--proxy-passwd'.

referer = string
Set HTTP `Referer:' header just like `--referer'. (Note it was the folks who wrote the HTTP spec who got the spelling of "referrer" wrong.)

quiet = on/off
Quiet mode--the same as `-q'.

quota = quota
Specify the download quota, which is useful to put in the global `wgetrc'. When download quota is specified, Wget will stop retrieving after the download sum has become greater than quota. The quota can be specified in bytes (default), kbytes `k' appended) or mbytes (`m' appended). Thus `quota = 5m' will set the quota to 5 mbytes. Note that the user's startup file overrides system settings.

reclevel = n
Recursion level--the same as `-l'.

recursive = on/off
Recursive on/off--the same as `-r'.

relative_only = on/off
Follow only relative links--the same as `-L' (see section 4.4 Relative Links).

remove_listing = on/off
If set to on, remove FTP listings downloaded by Wget. Setting it to off is the same as `-nr'.

retr_symlinks = on/off
When set to on, retrieve symbolic links as if they were plain files; the same as `--retr-symlinks'.

robots = on/off
Specify whether the norobots convention is respected by Wget, "on" by default. This switch controls both the `/robots.txt' and the `nofollow' aspect of the spec. See section 9.1 Robot Exclusion, for more details about this. Be sure you know what you are doing before turning this off.

server_response = on/off
Choose whether or not to print the HTTP and FTP server responses--the same as `-S'.

span_hosts = on/off
Same as `-H'.

timeout = n
Set timeout value--the same as `-T'.

timestamping = on/off
Turn timestamping on/off. The same as `-N' (see section 5. Time-Stamping).

tries = n
Set number of retries per URL---the same as `-t'.

use_proxy = on/off
Turn proxy support on/off. The same as `-Y'.

verbose = on/off
Turn verbose on/off--the same as `-v'/`-nv'.

wait = n
Wait n seconds between retrievals--the same as `-w'.

waitretry = n
Wait up to n seconds between retries of failed retrievals only--the same as `--waitretry'. Note that this is turned on by default in the global `wgetrc'.

randomwait = on/off
Turn random between-request wait times on or off. The same as `--random-wait'.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

  webmaster   donations   bookstore     delorie software   privacy  
  Copyright 2003   by The Free Software Foundation     Updated Jun 2003