diff --git a/docs/baf.1.rst b/docs/baf.1.rst index 1017756..d038f1f 100644 --- a/docs/baf.1.rst +++ b/docs/baf.1.rst @@ -68,7 +68,7 @@ Baf не реализует собственный язык сценариев, Источники (`sources`) и назначения (`targets`) должны быть указаны в виде URI. Это позовляет наглядно в одной сроке видеть весь набор данных. Парсер реализует поддержку следующего синтаксиса URI:: - scheme:[//[username[:password]@][hostname[:port]]/[path]?[query]#[fragment] + scheme:[//[username[:password]@]hostname[:port]]/[path]?[query]#[fragment] Парсер URI соответствует RFC 3986 не полностью - разбиение на составные части URI происходит верно, но интерпретация отдельных ситуаций может отличаться. См. примеры URI и реузультаты их интерпретации парсером в файле `tests/parse_uri.bats`. На практике рекомендую придерживаться примеров, которые приведены ниже и в файле `tests/parse_uri.bats`. В случае, если изменение логики парсера необходимо, вы можете прислать правки в pull-реквесте или завести feature-реквест в репозитории проекта. @@ -199,10 +199,26 @@ Storj DCS ````````` WebDAV `````` -Переменные в сценариях ----------------------- -Библиотека функций ------------------- +Переменные +---------- +Baf условно разделяет переменные на "внутренние" ("защищённые") и "общие". К "защищённым" переменным относятся все перемеменные, имена которых начинаются с двух знаков подчёркивания, например: ``__main_target``. Все остальные переменные считаются "общими". + +Общие переменные могут быть перезаписаны в пользовательском скрипте. Защищённые переменные технически ничем от них не отличаются, однако не нужно переопределять такие переменные в пользовательском скрипте, так как это может привести к неожиданным ошибкам во время выполнения скрипта. Точно также очень внимательно нужно относится к перезаписи общих переменных — в обоих случаях есть риск что-то поломать. + +``__log_file`` + Путь до файла лога. + +``__main_target`` + Главный `target` для хранения локальных резервных копий. Эта переменная содержит первый по порядку URI со схемой `file` из массива `targets`. Директория (`path`) из этой точки используется в качестве буфферной, если в `targets` указаны дополнительные точки. + +``__source_handler`` + Содержит имя функции, которая будет обрабатывать URI из `sources`. + +``__target_handler`` + Аналогично ``__source_target``, но для `targets`. + +Функции +------- Использование функций в сценариях --------------------------------- See also