config

Опции командной строки

Все программы (кроме emhook-manage-trackers) поддерживают общий набор базовых опций:

• -h, --help
  • Выводит краткую справку.
• -c, --config <path/to/file>
  • Устанавливает путь к конфигурационному файлу, по умолчанию - ~/.config/emonoda.yaml.
• -o, --set-options <sec/sub/opt=value ...>
  • Переопределяет параметры из конфига для единичного запуска команды. Вложенные ямловые ключи разделяются слешем, значение устанавливается после знака равенства. Можно передавать несколько параметров через пробел.
• -m, --dump-config
  • Выводит дамп конфигурации в виде YAML с комментариями.

---

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

Все параметры системы настраиваются в файле ~/.config/emonoda.yaml. Файл делится на секции, в которых описываются одиночные ключи, списки или пары вида ключ-значение. Для описания параметров в рамках одной секции используется отступ из четырех или двух пробелов. Комментарий отделяется символом #. Например:

core:  # Корневая секция
    client: rtorrent  # Параметр client в секции core со значением rtorrent

fetchers:  # Другая корневая секция
    rutor.org:  # Подсекция
        timeout: 5  # Параметр

Для обозначения подобных вложенных параметров в этой документации часто будет использоваться такая запись: core/client=rtorrent или fetchers/rutor.org/timeout=5.0. Этот же синтаксис используется для передачи значения параметров в опцию -o/--set-options: --set-options core/client=rtorrent fetchers/rutor.org/timeout=5. Через знак равенства указываются значения по умолчанию; null, [] или {} обозначают отключенную функцию.

---

Основные параметры

Команды emfile и emdiff могут работать с конфигурацией по умолчанию, однако для всех остальных утилит вам потребуется настроить интеграцию с клиентом, а также указать пути к каталогам с торрент-файлами и данными.
Конфигурация делится на несколько секций. Одна их часть является общими параметрами, другая же относится непосредственно к каждой отдельной программе. Ниже приведен минимальный пример файла ~/.config/emonoda.yaml, содержащий простые настройки для торрент-клиента и трех фетчеров (плагины для трекеров в местной терминологии). С такой конфигурацией вы сможете пользоваться всеми программами Emonoda. Фетчеры необходимы только для emupdate.

core:
    torrents_dir: /home/user/torrents  # Каталог с торрент-файлами
    data_root_dir: /home/user/Downloads  # Каталог, куда скачиваются данные
    client: rtorrent  # Имя плагина для клиента

fetchers:
    rutracker.org:
        user: yourlogin
        passwd: 12345

    nnm-club.me:
        user: yourlogin
        passwd: 12345

    tr.anidub.com:
        user: yourlogin
        passwd: 12345

Полный список всех секций и параметров (в том числе и для выбранных плагинов) вы всегда можете посмотреть с помощью команды emfile -m. Параметры секции core и client действуют на все программы.

• core/client=null
  • Плагин используемого клиента.
• core/torrents_dir=.
  • Путь к каталогу, где лежат торрент-файлы.
• core/use_colors=true
  • Параметр разрешает использование цветов при выводе на терминал.
• core/force_colors=false
  • При использовании core/use_colors программа будет раскрашивать свой вывод, если он направлен в терминал. При перенаправлении в файл раскрашивание отключается, однако при core/force_colors=true вывод будет раскрашиваться всегда.
• core/data_root_dir=~/Downloads
  • Корневой каталог с данными торрентов. В его подкаталоги emload загружает новые данные, а emfind индексирует его содержимое.
  • Корневой каталог, в который должны загружаться данные торрентов. Используется emload и emfind.
• core/another_data_root_dirs=[]
  • Дополнительный список каталогов, где находятся уже загруженные ранее торренты. Этот параметр полезен, если до установки Emonoda и использования emload данные качались по разным путям. Он добавляет указанные каталоги для поиска с помощью emfind.

Секция	Описание
core	Общие параметры системы - имя плагина торрент-клиента, пути к каталогам, настройки вывода на терминал.
client	Специфические параметры клиента. Содержимое секции зависит от используемого плагина, указанного в core/client. Подробнее смотрите на странице clients.
fetchers	Список трекеров с логинами и паролями, использующийся в emupdate, чтобы обновлять торренты. Подробнее смотрите на странице fetchers.
confetti	Список плагинов для отправки оповещений о результатах работы emupdate (например, по почте).
emupdate	Специфические параметры emupdate.
emfile	Специфические параметры emfile.
emfind	Специфические параметры emfind.
emload	Специфические параметры emload.