Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 5.81 KB

README.md

File metadata and controls

96 lines (64 loc) · 5.81 KB
Raw

Описание утилиты

gnu-koryavov - утилита командной строки Linux и MacOS, с помощью которой можно получать номер страницы для заданной задачи в Корявнике разных семестров, а также автоматически скачивать нужную версию книги и открывать её на нужной странице.

Использование

После установки gnu-koryavov может быть запущен командой вида

gnu-koryavov [ОПЦИИ]

Опции

  • -s <номер-семестра>
    Эта опция отвечает за номер сместра. От неё будет зависет, в каком Корявнике будет идти поиск задачи
  • -n <номер-задачи>
    Выбор задачи. Укажите номер задачи, которую хотите найти
  • -o
    Открыть электронный Корявник. Задайте эту опцию, если хотите, чтобы в случае нахождения задачи в Корявнике скрипт загрузил открыл его электронную версию на нужной странице (соответственно электронный Корявник не будет открыт, если Вы не используете эту опцию)
  • -h Вывести на экран справочную информацию и выйти.

Обязательные опции

Некоторые опции являются обязательными, т.к. в случае их отсутствия скрипт не сможет однозначно интерпретировать входные данные (запуск вообще без опций в принципе не имеет смысла с практической точки зрения). Краткий список обязательных опций:

  • -s
  • -n

Пример использования

gnu-koryavov -s 1 -n 1.11 -o
Выбранный семестр: 1
Выбранная задача: 1.11
Электронный корявник будет открыт
Задача 1.11 найдена на странице №25!
#вывод вспомогательной информации о скачивании и открытии электронного корявника

Установка

git clone https://github.com/sin-diesel/gnu-koryavov
cd gnu-koryavov/scripts
./install.sh

Конфигурация

Для работы gnu-koryavov требуется указать путь к скрипту, который будет открывать Корявник на нужной странице с помощью нужной программы.

Использование готовых скриптов

Текущая версия gnu-koryavov уже содержит набор скриптов для открытия Корявника в следующих программах:

Для использования одного из них нужно лишь установить путь к нему в соответствии значению djvuviewer_script в файле config.conf.
Это значение по умолчанию указывает на ~/gnu-koryavov/okular.sh, поэтому, если Вы хотите использовать Okular, согласитесь с тем, что Вы собираетесь использовать один из стандартных скриптов, при установке.

Пример

Например, если Вы хотите использовать Atril, и скрипт atril.sh расположен в /home/user/gnu-koryavov/atril.sh, измените нужный параметр config.conf следующим образом

djvuviewer_script=/home/user/gnu-koryavov/atril.sh

Использование другого средства просмотра

Вы можете создать скрипт, который будет открывать Корявник с помощью любой другой программы и настроить gnu-koryavov на его использование.
Скрипт будет вызываться так:

./your-script <номер-семестра> <номер-страницы>

Скрипт должен открывать на указанной странице файл <номер-семестра>.djvu, расположенный в ~/gnu-koryavov/KORYAVNIKS.

Чтобы gnu-koryavov запускал Ваш скрипт вместо okular.sh, в файле ~/gnu-koryavov/config.conf измените значение параметра djvuviewer_script на путь к вашему скрипту, как это сделано по умолчанию. Не забудьте поделиться этим скриптом со всеми пользователями gnu-koryavov, создав соответсвующий пулл-реквест!

Авторство и благодарности

Исполнение by Сидельников Стас Отдельная благодарность отдается Талашкевичу Данику за идею и помощь в создании данной тулзы.