Wgetrc Commands

The complete set of commands is listed below, the letter after `=' denoting the value the command takes. It is `on/off' for `on' or `off' (which can also be `1' or `0'), string for any non-empty string or n for a positive integer. For example, you may specify `use_proxy = off' to disable use of proxy servers by default. You may use `inf' for infinite values, where appropriate.

Most of the commands have their equivalent command-line option (See section Invoking), except some more obscure or rarely used ones.

accept/reject = string

Same as `-A'/`-R' (See section Types of Files).

add_hostdir = on/off

Enable/disable host-prefixed file names. `-nH' disables it.

continue = on/off

Enable/disable continuation of the retrieval, the same as `-c' (which enables it).

background = on/off

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

base = string

Set base for relative URLs, the same as `-B'.

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'.

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 Domain Acceptance).

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 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).

dot_style = string

Specify the dot retrieval style, as with `--dot-style'.

exclude_directories = string

Specify a comma-separated list of directories you wish to exclude from download, the same as `-X' (See section Directory-Based Limits).

exclude_domains = string

Same as `--exclude-domains' (See section Domain Acceptance).

follow_ftp = on/off

Follow FTP links from HTML documents, the same as `-f'.

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'.

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'.

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.

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 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'.

passive_ftp = on/off

Set passive FTP, the same as `--passive-ftp'.

passwd = string

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

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'.

quiet = on/off

Quiet mode, the same as `-q'.

quota = quota

Specify the download quota, which is useful to put in 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 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

Use (or not) `/robots.txt' file (See section Robots). Be sure to know what you are doing before changing the default (which is `on').

server_response = on/off

Choose whether or not to print the HTTP and FTP server responses, the same as `-S'.

simple_host_check = on/off

Same as `-nh' (See section Host Checking).

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 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'.

Go to the first, previous, next, last section, table of contents.