cpan

СОДЕРЖАНИЕ

• ИМЯ
• СИНТАКСИС
• ОПИСАНИЕ
  • Параметры
  • Примеры
  • Переменные окружения
• КОДЫ ВЫХОДА
• ЗАДАЧИ НА БУДУЩЕЕ
• ОШИБКИ
• СМОТРИ ТАКЖЕ
• ДОСТУПНОСТЬ ИСТОЧНИКА
• АВТОРСКИЕ ПРАВА
• АВТОР
• КОПИРАЙТ

ИМЯ

cpan - лёгкое взаимодействие с CPAN из командной строки

СИНТАКСИС

# with arguments and no switches, installs specified modules
cpan module_name [ module_name ... ]

# with switches, installs modules with extra behavior
cpan [-cfFimtTw] module_name [ module_name ... ]

# use local::lib
cpan -I module_name [ module_name ... ]

# one time mirror override for faster mirrors
cpan -p ...

# with just the dot, install from the distribution in the
# current directory
cpan .

# without arguments, starts CPAN.pm shell
cpan

# without arguments, but some switches
cpan [-ahpruvACDLOPX]

ОПИСАНИЕ

Этот скрипт предоставляет интерфейс командной строки (а не оболочки) к CPAN. В настоящий момент он использует CPAN.pm для выполнения задач, но это не одноразовый командный запуск для CPAN.pm.

Параметры

-a

Создаёт пакетный файл autobundle для CPAN.pm с помощью CPAN::Shell->autobundle.

-A модуль [ модуль ... ]

Отображает основных авторов указанных модулей.

-c модуль

Выполняет `make clean` в каталогах указанного модуля.

-C модуль [ модуль ... ]

Отображает файлы Изменений для указанных модулей

-D модуль [ модуль ... ]

Отображает детали модуля. Выводит одну строку для каждого устаревшего модуля (то есть модули, установленные локально, но имеющие более новые версии в CPAN). В каждой строке три столбца: имя модуля, локальная версия и версия CPAN.

-f

Принудительное выполнение указанного действия, когда оно обычно завершилось бы ошибкой. Используйте это для установки модуля, даже если его тесты завершились ошибкой. Когда вы используете этот параметр, -i необязателен для установки модуля, когда требуется принудительное выполнение:

% cpan -f -i Module::Foo

-F

Отключает попытки CPAN.pm заблокировать что-либо. Будьте осторожны, так как вы можете столкнуться с несколькими скриптами, пытающимися изменить один и тот же каталог. Это не так важно, если вы загружаете специальную конфигурацию с -j, и эта конфигурация настраивает свои рабочие каталоги.

-g модуль [ модуль ... ]

Загружает последнюю версию дистрибутива модуля в текущий каталог.

-G модуль [ модуль ... ]

НЕ РЕАЛИЗОВАНО

Загружает в текущий каталог последнюю версию модулей, распаковывает каждый дистрибутив и создаёт репозиторий git для каждого дистрибутива.

Если вам нужна эта функция, ознакомьтесь с дистрибутивом Git::CPAN::Patch от Yanick Champoux.

-h

Выводит сообщение справки и завершает работу. Если вы укажете -h, он проигнорирует все остальные параметры и аргументы.

-i модуль [ модуль ... ]

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

-I

Загружает local::lib (похоже на -I для загрузки путей lib). Жаль, что -l уже занято.

-j Config.pm

Загружает файл с данными конфигурации CPAN. Он должен иметь тот же формат, что и стандартный файл CPAN/Config.pm, который определяет $CPAN::Config как анонимный хэш.

-J

Выводит конфигурацию в том же формате, что и CPAN.pm. Это полезно для проверки конфигурации, а также для использования вывода в качестве отправной точки для новой пользовательской конфигурации.

-l

Выводит список всех установленных модулей с их версиями

-L автор [ автор ... ]

Выводит список модулей по указанным авторам.

-m

Создаёт указанные модули.

-M зеркало1,зеркало2,...

Список зеркал, разделяемых запятыми, которые следует использовать только для этого запуска. Параметр -P может автоматически их найти.

-n

Проверка, но фактически ничего не устанавливается. (не реализовано)

-O

Отобразить устаревшие модули.

-p

Отправка запросов к настроенным зеркала и вывод отчёта

-P

Найти лучшие зеркала и использовать их для текущего сеанса.

-r

Пересобирает динамически загруженные модули с помощью CPAN::Shell->recompile.

-s

Запустить оболочку CPAN.pm. Эта команда выполняется автоматически, если вы не указали никаких аргументов.

-t модуль [ модуль ... ]

Выполняет `make test` для указанных модулей.

-T

Не тестировать модули. Просто установить их.

-u

Обновить все установленные модули. Слепое выполнение этого может привести к серьёзным проблемам, поэтому сохраните резервную копию.

-v

Выводит версию скрипта и версию CPAN.pm, а затем завершает работу.

-V

Выводит подробную информацию о клиенте cpan.

-w

НЕ РЕАЛИЗОВАНО

Включить предупреждения cpan. Это проверяет различные вещи, такие как права доступа к каталогам, и информирует вас о возможных проблемах.

-x модуль [ модуль ... ]

Находит похожие совпадения с указанными модулями, которые, возможно, вы неправильно ввели. Это требует необязательной установки Text::Levenshtein или Text::Levenshtein::Damerau.

-X

Выводит все пространства имён в стандартный вывод.

Примеры

# print a help message
cpan -h

# print the version numbers
cpan -v

# create an autobundle
cpan -a

# recompile modules
cpan -r

# upgrade all installed modules
cpan -u

# install modules ( sole -i is optional )
cpan -i Netscape::Booksmarks Business::ISBN

# force install modules ( must use -i )
cpan -fi CGI::Minimal URI

# install modules but without testing them
cpan -Ti CGI::Minimal URI

Переменные окружения

Несколько компонентов в CPAN.pm используют переменные окружения. Инструменты сборки, ExtUtils::MakeMaker и Module::Build используют некоторые из них, а другие важны для более высоких уровней. Некоторые из них задаются Perl Toolchain Gang:

Lancaster Consensus: https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/lancaster-consensus.md

Oslo Consensus: https://github.com/Perl-Toolchain-Gang/toolchain-site/blob/master/oslo-consensus.md

NONINTERACTIVE_TESTING

Предполагает, что никто не обращает внимания и пропускает запросы для дистрибутивов, которые обрабатывают их корректно. cpan(1) устанавливает это в 1, если оно не имеет значения (даже если это значение ложь).

PERL_MM_USE_DEFAULT

Использовать стандартный ответ на вопрос. cpan(1) устанавливает это в 1, если оно не имеет значения (даже если это значение ложь).

CPAN_OPTS

Как и PERL5OPT, строка дополнительных cpan(1) параметров, которые нужно добавить к тем, которые вы указали в командной строке.

CPANSCRIPT_LOGLEVEL

Уровень ведения журнала, который следует использовать, либо с встроенным минимальным логгером, либо с Log::Log4perl, если он установлен. Возможные значения аналогичны уровням Log::Log4perl: TRACE, DEBUG, INFO, WARN, ERROR, и FATAL. По умолчанию INFO.

GIT_COMMAND

Путь к бинарному файлу git Git, который следует использовать для функций Git. По умолчанию /usr/local/bin/git.

КОДЫ ВЫХОДА

Скрипт завершается с нулевым кодом, если считает, что всё прошло успешно, или с положительным числом, если считает, что что-то пошло не так. Однако в некоторых случаях ему приходится определять ошибку по выводу вещей, которыми он не управляет. Пока коды выхода неясны:

1       An unknown error

2       The was an external problem

4       There was an internal problem with the script

8       A module failed to install

ЗАДАЧИ НА БУДУЩЕЕ

* значения конфигурации по одному для командной строки

ОШИБКИ

* не обнаружено

СМОТРИ ТАКЖЕ

Большинство особенностей, включая переменные окружения и конфигурацию, напрямую взяты из CPAN.pm.

ДОСТУПНОСТЬ ИСТОЧНИКА

Этот код находится в GitHub в репозитории CPAN.pm:

https://github.com/andk/cpanpm

Изначально источник хранился отдельно в другом репозитории GitHub, но теперь канонический источник находится в указанном выше репозитории.

АВТОРСКИЕ ПРАВА

Japheth Cleaver добавил возможности принудительной установки (-f).

Jim Brandt предложил и реализовал начальную реализацию функций актуальности и изменений.

Adam Kennedy указал, что exit() вызывает проблемы в Windows, где этот скрипт получает расширение .bat

АВТОР

brian d foy, <bdfoy@cpan.org>

КОПИРАЙТ

Copyright (c) 2001-2015, brian d foy, Все права защищены.

Вы можете распространять этот код на тех же условиях, что и сам Perl.