Конфигурационный файл

Поскольку вы уже знаете как изменить умалчиваемое поведение Wget через аргументы командной строки, вы, возможно, захотите сделать некоторые из таких изменений постоянными. Обычный способ для выполнения этого - создание конфигурационного файла ".wgetrc".

Кроме того что ".wgetrc" является "главным" инициализационным файлом для Wget, он предоставляет удобную возможность для сохранения в нем паролей. Поэтому Wget считывает и обрабатывает содержимое файла "$HOME/.netrc", только если находит его. Информацию о формате ".netrc" вы сможете найти в системном руководстве.

Wget считывает ".wgetrc" в момент запуска, распознавая определенный набор команд.

• Расположение wgetrc - места расположения различных wgetrc файлов.
• Синтаксис wgetrc - описание синтаксиса файлов wgetrc.
• Команды wgetrc - перечень доступных команд.
• Пример wgetrc - реальный пример файла wgetrc.

---

Расположение wgetrc

В момент запуска Wget сначала ищет "глобальный" инициализационный файл, обычно расположенный как "/usr/local/etc/wgetrc" (или с префиксом отличающимся от "/usr/local", если Wget не был установлен там), и считывает из него команды, если такие существуют.

После этого Wget ищет пользовательский инициализационный файл. Если установлена переменная среды окружения "WGETRC", то Wget попытается загрузить указываемый ей файл. Если это не удается, то больше никаких попыток не выполняется.

Если "WGETR" не установлена, то Wget пытается найти файл как "$HOME/.wgetrc".

Факт загрузки пользовательских установок после глобальных означает, что в случае столкновения значений установки пользовательского wgetrc перекрывают глобальные для системы (по умолчанию "/usr/local/etc/wgetrc"). Берегитесь злобные админы!

---

Синтаксис wgetrc

Синтаксис wgetrc прост:

имя_переменной = значение

"Имя переменной" может также называться командой. Действительные значения для разных переменных различны.

Команды нечувствительны к регистру символов и к знакам подчеркивания. Поэтому "DIr__PrefiX" и "dirprefix" - одна и таже команда. Пустые строки, строки начинающиеся с символа "#" и строки содержащие только пробельные символы игнорируются.

Команды, которые ожидают в качестве значения разделенный запятыми список, будут очищать этот список при передаче им пустого значения. Таким образом, если вы желаете сбросить список игнорирования определенный в глобальном "wgetrc" файле, вы это можете проделать следующим образом:

reject =

---

Команды wgetrc

Полный список команд приведен ниже. Запись после символа "=" определяет значение принимаемое командой. Это либо "on" или "off" для включения или выключения параметра (так же возможно использование "1" и "0"), соответственно, либо "STRING" означающая любую непустую последовательность символов, либо "N" определяющее положительное целое. Например, вы можете использовать "use_proxy = off" для отключения использования прокси серверов по умолчанию. Там, где это возможно, может применяться значение "inf" означающее бесконечность.

Большинство из команд имеет эквивалентные им опции командной строки (см. "Запуск") за исключением нескольких редко используемых параметров.

accept/reject = STRING

То же, что и "-A/-R" (см. "Типы файлов").

add_hostdir = on/off

Включить/выключить префикс имени хоста в именах файлов. "-nH" отключает это.

continue = on/off

Включить/выключить продолжение выгрузки. Соответствует "-c", которая включает это.

background = on/off

Включить/выключить выполнение в фоновом режиме. Тоже, что и "-b", которая включает это.

base = STRING

Установить базу для относительных URL, тоже, что и "-B".

cache = on/off

При установке в "off" запрещает кэширование на уровне сервера. (См. "-C").

convert links = on/off

Конвертировать локально абсолютные ссылки. Тоже, что и "-k". (См. "--cut-dirs").

cut_dirs = N

Игнорировать N компонентов удаленного каталога.

debug = on/off

Режим отладки. (См. "-d").

delete_after = on/off

Удалять после выгрузки. (См. "--delete-after").

dir_prefix = STRING

Вершина дерева каталогов. (См. "-P").

dirstruct = on/off

Создание структуры каталогов. Тоже, что и "-x" и "-nd" соответственно.

domains = STRING

Тоже, что и "-D" (См. "Доменная избирательность").

dot_bytes = N

Определяет количество байт "содержащихся" в точках, которые отображаются при выгрузке (по умолчанию 1024). Вы можете заканчивать значение суффиксами "k" или "m" для килобайтов и мегабайтов, соответственно. При помощи настройки точек вы можете подстраивать отображение по вашим нуждам или можете воспользоваться предопределенными стилями (см. опцию "--dot-style").

dots_in_line = N

Определяет количество точек выводимых в одной строке во время выгрузки (по умолчанию 50).

dot_spacing = N

Определяет количество точек в одном кластере (по умолчанию 10).

dot_style = STRING

Определяет стиль представления выгрузки аналогично опции "--dot-style".

exclude_directories = STRING

Определяет разделенный запятыми список каталогов, которые необходимо исключить из процесса выгрузки, аналогично "-X" (см. "Ограничения на уровне каталогов").)

exclude_domains = STRING

Тоже, что и "--exclude-domains" (см "Доменная избирательность").

follow_ftp = on/off

Следование FTP ссылкам из HTML документов, аналогично "-f".

force_html = on/off

Если установлена в "on" принуждает рассматривать входной файл как документ формата HTML, аналогична "-F".

ftp_proxy = STRING

Использовать "STRING" как FTP прокси сервер вместо значения определенного в окружении.

glob = on/off

Управление режимом глобирования, аналогично "-g".

header = STRING

Определить дополнительный HTTP заголовок, подобно "--header".

http_passwd = STRING

Установить HTTP пароль.

http_proxy = STRING

Использовать "STRING" как HTTP прокси вместо того, что определен в окружении.

http_user = STRING

Устанавливает имя HTTP пользователя.

ignore_length = on/off

Когда установлено в "on" приводит к игнорированию заголовка "Content-Length", аналогично "--ignore-length".

include_directories = STRING

Задает разделенный запятыми список каталогов, которые необходимо обработать во время выгрузки, аналогично "-I".

input = STRING

Определяет имя файла для получения списка обрабатываемых URL, аналогично "-i".

kill_longer = on/off

Расценивать данные, превышающие по длине значение определенное в заголовке "Content-Length", как некорректные (и повторить попытку их получения). Основное назначение - сохранить так много данных, на сколько это вообще возможно исходя из того, что размер удаленных данных равен или больше значения "Content-Length".

logfile = STRING

Определяет имя файла отчета, аналогично "-o".

login = STRING

Имя пользователя для доступа по FTP на дистанционную машину. Умалчиваемое значение "anonymous".

mirror = on/off

Управление режимом зеркалирования, аналогично "-m".

netrc = on/off

Включить (on) или выключить (off) обработку файла "netrc".

noclobber = on/off

Тоже, что и "-nc".

no_parent = on/off

Запретить выгрузку за пределами указанной иерархии каталогов, аналогично "--no-parent" (см. "Ограничения на уровне каталогов").

no_proxy = STRING

Определяет "STRING" как разделенный запятыми список доменов для которых не нужно использовать выгрузку через прокси вместо того, что определен в окружении.

output_document = STRING

Определяет имя выходного файла, аналогично "-O".

passive_ftp = on/off

Устанавливает пассивный режим FTP, аналогично "--passive-ftp".

passwd = STRING

Задает пароль для доступа к FTP сервису. Без этой установки по умолчанию используется ваш адрес электронной почты.

proxy_user = STRING

Устанавливает имя пользователя для авторизации на прокси сервере, подобно "--proxy-user".

proxy_passwd = STRING

Устанавливает пароль для авторизации на прокси сервере, подобно "--proxy-passwd".

quiet = on/off

Молчаливый режим, аналогично "-q".

quota = QUOTA

Определяет квоту на выгрузку. Полезна для использования в глобальном wgetrc. Когда квота определена, Wget остановит выгрузку в момент когда суммарный размер выгруженных данных станет равным либо больше ее. Квота может быть определена в байтах (по умолчанию), килобайтах (с добавлением "k") и мегабайтах (с добавлением "m"). Напрмер, "quota = 5m" устанавливает квоту в 5 мегабайт. Заметим, что глобальные установки могут быть перекрыты пользовательскими.

reclevel = N

Глубина рекурсии, аналогично "-l".

recursive = on/off

Разрешение рекурсии, аналогично "-r".

relative_only = on/off

Следование только относительным ссылкам, аналогично "-L" (см. "Относительные ссылки").

remove_listing = on/off

Когда установлена в "on", Wget будет удалять файлы полученных FTP листингов. Установка значения в "off" идентична "-nr".

retr_symlinks = on/off

Когда установлена в "on", Wget будет выгружать символьные ссылки как обычные файлы, аналогично "--retr-symlinks".

robots = on/off

Использовать (или нет) файл "/robots.txt" (см. "Роботы"). Убедитесь. что вы знаете, что делаете перед тем как изменять умалчиваемое значение (по умолчанию "on").

server_response = on/off

Печатать или нет HTTP и FTP ответы серверов, аналогично "-S".

simple_host_check = on/off

Тоже, что и "-nh" (см. "Проверка хостов").

span_hosts = on/off

Тоже, что и "-H".

timeout = N

Устанавливает время тайм-аута. Аналогично "-T".

timestamping = on/off

Управление временными штампами. Тоже, что и "-N" (см. "Контроль времени модификации").

tries = N

Установить количество попыток на URL. Тоже, что и "-t".

use_proxy = on/off

Использование прокси серверов. Тоже, что и "-Y".

verbose = on/off

Включить/выключить подробный отчет. Тоже, что и "-v"/"-nv".

wait = N

Ждать N секунд между запросами. Тоже, что и "-w".

---

Пример wgetrc

Этот пример инициализационного файла идентичен вложенному в дистрибутив. Он разделен на две секции: первая для глобального использования (применима в глобальном инициализационном файле), вторая для для локального использования (применима для "$HOME/.wgetrc"). Будте аккуратны с вносимыми модификациями.

Заметим, что все строки закомментированы. Для того чтобы любая строка возымела действие необходимо удалить префикс "#" в начале строки.

###
### Пример конфигурационного файла wgetrc
###

## Вы можете использовать этот файл, чтобы изменить умалчиваемое поведение
## wget или для того, чтобы избежать перечисления большого количества
## аргументов в командной строке при вызове программы. Этот файл не содержит
## полный список конфигурационных элементов. Обратитесь к руководству
## чтобы узнать какие аргументы вы можете использовать здесь, а так же за
## более подробным их описанием.

## Для того чтобы wget.exe под Windows смог использовать значения определенные
## в этом файле, у вас есть две возможности:
##
##  o Установить переменную среды окружения WGETRC, которая содержит в себе
##    полный путь доступа к данному файлу. В этом случае файл может иметь
##    любое имя.
##  o Установить переменную среды окружения HOME указывающую на какой-либо
##    каталог, в котором разместить данный файл под именем 'wgetrc'.
##
## Хотя данный файл разделен на два раздела: локальные и глобальные установки,
## это деление имеет функциональный смысл только на многопользовательских
## UNIX подобных системах. Для ОС Windows разделы чисто условны.

## Для использования любого из аргументов данного файла вам необходимо
## рас-комментировать его и при необходимости изменить значение.

## Глобальные установки. Полезны для определения параметров единых для
## всех пользователей системы в глобальном конфигурационном файле wget.
##
## Хорошо подумайте перед тем, как изменять их
## так как это может привести к ухудшению функциональности wget или
## даже привести к функционированию не соответствующему описанному
## в документации.

# Вы можете установить ограничение по объему принимаемых данных,
# например, для начинающих, указанием здесь значения максимального
# объема трафика, опционально завершаемого 'K' (килобайты) или
# 'M' (мегабайты). По умолчанию ограничение отсутствует.
#
#quota = inf

# Вы можете увеличить или уменьшить умалчиваемое количество попыток
# повтора операций выгрузки файла (по умолчанию 20).
#
#tries = 20

# Уменьшение максимальной глубины рекурсивной выборки помогает
# обезопасить начинающих пользователей от черезмерного углубления
# при выкачки, когда они необдуманно запускают рекурсивный процесс
# скачивания (по умолчанию 5).
#
#reclevel = 5

# Многие системы находятся за фильтрующим брандмауэром, который не
# позволяет инициировать соединения извне. В этом случае необходимо
# использование пассивного режима FTP. Если вы находитесь за подобным
# брандмауэром, вы можете включить (on) эту опцию, чтобы wget использовал
# пассивный режим FTP по умолчанию.
#
#passive_ftp = off

## Локальные установки для пользователя, определяемые в его локальном
## пользовательском конфигурационном файле wget. Крайне не желательно
## размещать данные аргументы в глобальном конфигурационном файле так
## как они потенциально опасны для обычных пользователей.
##
## Даже если вы устанавливаете локальный конфигурационный файл, вы должны
## точно знать, что вы делаете и отдавать себе отчет в этих действиях.

# Включите (on) этот параметр чтобы использовать контроль времени создания
# файла.
#
#timestamping = off

# Обычно это хорошая идея сделать так, чтобы wget сообщал ваш почтовый
# адрес в поле заголовка "From:" ваших запросов. Это позволит системному
# администратору удаленного сайта связаться с вами в случае возникновения
# ошибок. Wget по умолчанию не посылает эту информацию.
#
#header = From: Ваше_имя <имя_ящика@имя.домена>

# Вы можете так же определять и другие заголовки запросов, как этот
# определяющий желательный язык представления запрашиваемых документов.
# По умолчанию этот параметр не посылается, но будет полезным указать
# умалчиваемым языком русский.
#
#header = Accept-Language: ru

# Вы можете указать HTTP прокси сервер для использования его wget по умолчанию.
# Этот параметр перекрывает значение задаваемое переменной среды окружения.
#
#http_proxy = http://имя.хоста.прокси:прокси_порт/

# Если вы вообще не хотите использовать прокси, установите этот параметр в
# значение off.
#
#use_proxy = on

# Вы можете задавать внешний вид индикации процесса выгрузки файлов,
# Применимыми значениями являются:  default, binary, mega и micro.
# 
#dot_style = default

# Отключение этого аргумента (off) заставляет wget не выкачивать файлы
# /robots.txt. Перед тем как изменять умалчиваемое значение убедитесь,
# что вы точно знаете что это такое и для чего нужны эти файлы.
#
#robots = on

# Иногда необходимо чтобы wget делал паузу перед установкой соединения.
# Установите это значение в требуемое количество секунда задержки.
#
#wait = 0

# Вы можете принудительно заставить wget создавать иерархию каталогов
# доступа к файлу даже при выгрузке одного файла, установкой данного
# параметра в on.
#
#dirstruct = off

# Этим параметром можно задать wget использовать рекурсивную выгрузку
# по умолчанию, установив его в значение 'on'. Не делайте этого если вы
# не полностью уверены что это значит.
#
#recursive = off

# Для того чтобы wget переходил по FTP ссылкам в HTML документе по умолчанию
# установите данный аргумент в 'on'.
#
#follow_ftp = off