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. Этот же синтаксис используется для передачи значения параметров для опции -o/--set-options: --set-options core/client=rtorrent fetchers/rutor.org/timeout=5.

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

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

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	Специфические параметры для клиента. Набор опций различен для разных торрент-клиентов.
fetchers	Список трекеров с логинами и паролями, используется в emfetch, чтобы обновлять торренты.
confetti	Список плагинов для отправки оповещений о результатах работы emfetch (например, по почте).
emfetch	Специфические параметры emfetch.
emfind	Специфические параметры emfind.
emload	Специфические параметры emload.

Настройка клиента

TODO